Interface Filter.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<Filter.Builder,Filter>
,SdkBuilder<Filter.Builder,Filter>
,SdkPojo
- Enclosing class:
- Filter
public static interface Filter.Builder extends SdkPojo, CopyableBuilder<Filter.Builder,Filter>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Filter.Builder
name(String name)
A resource property name.Filter.Builder
operator(String operator)
A Boolean binary operator that is used to evaluate the filter.Filter.Builder
operator(Operator operator)
A Boolean binary operator that is used to evaluate the filter.Filter.Builder
value(String value)
A value used withName
andOperator
to determine which resources satisfy the filter's condition.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
name
Filter.Builder name(String name)
A resource property name. For example,
TrainingJobName
. For valid property names, see SearchRecord. You must specify a valid property for the resource.- Parameters:
name
- A resource property name. For example,TrainingJobName
. For valid property names, see SearchRecord. You must specify a valid property for the resource.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
operator
Filter.Builder operator(String operator)
A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:
- Equals
-
The value of
Name
equalsValue
. - NotEquals
-
The value of
Name
doesn't equalValue
. - Exists
-
The
Name
property exists. - NotExists
-
The
Name
property does not exist. - GreaterThan
-
The value of
Name
is greater thanValue
. Not supported for text properties. - GreaterThanOrEqualTo
-
The value of
Name
is greater than or equal toValue
. Not supported for text properties. - LessThan
-
The value of
Name
is less thanValue
. Not supported for text properties. - LessThanOrEqualTo
-
The value of
Name
is less than or equal toValue
. Not supported for text properties. - In
-
The value of
Name
is one of the comma delimited strings inValue
. Only supported for text properties. - Contains
-
The value of
Name
contains the stringValue
. Only supported for text properties.A
SearchExpression
can include theContains
operator multiple times when the value ofName
is one of the following:-
Experiment.DisplayName
-
Experiment.ExperimentName
-
Experiment.Tags
-
Trial.DisplayName
-
Trial.TrialName
-
Trial.Tags
-
TrialComponent.DisplayName
-
TrialComponent.TrialComponentName
-
TrialComponent.Tags
-
TrialComponent.InputArtifacts
-
TrialComponent.OutputArtifacts
A
SearchExpression
can include only oneContains
operator for all other values ofName
. In these cases, if you include multipleContains
operators in theSearchExpression
, the result is the following error message: "'CONTAINS' operator usage limit of 1 exceeded.
" -
- Parameters:
operator
- A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:- Equals
-
The value of
Name
equalsValue
. - NotEquals
-
The value of
Name
doesn't equalValue
. - Exists
-
The
Name
property exists. - NotExists
-
The
Name
property does not exist. - GreaterThan
-
The value of
Name
is greater thanValue
. Not supported for text properties. - GreaterThanOrEqualTo
-
The value of
Name
is greater than or equal toValue
. Not supported for text properties. - LessThan
-
The value of
Name
is less thanValue
. Not supported for text properties. - LessThanOrEqualTo
-
The value of
Name
is less than or equal toValue
. Not supported for text properties. - In
-
The value of
Name
is one of the comma delimited strings inValue
. Only supported for text properties. - Contains
-
The value of
Name
contains the stringValue
. Only supported for text properties.A
SearchExpression
can include theContains
operator multiple times when the value ofName
is one of the following:-
Experiment.DisplayName
-
Experiment.ExperimentName
-
Experiment.Tags
-
Trial.DisplayName
-
Trial.TrialName
-
Trial.Tags
-
TrialComponent.DisplayName
-
TrialComponent.TrialComponentName
-
TrialComponent.Tags
-
TrialComponent.InputArtifacts
-
TrialComponent.OutputArtifacts
A
SearchExpression
can include only oneContains
operator for all other values ofName
. In these cases, if you include multipleContains
operators in theSearchExpression
, the result is the following error message: "'CONTAINS' operator usage limit of 1 exceeded.
" -
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
Operator
,Operator
-
operator
Filter.Builder operator(Operator operator)
A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:
- Equals
-
The value of
Name
equalsValue
. - NotEquals
-
The value of
Name
doesn't equalValue
. - Exists
-
The
Name
property exists. - NotExists
-
The
Name
property does not exist. - GreaterThan
-
The value of
Name
is greater thanValue
. Not supported for text properties. - GreaterThanOrEqualTo
-
The value of
Name
is greater than or equal toValue
. Not supported for text properties. - LessThan
-
The value of
Name
is less thanValue
. Not supported for text properties. - LessThanOrEqualTo
-
The value of
Name
is less than or equal toValue
. Not supported for text properties. - In
-
The value of
Name
is one of the comma delimited strings inValue
. Only supported for text properties. - Contains
-
The value of
Name
contains the stringValue
. Only supported for text properties.A
SearchExpression
can include theContains
operator multiple times when the value ofName
is one of the following:-
Experiment.DisplayName
-
Experiment.ExperimentName
-
Experiment.Tags
-
Trial.DisplayName
-
Trial.TrialName
-
Trial.Tags
-
TrialComponent.DisplayName
-
TrialComponent.TrialComponentName
-
TrialComponent.Tags
-
TrialComponent.InputArtifacts
-
TrialComponent.OutputArtifacts
A
SearchExpression
can include only oneContains
operator for all other values ofName
. In these cases, if you include multipleContains
operators in theSearchExpression
, the result is the following error message: "'CONTAINS' operator usage limit of 1 exceeded.
" -
- Parameters:
operator
- A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:- Equals
-
The value of
Name
equalsValue
. - NotEquals
-
The value of
Name
doesn't equalValue
. - Exists
-
The
Name
property exists. - NotExists
-
The
Name
property does not exist. - GreaterThan
-
The value of
Name
is greater thanValue
. Not supported for text properties. - GreaterThanOrEqualTo
-
The value of
Name
is greater than or equal toValue
. Not supported for text properties. - LessThan
-
The value of
Name
is less thanValue
. Not supported for text properties. - LessThanOrEqualTo
-
The value of
Name
is less than or equal toValue
. Not supported for text properties. - In
-
The value of
Name
is one of the comma delimited strings inValue
. Only supported for text properties. - Contains
-
The value of
Name
contains the stringValue
. Only supported for text properties.A
SearchExpression
can include theContains
operator multiple times when the value ofName
is one of the following:-
Experiment.DisplayName
-
Experiment.ExperimentName
-
Experiment.Tags
-
Trial.DisplayName
-
Trial.TrialName
-
Trial.Tags
-
TrialComponent.DisplayName
-
TrialComponent.TrialComponentName
-
TrialComponent.Tags
-
TrialComponent.InputArtifacts
-
TrialComponent.OutputArtifacts
A
SearchExpression
can include only oneContains
operator for all other values ofName
. In these cases, if you include multipleContains
operators in theSearchExpression
, the result is the following error message: "'CONTAINS' operator usage limit of 1 exceeded.
" -
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
Operator
,Operator
-
value
Filter.Builder value(String value)
A value used with
Name
andOperator
to determine which resources 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 withName
andOperator
to determine which resources 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.
-
-