@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 resource property, a Boolean operator, 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:
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"
}
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"
}
To define a tag filter, enter a value with the form "Tags.<key>"
.
Constructor and Description |
---|
Filter() |
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. |
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.
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.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.
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.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.
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.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:
The specified resource in Name
equals the specified Value
.
The specified resource in Name
does not equal the specified Value
.
The specified resource in Name
is greater than the specified Value
. Not supported for
text-based properties.
The specified resource in Name
is greater than or equal to the specified Value
. Not
supported for text-based properties.
The specified resource in Name
is less than the specified Value
. Not supported for
text-based properties.
The specified resource in Name
is less than or equal to the specified Value
. Not
supported for text-based properties.
Only supported for text-based properties. The word-list of the property contains the specified Value
. A SearchExpression
can include only one Contains
operator.
If you have specified a filter Value
, the default is Equals
.
operator
- A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the
following values:
The specified resource in Name
equals the specified Value
.
The specified resource in Name
does not equal the specified Value
.
The specified resource in Name
is greater than the specified Value
. Not
supported for text-based properties.
The specified resource in Name
is greater than or equal to the specified Value
.
Not supported for text-based properties.
The specified resource in Name
is less than the specified Value
. Not supported
for text-based properties.
The specified resource in Name
is less than or equal to the specified Value
. Not
supported for text-based properties.
Only supported for text-based properties. The word-list of the property contains the specified
Value
. A SearchExpression
can include only one Contains
operator.
If you have specified a filter Value
, the default is Equals
.
Operator
public String getOperator()
A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:
The specified resource in Name
equals the specified Value
.
The specified resource in Name
does not equal the specified Value
.
The specified resource in Name
is greater than the specified Value
. Not supported for
text-based properties.
The specified resource in Name
is greater than or equal to the specified Value
. Not
supported for text-based properties.
The specified resource in Name
is less than the specified Value
. Not supported for
text-based properties.
The specified resource in Name
is less than or equal to the specified Value
. Not
supported for text-based properties.
Only supported for text-based properties. The word-list of the property contains the specified Value
. A SearchExpression
can include only one Contains
operator.
If you have specified a filter Value
, the default is Equals
.
The specified resource in Name
equals the specified Value
.
The specified resource in Name
does not equal the specified Value
.
The specified resource in Name
is greater than the specified Value
. Not
supported for text-based properties.
The specified resource in Name
is greater than or equal to the specified Value
.
Not supported for text-based properties.
The specified resource in Name
is less than the specified Value
. Not supported
for text-based properties.
The specified resource in Name
is less than or equal to the specified Value
.
Not supported for text-based properties.
Only supported for text-based properties. The word-list of the property contains the specified
Value
. A SearchExpression
can include only one Contains
operator.
If you have specified a filter Value
, the default is Equals
.
Operator
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:
The specified resource in Name
equals the specified Value
.
The specified resource in Name
does not equal the specified Value
.
The specified resource in Name
is greater than the specified Value
. Not supported for
text-based properties.
The specified resource in Name
is greater than or equal to the specified Value
. Not
supported for text-based properties.
The specified resource in Name
is less than the specified Value
. Not supported for
text-based properties.
The specified resource in Name
is less than or equal to the specified Value
. Not
supported for text-based properties.
Only supported for text-based properties. The word-list of the property contains the specified Value
. A SearchExpression
can include only one Contains
operator.
If you have specified a filter Value
, the default is Equals
.
operator
- A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the
following values:
The specified resource in Name
equals the specified Value
.
The specified resource in Name
does not equal the specified Value
.
The specified resource in Name
is greater than the specified Value
. Not
supported for text-based properties.
The specified resource in Name
is greater than or equal to the specified Value
.
Not supported for text-based properties.
The specified resource in Name
is less than the specified Value
. Not supported
for text-based properties.
The specified resource in Name
is less than or equal to the specified Value
. Not
supported for text-based properties.
Only supported for text-based properties. The word-list of the property contains the specified
Value
. A SearchExpression
can include only one Contains
operator.
If you have specified a filter Value
, the default is Equals
.
Operator
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:
The specified resource in Name
equals the specified Value
.
The specified resource in Name
does not equal the specified Value
.
The specified resource in Name
is greater than the specified Value
. Not supported for
text-based properties.
The specified resource in Name
is greater than or equal to the specified Value
. Not
supported for text-based properties.
The specified resource in Name
is less than the specified Value
. Not supported for
text-based properties.
The specified resource in Name
is less than or equal to the specified Value
. Not
supported for text-based properties.
Only supported for text-based properties. The word-list of the property contains the specified Value
. A SearchExpression
can include only one Contains
operator.
If you have specified a filter Value
, the default is Equals
.
operator
- A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the
following values:
The specified resource in Name
equals the specified Value
.
The specified resource in Name
does not equal the specified Value
.
The specified resource in Name
is greater than the specified Value
. Not
supported for text-based properties.
The specified resource in Name
is greater than or equal to the specified Value
.
Not supported for text-based properties.
The specified resource in Name
is less than the specified Value
. Not supported
for text-based properties.
The specified resource in Name
is less than or equal to the specified Value
. Not
supported for text-based properties.
Only supported for text-based properties. The word-list of the property contains the specified
Value
. A SearchExpression
can include only one Contains
operator.
If you have specified a filter Value
, the default is Equals
.
Operator
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
.
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
.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
.
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
.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
.
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
.public String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.