Package software.amazon.awssdk.services.health.model

Class EntityAggregate

java.lang.Object

software.amazon.awssdk.services.health.model.EntityAggregate

All Implemented Interfaces:

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

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

The number of entities that are affected by one or more events. Returned by the DescribeEntityAggregates operation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EntityAggregate.Builder

Method Summary

Modifier and Type	Method	Description
static EntityAggregate.Builder	builder()
Integer	count()	The number of entities that match the criteria for the specified events.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	eventArn()	The unique identifier for the event.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasStatuses()	For responses, this returns true if the service returned a value for the Statuses property.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends EntityAggregate.Builder>	serializableBuilderClass()
Map<EntityStatusCode,Integer>	statuses()	The number of affected entities aggregated by the entity status codes.
Map<String,Integer>	statusesAsStrings()	The number of affected entities aggregated by the entity status codes.
EntityAggregate.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

eventArn

public final String eventArn()

The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID format.

For example, an event ARN might look like the following:

arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456

Returns:

The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID format.

For example, an event ARN might look like the following:

arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456

count

public final Integer count()

The number of entities that match the criteria for the specified events.

Returns:

The number of entities that match the criteria for the specified events.

statuses

public final Map<EntityStatusCode,Integer> statuses()

The number of affected entities aggregated by the entity 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 hasStatuses() method.

Returns:

The number of affected entities aggregated by the entity status codes.

hasStatuses

public final boolean hasStatuses()

For responses, this returns true if the service returned a value for the Statuses 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.

statusesAsStrings

public final Map<String,Integer> statusesAsStrings()

The number of affected entities aggregated by the entity 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 hasStatuses() method.

Returns:

The number of affected entities aggregated by the entity status codes.

toBuilder

public EntityAggregate.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EntityAggregate.Builder,EntityAggregate>

builder

public static EntityAggregate.Builder builder()

serializableBuilderClass

public static Class<? extends EntityAggregate.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo