Class EntityFilter
- java.lang.Object
-
- software.amazon.awssdk.services.health.model.EntityFilter
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<EntityFilter.Builder,EntityFilter>
@Generated("software.amazon.awssdk:codegen") public final class EntityFilter extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EntityFilter.Builder,EntityFilter>
The values to use to filter results from the DescribeAffectedEntities operation.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceEntityFilter.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static EntityFilter.Builderbuilder()List<String>entityArns()A list of entity ARNs (unique identifiers).List<String>entityValues()A list of IDs for affected entities.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)List<String>eventArns()A list of event ARNs (unique identifiers).<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasEntityArns()For responses, this returns true if the service returned a value for the EntityArns property.booleanhasEntityValues()For responses, this returns true if the service returned a value for the EntityValues property.booleanhasEventArns()For responses, this returns true if the service returned a value for the EventArns property.inthashCode()booleanhasLastUpdatedTimes()For responses, this returns true if the service returned a value for the LastUpdatedTimes property.booleanhasStatusCodes()For responses, this returns true if the service returned a value for the StatusCodes property.booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.List<DateTimeRange>lastUpdatedTimes()A list of the most recent dates and times that the entity was updated.List<SdkField<?>>sdkFields()static Class<? extends EntityFilter.Builder>serializableBuilderClass()List<EntityStatusCode>statusCodes()A list of entity status codes (IMPAIRED,UNIMPAIRED, orUNKNOWN).List<String>statusCodesAsStrings()A list of entity status codes (IMPAIRED,UNIMPAIRED, orUNKNOWN).List<Map<String,String>>tags()A map of entity tags attached to the affected entity.EntityFilter.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
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
-
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
public final List<String> 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
public final List<String> 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
public final List<String> 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
public final List<DateTimeRange> 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
public final List<Map<String,String>> tags()
A map of entity tags attached to the affected entity.
Currently, the
tagsproperty 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
tagsproperty isn't supported.
-
statusCodes
public final List<EntityStatusCode> 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
public final List<String> 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
public EntityFilter.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<EntityFilter.Builder,EntityFilter>
-
builder
public static EntityFilter.Builder builder()
-
serializableBuilderClass
public static Class<? extends EntityFilter.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin 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.
-
-