Class TrafficDistributionGroupSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<TrafficDistributionGroupSummary.Builder,
TrafficDistributionGroupSummary>
Information about traffic distribution groups.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The Amazon Resource Name (ARN) of the traffic distribution group.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
id()
The identifier of the traffic distribution group.final String
The Amazon Resource Name (ARN) of the traffic distribution group.final Boolean
Whether this is the default traffic distribution group created during instance replication.final String
name()
The name of the traffic distribution group.static Class
<? extends TrafficDistributionGroupSummary.Builder> status()
The status of the traffic distribution group.final String
The status of the traffic distribution group.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
-
id
The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
- Returns:
- The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
-
arn
The Amazon Resource Name (ARN) of the traffic distribution group.
- Returns:
- The Amazon Resource Name (ARN) of the traffic distribution group.
-
name
The name of the traffic distribution group.
- Returns:
- The name of the traffic distribution group.
-
instanceArn
The Amazon Resource Name (ARN) of the traffic distribution group.
- Returns:
- The Amazon Resource Name (ARN) of the traffic distribution group.
-
status
The status of the traffic distribution group.
-
CREATION_IN_PROGRESS
means the previous CreateTrafficDistributionGroup operation is still in progress and has not yet completed. -
ACTIVE
means the previous CreateTrafficDistributionGroup operation has succeeded. -
CREATION_FAILED
indicates that the previous CreateTrafficDistributionGroup operation has failed. -
PENDING_DELETION
means the previous DeleteTrafficDistributionGroup operation is still in progress and has not yet completed. -
DELETION_FAILED
means the previous DeleteTrafficDistributionGroup operation has failed. -
UPDATE_IN_PROGRESS
means the previous UpdateTrafficDistributionGroup operation is still in progress and has not yet completed.
If the service returns an enum value that is not available in the current SDK version,
status
will returnTrafficDistributionGroupStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the traffic distribution group.
-
CREATION_IN_PROGRESS
means the previous CreateTrafficDistributionGroup operation is still in progress and has not yet completed. -
ACTIVE
means the previous CreateTrafficDistributionGroup operation has succeeded. -
CREATION_FAILED
indicates that the previous CreateTrafficDistributionGroup operation has failed. -
PENDING_DELETION
means the previous DeleteTrafficDistributionGroup operation is still in progress and has not yet completed. -
DELETION_FAILED
means the previous DeleteTrafficDistributionGroup operation has failed. -
UPDATE_IN_PROGRESS
means the previous UpdateTrafficDistributionGroup operation is still in progress and has not yet completed.
-
- See Also:
-
-
statusAsString
The status of the traffic distribution group.
-
CREATION_IN_PROGRESS
means the previous CreateTrafficDistributionGroup operation is still in progress and has not yet completed. -
ACTIVE
means the previous CreateTrafficDistributionGroup operation has succeeded. -
CREATION_FAILED
indicates that the previous CreateTrafficDistributionGroup operation has failed. -
PENDING_DELETION
means the previous DeleteTrafficDistributionGroup operation is still in progress and has not yet completed. -
DELETION_FAILED
means the previous DeleteTrafficDistributionGroup operation has failed. -
UPDATE_IN_PROGRESS
means the previous UpdateTrafficDistributionGroup operation is still in progress and has not yet completed.
If the service returns an enum value that is not available in the current SDK version,
status
will returnTrafficDistributionGroupStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the traffic distribution group.
-
CREATION_IN_PROGRESS
means the previous CreateTrafficDistributionGroup operation is still in progress and has not yet completed. -
ACTIVE
means the previous CreateTrafficDistributionGroup operation has succeeded. -
CREATION_FAILED
indicates that the previous CreateTrafficDistributionGroup operation has failed. -
PENDING_DELETION
means the previous DeleteTrafficDistributionGroup operation is still in progress and has not yet completed. -
DELETION_FAILED
means the previous DeleteTrafficDistributionGroup operation has failed. -
UPDATE_IN_PROGRESS
means the previous UpdateTrafficDistributionGroup operation is still in progress and has not yet completed.
-
- See Also:
-
-
isDefault
Whether this is the default traffic distribution group created during instance replication. The default traffic distribution group cannot be deleted by the
DeleteTrafficDistributionGroup
API. The default traffic distribution group is deleted as part of the process for deleting a replica.- Returns:
- Whether this is the default traffic distribution group created during instance replication. The default
traffic distribution group cannot be deleted by the
DeleteTrafficDistributionGroup
API. The default traffic distribution group is deleted as part of the process for deleting a replica.
-
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<TrafficDistributionGroupSummary.Builder,
TrafficDistributionGroupSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
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
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-