software.amazon.awssdk.services.sagemaker.model

Class SearchExpression

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.SearchExpression

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SearchExpression.Builder,SearchExpression>

@Generated(value="software.amazon.awssdk:codegen")
public final class SearchExpression
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SearchExpression.Builder,SearchExpression>

A multi-expression that searches for the specified resource or resources. All resource objects that satisfy the expression's condition are included in the search results.

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 Boolean operator: And or Or.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SearchExpression.Builder

Method Summary

Modifier and Type	Method and Description
static SearchExpression.Builder	builder()
boolean	equals(Object obj)
List<Filter>	filters() A list of filter objects.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<NestedFilters>	nestedFilters() A list of nested filter objects.
BooleanOperator	operator() A Boolean operator used to evaluate the search expression.
String	operatorAsString() A Boolean operator used to evaluate the search expression.
List<SdkField<?>>	sdkFields()
static Class<? extends SearchExpression.Builder>	serializableBuilderClass()
List<SearchExpression>	subExpressions() A list of search expression objects.
SearchExpression.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

filters

public List<Filter> filters()

A list of filter objects.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A list of filter objects.

nestedFilters

public List<NestedFilters> nestedFilters()

A list of nested filter objects.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A list of nested filter objects.

subExpressions

public List<SearchExpression> subExpressions()

A list of search expression objects.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A list of search expression objects.

operator

public 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.

If the service returns an enum value that is not available in the current SDK version, operator will return BooleanOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operatorAsString().

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.

See Also:

BooleanOperator

operatorAsString

public String operatorAsString()

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.

If the service returns an enum value that is not available in the current SDK version, operator will return BooleanOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operatorAsString().

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.

See Also:

BooleanOperator

toBuilder

public SearchExpression.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<SearchExpression.Builder,SearchExpression>

Returns:

a builder for type T

builder

public static SearchExpression.Builder builder()

serializableBuilderClass

public static Class<? extends SearchExpression.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.