Class Filter
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Filter.Builder,
Filter>
A search filter.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Filter.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final FilterField
field()
The field on which to filter.final String
The field on which to filter.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final FilterOperator
operator()
The operator to use for comparing the field’s value with the provided value.final String
The operator to use for comparing the field’s value with the provided value.static Class
<? extends Filter.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
value()
The desired field value on which to filter.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
field
The field on which to filter.
If the service returns an enum value that is not available in the current SDK version,
field
will returnFilterField.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfieldAsString()
.- Returns:
- The field on which to filter.
- See Also:
-
fieldAsString
The field on which to filter.
If the service returns an enum value that is not available in the current SDK version,
field
will returnFilterField.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfieldAsString()
.- Returns:
- The field on which to filter.
- See Also:
-
operator
The operator to use for comparing the field’s value with the provided value.
If the service returns an enum value that is not available in the current SDK version,
operator
will returnFilterOperator.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoperatorAsString()
.- Returns:
- The operator to use for comparing the field’s value with the provided value.
- See Also:
-
operatorAsString
The operator to use for comparing the field’s value with the provided value.
If the service returns an enum value that is not available in the current SDK version,
operator
will returnFilterOperator.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoperatorAsString()
.- Returns:
- The operator to use for comparing the field’s value with the provided value.
- See Also:
-
value
The desired field value on which to filter.
- Returns:
- The desired field value on which to filter.
-
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 interfaceToCopyableBuilder<Filter.Builder,
Filter> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-