software.amazon.awssdk.services.connect.model

Class TrafficDistributionGroupSummary

java.lang.Object

software.amazon.awssdk.services.connect.model.TrafficDistributionGroupSummary

All Implemented Interfaces:

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

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

Information about traffic distribution groups.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TrafficDistributionGroupSummary.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The Amazon Resource Name (ARN) of the traffic distribution group.
static TrafficDistributionGroupSummary.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id() The identifier of the traffic distribution group.
String	instanceArn() The Amazon Resource Name (ARN) of the traffic distribution group.
Boolean	isDefault() Whether this is the default traffic distribution group created during instance replication.
String	name() The name of the traffic distribution group.
List<SdkField<?>>	sdkFields()
static Class<? extends TrafficDistributionGroupSummary.Builder>	serializableBuilderClass()
TrafficDistributionGroupStatus	status() The status of the traffic distribution group.
String	statusAsString() The status of the traffic distribution group.
TrafficDistributionGroupSummary.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

id

public final String 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

public final String arn()

The Amazon Resource Name (ARN) of the traffic distribution group.

Returns:

The Amazon Resource Name (ARN) of the traffic distribution group.

name

public final String name()

The name of the traffic distribution group.

Returns:

The name of the traffic distribution group.

instanceArn

public final String instanceArn()

The Amazon Resource Name (ARN) of the traffic distribution group.

Returns:

The Amazon Resource Name (ARN) of the traffic distribution group.

status

public final TrafficDistributionGroupStatus 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 return TrafficDistributionGroupStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

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:

TrafficDistributionGroupStatus

statusAsString

public final String 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 return TrafficDistributionGroupStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

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:

TrafficDistributionGroupStatus

isDefault

public final Boolean 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

public TrafficDistributionGroupSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TrafficDistributionGroupSummary.Builder,TrafficDistributionGroupSummary>

builder

public static TrafficDistributionGroupSummary.Builder builder()

serializableBuilderClass

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