Class Filter
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Filter.Builder,
Filter>
Describes a filter that is used to return a more specific list of results from a describe operation.
If you specify multiple filters, the filters are automatically logically joined with an AND
, and the
request returns only the results that match all of the specified filters.
For more information, see Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
- 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 <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
name()
The name of the filter.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.values()
One or more filter values.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the filter.
The valid values for
Name
depend on which API operation you're using with the filter (DescribeAutoScalingGroups or DescribeTags).DescribeAutoScalingGroups
Valid values for
Name
include the following:-
tag-key
- Accepts tag keys. The results only include information about the Auto Scaling groups associated with these tag keys. -
tag-value
- Accepts tag values. The results only include information about the Auto Scaling groups associated with these tag values. -
tag:<key>
- Accepts the key/value combination of the tag. Use the tag key in the filter name and the tag value as the filter value. The results only include information about the Auto Scaling groups associated with the specified key/value combination.
DescribeTags
Valid values for
Name
include the following:-
auto-scaling-group
- Accepts the names of Auto Scaling groups. The results only include information about the tags associated with these Auto Scaling groups. -
key
- Accepts tag keys. The results only include information about the tags associated with these tag keys. -
value
- Accepts tag values. The results only include information about the tags associated with these tag values. -
propagate-at-launch
- Accepts a Boolean value, which specifies whether tags propagate to instances at launch. The results only include information about the tags associated with the specified Boolean value.
- Returns:
- The name of the filter.
The valid values for
Name
depend on which API operation you're using with the filter (DescribeAutoScalingGroups or DescribeTags).DescribeAutoScalingGroups
Valid values for
Name
include the following:-
tag-key
- Accepts tag keys. The results only include information about the Auto Scaling groups associated with these tag keys. -
tag-value
- Accepts tag values. The results only include information about the Auto Scaling groups associated with these tag values. -
tag:<key>
- Accepts the key/value combination of the tag. Use the tag key in the filter name and the tag value as the filter value. The results only include information about the Auto Scaling groups associated with the specified key/value combination.
DescribeTags
Valid values for
Name
include the following:-
auto-scaling-group
- Accepts the names of Auto Scaling groups. The results only include information about the tags associated with these Auto Scaling groups. -
key
- Accepts tag keys. The results only include information about the tags associated with these tag keys. -
value
- Accepts tag values. The results only include information about the tags associated with these tag values. -
propagate-at-launch
- Accepts a Boolean value, which specifies whether tags propagate to instances at launch. The results only include information about the tags associated with the specified Boolean value.
-
-
-
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
One or more filter values. Filter values are case-sensitive.
If you specify multiple values for a filter, the values are automatically logically joined with an
OR
, and the request returns all results that match any of the specified values. For example, specify "tag:environment" for the filter name and "production,development" for the filter values to find Auto Scaling groups with the tag "environment=production" or "environment=development".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:
- One or more filter values. Filter values are case-sensitive.
If you specify multiple values for a filter, the values are automatically logically joined with an
OR
, and the request returns all results that match any of the specified values. For example, specify "tag:environment" for the filter name and "production,development" for the filter values to find Auto Scaling groups with the tag "environment=production" or "environment=development".
-
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
-