SearchExpression (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.sagemaker.model

Class SearchExpression

java.lang.Object
- com.amazonaws.services.sagemaker.model.SearchExpression

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SearchExpression
extends Object
implements Serializable, Cloneable, StructuredPojo 
```
A multi-expression that searches for the specified resource or resources in a search. All resource objects that satisfy the expression's condition are included in the search results. You must specify at least one subexpression, filter, or nested filter. A SearchExpression can contain up to twenty elements.

A SearchExpression contains the following components:
- A list of Filter objects. Each filter defines a simple Boolean expression comprised of a resource property name, Boolean operator, and value.
- A list of NestedFilter objects. Each nested filter defines a list of Boolean expressions using a list of resource properties. A nested filter is satisfied if a single object in the list satisfies all Boolean expressions.
- A list of SearchExpression objects. A search expression object can be nested in a list of search expression objects.
- A Boolean operator: And or Or.
See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SearchExpression ()

Constructors
Constructor and Description
`SearchExpression ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`SearchExpression`	`clone ()`
`boolean`	`equals (Object obj)`
`List<Filter>`	`getFilters ()` A list of filter objects.
`List<NestedFilters>`	`getNestedFilters ()` A list of nested filter objects.
`String`	`getOperator ()` A Boolean operator used to evaluate the search expression.
`List<SearchExpression>`	`getSubExpressions ()` A list of search expression objects.
`int`	`hashCode ()`
`void`	`marshall (ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setFilters (Collection<Filter> filters)` A list of filter objects.
`void`	`setNestedFilters (Collection<NestedFilters> nestedFilters)` A list of nested filter objects.
`void`	`setOperator (String operator)` A Boolean operator used to evaluate the search expression.
`void`	`setSubExpressions (Collection<SearchExpression> subExpressions)` A list of search expression objects.
`String`	`toString ()` Returns a string representation of this object.
`SearchExpression`	`withFilters (Collection<Filter> filters)` A list of filter objects.
`SearchExpression`	`withFilters (Filter... filters)` A list of filter objects.
`SearchExpression`	`withNestedFilters (Collection<NestedFilters> nestedFilters)` A list of nested filter objects.
`SearchExpression`	`withNestedFilters (NestedFilters... nestedFilters)` A list of nested filter objects.
`SearchExpression`	`withOperator (BooleanOperator operator)` A Boolean operator used to evaluate the search expression.
`SearchExpression`	`withOperator (String operator)` A Boolean operator used to evaluate the search expression.
`SearchExpression`	`withSubExpressions (Collection<SearchExpression> subExpressions)` A list of search expression objects.
`SearchExpression`	`withSubExpressions (SearchExpression... subExpressions)` A list of search expression objects.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SearchExpression
```
public SearchExpression()
```
- Method Detail
  - getFilters
```
public List<Filter> getFilters()
```
    A list of filter objects.
    
    Returns:
    
    A list of filter objects.
  - setFilters
```
public void setFilters(Collection<Filter> filters)
```
    A list of filter objects.
    
    Parameters:
    
    filters - A list of filter objects.
  - withFilters
```
public SearchExpression withFilters(Filter... filters)
```
    A list of filter objects.
    
    NOTE: This method appends the values to the existing list (if any). Use setFilters(java.util.Collection) or withFilters(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    filters - A list of filter objects.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withFilters
```
public SearchExpression withFilters(Collection<Filter> filters)
```
    A list of filter objects.
    
    Parameters:
    
    filters - A list of filter objects.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getNestedFilters
```
public List<NestedFilters> getNestedFilters()
```
    A list of nested filter objects.
    
    Returns:
    
    A list of nested filter objects.
  - setNestedFilters
```
public void setNestedFilters(Collection<NestedFilters> nestedFilters)
```
    A list of nested filter objects.
    
    Parameters:
    
    nestedFilters - A list of nested filter objects.
  - withNestedFilters
```
public SearchExpression withNestedFilters(NestedFilters... nestedFilters)
```
    A list of nested filter objects.
    
    NOTE: This method appends the values to the existing list (if any). Use setNestedFilters(java.util.Collection) or withNestedFilters(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    nestedFilters - A list of nested filter objects.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withNestedFilters
```
public SearchExpression withNestedFilters(Collection<NestedFilters> nestedFilters)
```
    A list of nested filter objects.
    
    Parameters:
    
    nestedFilters - A list of nested filter objects.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSubExpressions
```
public List<SearchExpression> getSubExpressions()
```
    A list of search expression objects.
    
    Returns:
    
    A list of search expression objects.
  - setSubExpressions
```
public void setSubExpressions(Collection<SearchExpression> subExpressions)
```
    A list of search expression objects.
    
    Parameters:
    
    subExpressions - A list of search expression objects.
  - withSubExpressions
```
public SearchExpression withSubExpressions(SearchExpression... subExpressions)
```
    A list of search expression objects.
    
    NOTE: This method appends the values to the existing list (if any). Use setSubExpressions(java.util.Collection) or withSubExpressions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    subExpressions - A list of search expression objects.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSubExpressions
```
public SearchExpression withSubExpressions(Collection<SearchExpression> subExpressions)
```
    A list of search expression objects.
    
    Parameters:
    
    subExpressions - A list of search expression objects.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOperator
```
public void setOperator(String operator)
```
    A Boolean operator used to evaluate the search expression. If you want every conditional statement in all lists to be satisfied for the entire search expression to be true, specify And. If only a single conditional statement needs to be true for the entire search expression to be true, specify Or. The default value is And.
    
    Parameters:
    
    operator - A Boolean operator used to evaluate the search expression. If you want every conditional statement in all lists to be satisfied for the entire search expression to be true, specify And. If only a single conditional statement needs to be true for the entire search expression to be true, specify Or. The default value is And.
    
    See Also:
    
    BooleanOperator
  - getOperator
```
public String getOperator()
```
    A Boolean operator used to evaluate the search expression. If you want every conditional statement in all lists to be satisfied for the entire search expression to be true, specify And. If only a single conditional statement needs to be true for the entire search expression to be true, specify Or. The default value is And.
    
    Returns:
    
    A Boolean operator used to evaluate the search expression. If you want every conditional statement in all lists to be satisfied for the entire search expression to be true, specify And. If only a single conditional statement needs to be true for the entire search expression to be true, specify Or. The default value is And.
    
    See Also:
    
    BooleanOperator
  - withOperator
```
public SearchExpression withOperator(String operator)
```
    A Boolean operator used to evaluate the search expression. If you want every conditional statement in all lists to be satisfied for the entire search expression to be true, specify And. If only a single conditional statement needs to be true for the entire search expression to be true, specify Or. The default value is And.
    
    Parameters:
    
    operator - A Boolean operator used to evaluate the search expression. If you want every conditional statement in all lists to be satisfied for the entire search expression to be true, specify And. If only a single conditional statement needs to be true for the entire search expression to be true, specify Or. The default value is And.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BooleanOperator
  - withOperator
```
public SearchExpression withOperator(BooleanOperator operator)
```
    A Boolean operator used to evaluate the search expression. If you want every conditional statement in all lists to be satisfied for the entire search expression to be true, specify And. If only a single conditional statement needs to be true for the entire search expression to be true, specify Or. The default value is And.
    
    Parameters:
    
    operator - A Boolean operator used to evaluate the search expression. If you want every conditional statement in all lists to be satisfied for the entire search expression to be true, specify And. If only a single conditional statement needs to be true for the entire search expression to be true, specify Or. The default value is And.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BooleanOperator
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public SearchExpression clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class SearchExpression

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SearchExpression

Method Detail

getFilters

setFilters

withFilters

withFilters

getNestedFilters

setNestedFilters

withNestedFilters

withNestedFilters

getSubExpressions

setSubExpressions

withSubExpressions

withSubExpressions

setOperator

getOperator

withOperator

withOperator

toString

equals

hashCode

clone

marshall