Class SearchFilter
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<SearchFilter.Builder,
SearchFilter>
Describes criteria to restrict a list of results.
For operators that apply a single value to the attribute, the filter is evaluated as follows:
Attribute Operator Values[1]
Some operators, e.g. in
, can apply multiple values. In this case, the filter is evaluated as a logical
union (OR) of applications of the operator to the attribute with each one of the values:
(Attribute Operator Values[1]) OR (Attribute Operator Values[2]) OR ...
The valid values for attributes of SearchFilter
depend on the API action. For valid values, see the
reference page for the API action you're calling that takes a SearchFilter
parameter.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The result attribute to which the filter values are applied.static SearchFilter.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Values property.final String
operator()
The operator to apply to theAttribute
with each of theValues
.static Class
<? extends SearchFilter.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.values()
The list of values applied to theAttribute
andOperator
attributes.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
attribute
The result attribute to which the filter values are applied. Valid values vary by API action.
- Returns:
- The result attribute to which the filter values are applied. Valid values vary by API action.
-
operator
The operator to apply to the
Attribute
with each of theValues
. Valid values vary byAttribute
.- Returns:
- The operator to apply to the
Attribute
with each of theValues
. Valid values vary byAttribute
.
-
hasValues
public final boolean hasValues()For responses, this returns true if the service returned a value for the Values 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. -
values
The list of values applied to the
Attribute
andOperator
attributes. Number of values and valid values vary byAttribute
.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
hasValues()
method.- Returns:
- The list of values applied to the
Attribute
andOperator
attributes. Number of values and valid values vary byAttribute
.
-
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<SearchFilter.Builder,
SearchFilter> - 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
-