java.lang.Object
- software.amazon.awssdk.services.connect.model.TrafficDistributionGroup

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<TrafficDistributionGroup.Builder,TrafficDistributionGroup>

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

Information about a traffic distribution group.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface TrafficDistributionGroup.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`arn()`	The Amazon Resource Name (ARN) of the traffic distribution group.
`static TrafficDistributionGroup.Builder`	`builder()`
`String`	`description()`	The description of the traffic distribution group.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`String`	`id()`	The identifier of the traffic distribution group.
`String`	`instanceArn()`	The Amazon Resource Name (ARN).
`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 TrafficDistributionGroup.Builder>`	`serializableBuilderClass()`
`TrafficDistributionGroupStatus`	`status()`	The status of the traffic distribution group.
`String`	`statusAsString()`	The status of the traffic distribution group.
`Map<String,String>`	`tags()`	The tags used to organize, track, or control access for this resource.
`TrafficDistributionGroup.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.
  - description
```
public final String description()
```
    The description of the traffic distribution group.
    
    Returns:
    
    The description of the traffic distribution group.
  - instanceArn
```
public final String instanceArn()
```
    The Amazon Resource Name (ARN).
    
    Returns:
    
    The Amazon Resource Name (ARN).
  - 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 UpdateTrafficDistribution 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 UpdateTrafficDistribution 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 UpdateTrafficDistribution 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 UpdateTrafficDistribution operation is still in progress and has not yet completed.
    
    See Also:
    
    TrafficDistributionGroupStatus
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags 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.
  - tags
```
public final Map<String,String> tags()
```
    The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
    
    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 hasTags() method.
    
    Returns:
    
    The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
  - 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.
    
    The SignInConfig distribution is available only on a default TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup, an InvalidRequestException is returned.
    
    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.
    
    The SignInConfig distribution is available only on a default TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup, an InvalidRequestException is returned.
  - toBuilder
```
public TrafficDistributionGroup.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<TrafficDistributionGroup.Builder,TrafficDistributionGroup>
  - builder
```
public static TrafficDistributionGroup.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends TrafficDistributionGroup.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

Class TrafficDistributionGroup

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

id

arn

name

description

instanceArn

status

statusAsString

hasTags

tags

isDefault

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields