Class EntityFilter
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<EntityFilter.Builder,
EntityFilter>
The values to use to filter results from the DescribeAffectedEntities operation.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic EntityFilter.Builder
builder()
A list of entity ARNs (unique identifiers).A list of IDs for affected entities.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.A list of event ARNs (unique identifiers).final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the EntityArns property.final boolean
For responses, this returns true if the service returned a value for the EntityValues property.final boolean
For responses, this returns true if the service returned a value for the EventArns property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the LastUpdatedTimes property.final boolean
For responses, this returns true if the service returned a value for the StatusCodes property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final List
<DateTimeRange> A list of the most recent dates and times that the entity was updated.static Class
<? extends EntityFilter.Builder> final List
<EntityStatusCode> A list of entity status codes (IMPAIRED
,UNIMPAIRED
, orUNKNOWN
).A list of entity status codes (IMPAIRED
,UNIMPAIRED
, orUNKNOWN
).tags()
A map of entity tags attached to the affected entity.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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasEventArns
public final boolean hasEventArns()For responses, this returns true if the service returned a value for the EventArns 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. -
eventArns
A list of event ARNs (unique identifiers). For example:
"arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"
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
hasEventArns()
method.- Returns:
- A list of event ARNs (unique identifiers). For example:
"arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"
-
hasEntityArns
public final boolean hasEntityArns()For responses, this returns true if the service returned a value for the EntityArns 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. -
entityArns
A list of entity ARNs (unique identifiers).
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
hasEntityArns()
method.- Returns:
- A list of entity ARNs (unique identifiers).
-
hasEntityValues
public final boolean hasEntityValues()For responses, this returns true if the service returned a value for the EntityValues 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. -
entityValues
A list of IDs for affected entities.
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
hasEntityValues()
method.- Returns:
- A list of IDs for affected entities.
-
hasLastUpdatedTimes
public final boolean hasLastUpdatedTimes()For responses, this returns true if the service returned a value for the LastUpdatedTimes 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. -
lastUpdatedTimes
A list of the most recent dates and times that the entity was updated.
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
hasLastUpdatedTimes()
method.- Returns:
- A list of the most recent dates and times that the entity was updated.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags 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. -
tags
A map of entity tags attached to the affected entity.
Currently, the
tags
property isn't supported.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
hasTags()
method.- Returns:
- A map of entity tags attached to the affected entity.
Currently, the
tags
property isn't supported.
-
statusCodes
A list of entity status codes (
IMPAIRED
,UNIMPAIRED
, orUNKNOWN
).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
hasStatusCodes()
method.- Returns:
- A list of entity status codes (
IMPAIRED
,UNIMPAIRED
, orUNKNOWN
).
-
hasStatusCodes
public final boolean hasStatusCodes()For responses, this returns true if the service returned a value for the StatusCodes 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. -
statusCodesAsStrings
A list of entity status codes (
IMPAIRED
,UNIMPAIRED
, orUNKNOWN
).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
hasStatusCodes()
method.- Returns:
- A list of entity status codes (
IMPAIRED
,UNIMPAIRED
, orUNKNOWN
).
-
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<EntityFilter.Builder,
EntityFilter> - 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
-