Class OrganizationEntityAggregate
- java.lang.Object
-
- software.amazon.awssdk.services.health.model.OrganizationEntityAggregate
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<OrganizationEntityAggregate.Builder,OrganizationEntityAggregate>
@Generated("software.amazon.awssdk:codegen") public final class OrganizationEntityAggregate extends Object implements SdkPojo, Serializable, ToCopyableBuilder<OrganizationEntityAggregate.Builder,OrganizationEntityAggregate>
The aggregate results of entities affected by the specified event in your organization. The results are aggregated by the entity status codes for the specified set of accountsIDs.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceOrganizationEntityAggregate.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<AccountEntityAggregate>accounts()A list of entity aggregates for each of the specified accounts in your organization that are affected by a specific event.static OrganizationEntityAggregate.Builderbuilder()Integercount()The number of entities for the organization that match the filter criteria for the specified events.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringeventArn()A list of event ARNs (unique identifiers).<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAccounts()For responses, this returns true if the service returned a value for the Accounts property.inthashCode()booleanhasStatuses()For responses, this returns true if the service returned a value for the Statuses property.List<SdkField<?>>sdkFields()static Class<? extends OrganizationEntityAggregate.Builder>serializableBuilderClass()Map<EntityStatusCode,Integer>statuses()The number of affected entities aggregated by the entitiy status codes.Map<String,Integer>statusesAsStrings()The number of affected entities aggregated by the entitiy status codes.OrganizationEntityAggregate.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
-
eventArn
public final String eventArn()
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"- 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"
-
count
public final Integer count()
The number of entities for the organization that match the filter criteria for the specified events.
- Returns:
- The number of entities for the organization that match the filter criteria for the specified events.
-
statuses
public final Map<EntityStatusCode,Integer> statuses()
The number of affected entities aggregated by the entitiy 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 entitiy 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 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.
-
statusesAsStrings
public final Map<String,Integer> statusesAsStrings()
The number of affected entities aggregated by the entitiy 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 entitiy status codes.
-
hasAccounts
public final boolean hasAccounts()
For responses, this returns true if the service returned a value for the Accounts 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.
-
accounts
public final List<AccountEntityAggregate> accounts()
A list of entity aggregates for each of the specified accounts in your organization that are affected by a specific event. If there are no
awsAccountIdsprovided in the request, this field will be empty in the response.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
hasAccounts()method.- Returns:
- A list of entity aggregates for each of the specified accounts in your organization that are affected by
a specific event. If there are no
awsAccountIdsprovided in the request, this field will be empty in the response.
-
toBuilder
public OrganizationEntityAggregate.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<OrganizationEntityAggregate.Builder,OrganizationEntityAggregate>
-
builder
public static OrganizationEntityAggregate.Builder builder()
-
serializableBuilderClass
public static Class<? extends OrganizationEntityAggregate.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.
-
-