software.amazon.awssdk.services.health.model

Class EventFilter

java.lang.Object

software.amazon.awssdk.services.health.model.EventFilter

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<EventFilter.Builder,EventFilter>

@Generated(value="software.amazon.awssdk:codegen")
public final class EventFilter
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<EventFilter.Builder,EventFilter>

The values to use to filter results from the DescribeEvents and DescribeEventAggregates operations.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EventFilter.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	availabilityZones() A list of Amazon Web Services Availability Zones.
static EventFilter.Builder	builder()
List<DateTimeRange>	endTimes() A list of dates and times that the event ended.
List<String>	entityArns() A list of entity ARNs (unique identifiers).
List<String>	entityValues() A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes ( vol-426ab23e).
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	eventArns() A list of event ARNs (unique identifiers).
List<EventStatusCode>	eventStatusCodes() A list of event status codes.
List<String>	eventStatusCodesAsStrings() A list of event status codes.
List<EventTypeCategory>	eventTypeCategories() A list of event type category codes.
List<String>	eventTypeCategoriesAsStrings() A list of event type category codes.
List<String>	eventTypeCodes() A list of unique identifiers for event types.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAvailabilityZones() For responses, this returns true if the service returned a value for the AvailabilityZones property.
boolean	hasEndTimes() For responses, this returns true if the service returned a value for the EndTimes property.
boolean	hasEntityArns() For responses, this returns true if the service returned a value for the EntityArns property.
boolean	hasEntityValues() For responses, this returns true if the service returned a value for the EntityValues property.
boolean	hasEventArns() For responses, this returns true if the service returned a value for the EventArns property.
boolean	hasEventStatusCodes() For responses, this returns true if the service returned a value for the EventStatusCodes property.
boolean	hasEventTypeCategories() For responses, this returns true if the service returned a value for the EventTypeCategories property.
boolean	hasEventTypeCodes() For responses, this returns true if the service returned a value for the EventTypeCodes property.
int	hashCode()
boolean	hasLastUpdatedTimes() For responses, this returns true if the service returned a value for the LastUpdatedTimes property.
boolean	hasRegions() For responses, this returns true if the service returned a value for the Regions property.
boolean	hasServices() For responses, this returns true if the service returned a value for the Services property.
boolean	hasStartTimes() For responses, this returns true if the service returned a value for the StartTimes property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
List<DateTimeRange>	lastUpdatedTimes() A list of dates and times that the event was last updated.
List<String>	regions() A list of Amazon Web Services Regions.
List<SdkField<?>>	sdkFields()
static Class<? extends EventFilter.Builder>	serializableBuilderClass()
List<String>	services() The Amazon Web Services services associated with the event.
List<DateTimeRange>	startTimes() A list of dates and times that the event began.
List<Map<String,String>>	tags() A map of entity tags attached to the affected entity.
EventFilter.Builder	toBuilder()
String	toString() 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 the 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.

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"

hasEventTypeCodes

public final boolean hasEventTypeCodes()

For responses, this returns true if the service returned a value for the EventTypeCodes property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

eventTypeCodes

public final List<String> eventTypeCodes()

A list of unique identifiers for event types. For example, "AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".

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 hasEventTypeCodes() method.

Returns:

A list of unique identifiers for event types. For example, "AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".

hasServices

public final boolean hasServices()

For responses, this returns true if the service returned a value for the Services property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

services

public final List<String> services()

The Amazon Web Services services associated with the event. For example, EC2, RDS.

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 hasServices() method.

Returns:

The Amazon Web Services services associated with the event. For example, EC2, RDS.

hasRegions

public final boolean hasRegions()

For responses, this returns true if the service returned a value for the Regions property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

regions

public final List<String> regions()

A list of Amazon Web Services Regions.

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 hasRegions() method.

Returns:

A list of Amazon Web Services Regions.

hasAvailabilityZones

public final boolean hasAvailabilityZones()

For responses, this returns true if the service returned a value for the AvailabilityZones property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

availabilityZones

public final List<String> availabilityZones()

A list of Amazon Web Services Availability Zones.

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 hasAvailabilityZones() method.

Returns:

A list of Amazon Web Services Availability Zones.

hasStartTimes

public final boolean hasStartTimes()

For responses, this returns true if the service returned a value for the StartTimes property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

startTimes

public final List<DateTimeRange> startTimes()

A list of dates and times that the event began.

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 hasStartTimes() method.

Returns:

A list of dates and times that the event began.

hasEndTimes

public final boolean hasEndTimes()

For responses, this returns true if the service returned a value for the EndTimes property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

endTimes

public final List<DateTimeRange> endTimes()

A list of dates and times that the event ended.

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 hasEndTimes() method.

Returns:

A list of dates and times that the event ended.

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 the 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.

lastUpdatedTimes

public final List<DateTimeRange> lastUpdatedTimes()

A list of dates and times that the event was last 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 dates and times that the event was last updated.

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 the 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.

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 the 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.

entityValues

public final List<String> entityValues()

A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes ( vol-426ab23e).

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 entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes ( vol-426ab23e).

eventTypeCategories

public final List<EventTypeCategory> eventTypeCategories()

A list of event type category codes. Possible values are issue, accountNotification, or scheduledChange. Currently, the investigation value isn't supported at this time.

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 hasEventTypeCategories() method.

Returns:

A list of event type category codes. Possible values are issue, accountNotification, or scheduledChange. Currently, the investigation value isn't supported at this time.

hasEventTypeCategories

public final boolean hasEventTypeCategories()

For responses, this returns true if the service returned a value for the EventTypeCategories property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

eventTypeCategoriesAsStrings

public final List<String> eventTypeCategoriesAsStrings()

A list of event type category codes. Possible values are issue, accountNotification, or scheduledChange. Currently, the investigation value isn't supported at this time.

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 hasEventTypeCategories() method.

Returns:

A list of event type category codes. Possible values are issue, accountNotification, or scheduledChange. Currently, the investigation value isn't supported at this time.

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 the 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.

tags

public final List<Map<String,String>> 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.

eventStatusCodes

public final List<EventStatusCode> eventStatusCodes()

A list of event status codes.

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 hasEventStatusCodes() method.

Returns:

A list of event status codes.

hasEventStatusCodes

public final boolean hasEventStatusCodes()

For responses, this returns true if the service returned a value for the EventStatusCodes property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

eventStatusCodesAsStrings

public final List<String> eventStatusCodesAsStrings()

A list of event status codes.

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 hasEventStatusCodes() method.

Returns:

A list of event status codes.

toBuilder

public EventFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EventFilter.Builder,EventFilter>

builder

public static EventFilter.Builder builder()

serializableBuilderClass

public static Class<? extends EventFilter.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo