@Generated(value="software.amazon.awssdk:codegen") public final class Filter extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Filter.Builder,Filter>
A filter object that is used to return more specific results from a describe operation. Filters can be used to match a set of resources by specific criteria.
| Modifier and Type | Class and Description |
|---|---|
static interface |
Filter.Builder |
| Modifier and Type | Method and Description |
|---|---|
static Filter.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasValues()
For responses, this returns true if the service returned a value for the Values property.
|
String |
name()
The type of name to filter by.
|
Operator |
operator()
An operator for filtering results.
|
String |
operatorAsString()
An operator for filtering results.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends Filter.Builder> |
serializableBuilderClass() |
Filter.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
List<String> |
values()
One or more values for the name to filter by.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String name()
The type of name to filter by.
public final Operator operator()
An operator for filtering results.
If the service returns an enum value that is not available in the current SDK version, operator will
return Operator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
operatorAsString().
Operatorpublic final String operatorAsString()
An operator for filtering results.
If the service returns an enum value that is not available in the current SDK version, operator will
return Operator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
operatorAsString().
Operatorpublic final boolean hasValues()
isEmpty() 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.public final List<String> values()
One or more values for the name to filter by.
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.
public Filter.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<Filter.Builder,Filter>public static Filter.Builder builder()
public static Class<? extends Filter.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
Copyright © 2023. All rights reserved.