Class Filter
- java.lang.Object
-
- software.amazon.awssdk.services.ec2.model.Filter
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Filter.Builder,Filter>
@Generated("software.amazon.awssdk:codegen") public final class Filter extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Filter.Builder,Filter>
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an
AND
, and the request returns only results that match all of the specified filters.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
Filter.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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 name of the filter.List<SdkField<?>>
sdkFields()
static Class<? extends Filter.Builder>
serializableBuilderClass()
Filter.Builder
toBuilder()
String
toString()
Returns a string representation of this object.List<String>
values()
The filter values.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
name
public final String name()
The name of the filter. Filter names are case-sensitive.
- Returns:
- The name of the filter. Filter names are case-sensitive.
-
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
public final List<String> values()
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an
OR
, and the request returns all results that match any of the specified values.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 filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the
values are joined with an
OR
, and the request returns all results that match any of the specified values.
-
toBuilder
public Filter.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<Filter.Builder,Filter>
-
builder
public static Filter.Builder builder()
-
serializableBuilderClass
public static Class<? extends Filter.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String 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.
-
-