Class NestedFilters
- java.lang.Object
-
- software.amazon.awssdk.services.sagemaker.model.NestedFilters
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<NestedFilters.Builder,NestedFilters>
@Generated("software.amazon.awssdk:codegen") public final class NestedFilters extends Object implements SdkPojo, Serializable, ToCopyableBuilder<NestedFilters.Builder,NestedFilters>
A list of nested Filter objects. A resource must satisfy the conditions of all filters to be included in the results returned from the Search API.
For example, to filter on a training job's
InputDataConfig
property with a specific channel name andS3Uri
prefix, define the following filters:-
'{Name:"InputDataConfig.ChannelName", "Operator":"Equals", "Value":"train"}',
-
'{Name:"InputDataConfig.DataSource.S3DataSource.S3Uri", "Operator":"Contains", "Value":"mybucket/catdata"}'
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
NestedFilters.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static NestedFilters.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
List<Filter>
filters()
A list of filters.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasFilters()
For responses, this returns true if the service returned a value for the Filters property.int
hashCode()
String
nestedPropertyName()
The name of the property to use in the nested filters.List<SdkField<?>>
sdkFields()
static Class<? extends NestedFilters.Builder>
serializableBuilderClass()
NestedFilters.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
nestedPropertyName
public final String nestedPropertyName()
The name of the property to use in the nested filters. The value must match a listed property name, such as
InputDataConfig
.- Returns:
- The name of the property to use in the nested filters. The value must match a listed property name, such
as
InputDataConfig
.
-
hasFilters
public final boolean hasFilters()
For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
filters
public final List<Filter> filters()
A list of filters. Each filter acts on a property. Filters must contain at least one
Filters
value. For example, aNestedFilters
call might include a filter on thePropertyName
parameter of theInputDataConfig
property:InputDataConfig.DataSource.S3DataSource.S3Uri
.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasFilters()
method.- Returns:
- A list of filters. Each filter acts on a property. Filters must contain at least one
Filters
value. For example, aNestedFilters
call might include a filter on thePropertyName
parameter of theInputDataConfig
property:InputDataConfig.DataSource.S3DataSource.S3Uri
.
-
toBuilder
public NestedFilters.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<NestedFilters.Builder,NestedFilters>
-
builder
public static NestedFilters.Builder builder()
-
serializableBuilderClass
public static Class<? extends NestedFilters.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final 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.
-
-