Class OrganizationEntityAggregate
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal List
<AccountEntityAggregate> accounts()
A list of entity aggregates for each of the specified accounts in your organization that are affected by a specific event.builder()
final Integer
count()
The number of entities for the organization that match the filter criteria for the specified events.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
eventArn()
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 Accounts property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Statuses property.static Class
<? extends OrganizationEntityAggregate.Builder> final Map
<EntityStatusCode, Integer> statuses()
The number of affected entities aggregated by the entitiy status codes.The number of affected entities aggregated by the entitiy status codes.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
-
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
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
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
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
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
awsAccountIds
provided 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
awsAccountIds
provided in the request, this field will be empty in the response.
-
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<OrganizationEntityAggregate.Builder,
OrganizationEntityAggregate> - 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
-