Filter (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Filter
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A conditional statement for a search expression that includes a Boolean operator, a resource property, and a value.

If you don't specify an Operator and a Value, the filter searches for only the specified property. For example, defining a Filter for the FailureReason for the TrainingJob Resource searches for training job objects that have a value in the FailureReason field.

If you specify a Value, but not an Operator, Amazon SageMaker uses the equals operator as the default.

In search, there are several property types:

Metrics

To define a metric filter, enter a value using the form "Metrics.<name>", where <name> is a metric name. For example, the following filter searches for training jobs with an "accuracy" metric greater than "0.9":

{

"Name": "Metrics.accuracy",

"Operator": "GREATER_THAN",

"Value": "0.9"

}

HyperParameters

To define a hyperparameter filter, enter a value with the form "HyperParameters.<name>". Decimal hyperparameter values are treated as a decimal in a comparison if the specified Value is also a decimal value. If the specified Value is an integer, the decimal hyperparameter values are treated as integers. For example, the following filter is satisfied by training jobs with a "learning_rate" hyperparameter that is less than "0.5":

{

"Name": "HyperParameters.learning_rate",

"Operator": "LESS_THAN",

"Value": "0.5"

}

Tags

To define a tag filter, enter a value with the form "Tags.<key>".

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Filter()

Constructors
Constructor and Description
`Filter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Filter`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getName()` A property name.
`String`	`getOperator()` A Boolean binary operator that is used to evaluate the filter.
`String`	`getValue()` A value used with `Resource` and `Operator` to determine if objects satisfy the filter's condition.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setName(String name)` A property name.
`void`	`setOperator(String operator)` A Boolean binary operator that is used to evaluate the filter.
`void`	`setValue(String value)` A value used with `Resource` and `Operator` to determine if objects satisfy the filter's condition.
`String`	`toString()` Returns a string representation of this object.
`Filter`	`withName(String name)` A property name.
`Filter`	`withOperator(Operator operator)` A Boolean binary operator that is used to evaluate the filter.
`Filter`	`withOperator(String operator)` A Boolean binary operator that is used to evaluate the filter.
`Filter`	`withValue(String value)` A value used with `Resource` and `Operator` to determine if objects satisfy the filter's condition.

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

- Constructor Detail
  - Filter
```
public Filter()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    A property name. For example, TrainingJobName. For the list of valid property names returned in a search result for each supported resource, see TrainingJob properties. You must specify a valid property name for the resource.
    
    Parameters:
    
    name - A property name. For example, TrainingJobName. For the list of valid property names returned in a search result for each supported resource, see TrainingJob properties. You must specify a valid property name for the resource.
  - getName
```
public String getName()
```
    A property name. For example, TrainingJobName. For the list of valid property names returned in a search result for each supported resource, see TrainingJob properties. You must specify a valid property name for the resource.
    
    Returns:
    
    A property name. For example, TrainingJobName. For the list of valid property names returned in a search result for each supported resource, see TrainingJob properties. You must specify a valid property name for the resource.
  - withName
```
public Filter withName(String name)
```
    A property name. For example, TrainingJobName. For the list of valid property names returned in a search result for each supported resource, see TrainingJob properties. You must specify a valid property name for the resource.
    
    Parameters:
    
    name - A property name. For example, TrainingJobName. For the list of valid property names returned in a search result for each supported resource, see TrainingJob properties. You must specify a valid property name for the resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOperator
```
public void setOperator(String operator)
```
    A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:
    
    Equals
    
    The specified resource in Name equals the specified Value.
    
    NotEquals
    
    The specified resource in Name does not equal the specified Value.
    
    GreaterThan
    
    The specified resource in Name is greater than the specified Value. Not supported for text-based properties.
    
    GreaterThanOrEqualTo
    
    The specified resource in Name is greater than or equal to the specified Value. Not supported for text-based properties.
    
    LessThan
    
    The specified resource in Name is less than the specified Value. Not supported for text-based properties.
    
    LessThanOrEqualTo
    
    The specified resource in Name is less than or equal to the specified Value. Not supported for text-based properties.
    
    Contains
    
    Only supported for text-based properties. The word-list of the property contains the specified Value .
    
    If you have specified a filter Value, the default is Equals.
    
    Parameters:
    
    operator - A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:
    
    Equals
    
    The specified resource in Name equals the specified Value.
    
    NotEquals
    
    The specified resource in Name does not equal the specified Value.
    
    GreaterThan
    
    The specified resource in Name is greater than the specified Value. Not supported for text-based properties.
    
    GreaterThanOrEqualTo
    
    The specified resource in Name is greater than or equal to the specified Value. Not supported for text-based properties.
    
    LessThan
    
    The specified resource in Name is less than the specified Value. Not supported for text-based properties.
    
    LessThanOrEqualTo
    
    The specified resource in Name is less than or equal to the specified Value. Not supported for text-based properties.
    
    Contains
    
    Only supported for text-based properties. The word-list of the property contains the specified Value.
    
    If you have specified a filter Value, the default is Equals.
    
    See Also:
    
    Operator
  - getOperator
```
public String getOperator()
```
    A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:
    
    Equals
    
    The specified resource in Name equals the specified Value.
    
    NotEquals
    
    The specified resource in Name does not equal the specified Value.
    
    GreaterThan
    
    The specified resource in Name is greater than the specified Value. Not supported for text-based properties.
    
    GreaterThanOrEqualTo
    
    The specified resource in Name is greater than or equal to the specified Value. Not supported for text-based properties.
    
    LessThan
    
    The specified resource in Name is less than the specified Value. Not supported for text-based properties.
    
    LessThanOrEqualTo
    
    The specified resource in Name is less than or equal to the specified Value. Not supported for text-based properties.
    
    Contains
    
    Only supported for text-based properties. The word-list of the property contains the specified Value .
    
    If you have specified a filter Value, the default is Equals.
    
    Returns:
    
    A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:
    
    Equals
    
    The specified resource in Name equals the specified Value.
    
    NotEquals
    
    The specified resource in Name does not equal the specified Value.
    
    GreaterThan
    
    The specified resource in Name is greater than the specified Value. Not supported for text-based properties.
    
    GreaterThanOrEqualTo
    
    The specified resource in Name is greater than or equal to the specified Value. Not supported for text-based properties.
    
    LessThan
    
    The specified resource in Name is less than the specified Value. Not supported for text-based properties.
    
    LessThanOrEqualTo
    
    The specified resource in Name is less than or equal to the specified Value. Not supported for text-based properties.
    
    Contains
    
    Only supported for text-based properties. The word-list of the property contains the specified Value.
    
    If you have specified a filter Value, the default is Equals.
    
    See Also:
    
    Operator
  - withOperator
```
public Filter withOperator(String operator)
```
    A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:
    
    Equals
    
    The specified resource in Name equals the specified Value.
    
    NotEquals
    
    The specified resource in Name does not equal the specified Value.
    
    GreaterThan
    
    The specified resource in Name is greater than the specified Value. Not supported for text-based properties.
    
    GreaterThanOrEqualTo
    
    The specified resource in Name is greater than or equal to the specified Value. Not supported for text-based properties.
    
    LessThan
    
    The specified resource in Name is less than the specified Value. Not supported for text-based properties.
    
    LessThanOrEqualTo
    
    The specified resource in Name is less than or equal to the specified Value. Not supported for text-based properties.
    
    Contains
    
    Only supported for text-based properties. The word-list of the property contains the specified Value .
    
    If you have specified a filter Value, the default is Equals.
    
    Parameters:
    
    operator - A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:
    
    Equals
    
    The specified resource in Name equals the specified Value.
    
    NotEquals
    
    The specified resource in Name does not equal the specified Value.
    
    GreaterThan
    
    The specified resource in Name is greater than the specified Value. Not supported for text-based properties.
    
    GreaterThanOrEqualTo
    
    The specified resource in Name is greater than or equal to the specified Value. Not supported for text-based properties.
    
    LessThan
    
    The specified resource in Name is less than the specified Value. Not supported for text-based properties.
    
    LessThanOrEqualTo
    
    The specified resource in Name is less than or equal to the specified Value. Not supported for text-based properties.
    
    Contains
    
    Only supported for text-based properties. The word-list of the property contains the specified Value.
    
    If you have specified a filter Value, the default is Equals.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Operator
  - withOperator
```
public Filter withOperator(Operator operator)
```
    A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:
    
    Equals
    
    The specified resource in Name equals the specified Value.
    
    NotEquals
    
    The specified resource in Name does not equal the specified Value.
    
    GreaterThan
    
    The specified resource in Name is greater than the specified Value. Not supported for text-based properties.
    
    GreaterThanOrEqualTo
    
    The specified resource in Name is greater than or equal to the specified Value. Not supported for text-based properties.
    
    LessThan
    
    The specified resource in Name is less than the specified Value. Not supported for text-based properties.
    
    LessThanOrEqualTo
    
    The specified resource in Name is less than or equal to the specified Value. Not supported for text-based properties.
    
    Contains
    
    Only supported for text-based properties. The word-list of the property contains the specified Value .
    
    If you have specified a filter Value, the default is Equals.
    
    Parameters:
    
    operator - A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:
    
    Equals
    
    The specified resource in Name equals the specified Value.
    
    NotEquals
    
    The specified resource in Name does not equal the specified Value.
    
    GreaterThan
    
    The specified resource in Name is greater than the specified Value. Not supported for text-based properties.
    
    GreaterThanOrEqualTo
    
    The specified resource in Name is greater than or equal to the specified Value. Not supported for text-based properties.
    
    LessThan
    
    The specified resource in Name is less than the specified Value. Not supported for text-based properties.
    
    LessThanOrEqualTo
    
    The specified resource in Name is less than or equal to the specified Value. Not supported for text-based properties.
    
    Contains
    
    Only supported for text-based properties. The word-list of the property contains the specified Value.
    
    If you have specified a filter Value, the default is Equals.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Operator
  - setValue
```
public void setValue(String value)
```
    A value used with Resource and Operator to determine if objects satisfy the filter's condition. For numerical properties, Value must be an integer or floating-point decimal. For timestamp properties, Value must be an ISO 8601 date-time string of the following format: YYYY-mm-dd'T'HH:MM:SS.
    
    Parameters:
    
    value - A value used with Resource and Operator to determine if objects satisfy the filter's condition. For numerical properties, Value must be an integer or floating-point decimal. For timestamp properties, Value must be an ISO 8601 date-time string of the following format: YYYY-mm-dd'T'HH:MM:SS.
  - getValue
```
public String getValue()
```
    A value used with Resource and Operator to determine if objects satisfy the filter's condition. For numerical properties, Value must be an integer or floating-point decimal. For timestamp properties, Value must be an ISO 8601 date-time string of the following format: YYYY-mm-dd'T'HH:MM:SS.
    
    Returns:
    
    A value used with Resource and Operator to determine if objects satisfy the filter's condition. For numerical properties, Value must be an integer or floating-point decimal. For timestamp properties, Value must be an ISO 8601 date-time string of the following format: YYYY-mm-dd'T'HH:MM:SS.
  - withValue
```
public Filter withValue(String value)
```
    A value used with Resource and Operator to determine if objects satisfy the filter's condition. For numerical properties, Value must be an integer or floating-point decimal. For timestamp properties, Value must be an ISO 8601 date-time string of the following format: YYYY-mm-dd'T'HH:MM:SS.
    
    Parameters:
    
    value - A value used with Resource and Operator to determine if objects satisfy the filter's condition. For numerical properties, Value must be an integer or floating-point decimal. For timestamp properties, Value must be an ISO 8601 date-time string of the following format: YYYY-mm-dd'T'HH:MM:SS.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 Filter 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.

Did this page help you?

Class Filter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Filter

Method Detail

setName

getName

withName

setOperator

getOperator

withOperator

withOperator

setValue

getValue

withValue

toString

equals

hashCode

clone

marshall