TrafficDistributionGroup (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.connect.model.TrafficDistributionGroup

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class TrafficDistributionGroup
extends Object
implements Serializable, Cloneable, StructuredPojo

Information about a traffic distribution group.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

TrafficDistributionGroup()

Constructors
Constructor and Description
`TrafficDistributionGroup()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TrafficDistributionGroup`	`addTagsEntry(String key, String value)` Add a single Tags entry
`TrafficDistributionGroup`	`clearTagsEntries()` Removes all the entries added into Tags.
`TrafficDistributionGroup`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The Amazon Resource Name (ARN) of the traffic distribution group.
`String`	`getDescription()` The description of the traffic distribution group.
`String`	`getId()` The identifier of the traffic distribution group.
`String`	`getInstanceArn()` The Amazon Resource Name (ARN).
`Boolean`	`getIsDefault()` Whether this is the default traffic distribution group created during instance replication.
`String`	`getName()` The name of the traffic distribution group.
`String`	`getStatus()` The status of the traffic distribution group.
`Map<String,String>`	`getTags()` The tags used to organize, track, or control access for this resource.
`int`	`hashCode()`
`Boolean`	`isDefault()` Whether this is the default traffic distribution group created during instance replication.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) of the traffic distribution group.
`void`	`setDescription(String description)` The description of the traffic distribution group.
`void`	`setId(String id)` The identifier of the traffic distribution group.
`void`	`setInstanceArn(String instanceArn)` The Amazon Resource Name (ARN).
`void`	`setIsDefault(Boolean isDefault)` Whether this is the default traffic distribution group created during instance replication.
`void`	`setName(String name)` The name of the traffic distribution group.
`void`	`setStatus(String status)` The status of the traffic distribution group.
`void`	`setTags(Map<String,String> tags)` The tags used to organize, track, or control access for this resource.
`String`	`toString()` Returns a string representation of this object.
`TrafficDistributionGroup`	`withArn(String arn)` The Amazon Resource Name (ARN) of the traffic distribution group.
`TrafficDistributionGroup`	`withDescription(String description)` The description of the traffic distribution group.
`TrafficDistributionGroup`	`withId(String id)` The identifier of the traffic distribution group.
`TrafficDistributionGroup`	`withInstanceArn(String instanceArn)` The Amazon Resource Name (ARN).
`TrafficDistributionGroup`	`withIsDefault(Boolean isDefault)` Whether this is the default traffic distribution group created during instance replication.
`TrafficDistributionGroup`	`withName(String name)` The name of the traffic distribution group.
`TrafficDistributionGroup`	`withStatus(String status)` The status of the traffic distribution group.
`TrafficDistributionGroup`	`withStatus(TrafficDistributionGroupStatus status)` The status of the traffic distribution group.
`TrafficDistributionGroup`	`withTags(Map<String,String> tags)` The tags used to organize, track, or control access for this resource.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TrafficDistributionGroup
```
public TrafficDistributionGroup()
```
- Method Detail
  - setId
```
public void setId(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.
    
    Parameters:
    
    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.
  - getId
```
public String getId()
```
    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.
  - withId
```
public TrafficDistributionGroup withId(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN) of the traffic distribution group.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the traffic distribution group.
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) of the traffic distribution group.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the traffic distribution group.
  - withArn
```
public TrafficDistributionGroup withArn(String arn)
```
    The Amazon Resource Name (ARN) of the traffic distribution group.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the traffic distribution group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the traffic distribution group.
    
    Parameters:
    
    name - The name of the traffic distribution group.
  - getName
```
public String getName()
```
    The name of the traffic distribution group.
    
    Returns:
    
    The name of the traffic distribution group.
  - withName
```
public TrafficDistributionGroup withName(String name)
```
    The name of the traffic distribution group.
    
    Parameters:
    
    name - The name of the traffic distribution group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description of the traffic distribution group.
    
    Parameters:
    
    description - The description of the traffic distribution group.
  - getDescription
```
public String getDescription()
```
    The description of the traffic distribution group.
    
    Returns:
    
    The description of the traffic distribution group.
  - withDescription
```
public TrafficDistributionGroup withDescription(String description)
```
    The description of the traffic distribution group.
    
    Parameters:
    
    description - The description of the traffic distribution group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInstanceArn
```
public void setInstanceArn(String instanceArn)
```
    The Amazon Resource Name (ARN).
    
    Parameters:
    
    instanceArn - The Amazon Resource Name (ARN).
  - getInstanceArn
```
public String getInstanceArn()
```
    The Amazon Resource Name (ARN).
    
    Returns:
    
    The Amazon Resource Name (ARN).
  - withInstanceArn
```
public TrafficDistributionGroup withInstanceArn(String instanceArn)
```
    The Amazon Resource Name (ARN).
    
    Parameters:
    
    instanceArn - The Amazon Resource Name (ARN).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String 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.
    Parameters:
    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.
    See Also:
    
    TrafficDistributionGroupStatus
  - getStatus
```
public String getStatus()
```
    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.
    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
  - withStatus
```
public TrafficDistributionGroup withStatus(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TrafficDistributionGroupStatus
  - withStatus
```
public TrafficDistributionGroup withStatus(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TrafficDistributionGroupStatus
  - getTags
```
public Map<String,String> getTags()
```
    The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
    
    Returns:
    
    The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
    
    Parameters:
    
    tags - The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
  - withTags
```
public TrafficDistributionGroup withTags(Map<String,String> tags)
```
    The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
    
    Parameters:
    
    tags - The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public TrafficDistributionGroup addTagsEntry(String key,
                                             String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public TrafficDistributionGroup clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIsDefault
```
public void setIsDefault(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.
    
    Parameters:
    
    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.
  - getIsDefault
```
public Boolean getIsDefault()
```
    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.
  - withIsDefault
```
public TrafficDistributionGroup withIsDefault(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isDefault
```
public 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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public TrafficDistributionGroup clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.793

Class TrafficDistributionGroup

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TrafficDistributionGroup

Method Detail

setId

getId

withId

setArn

getArn

withArn

setName

getName

withName

setDescription

getDescription

withDescription

setInstanceArn

getInstanceArn

withInstanceArn

setStatus

getStatus

withStatus

withStatus

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setIsDefault

getIsDefault

withIsDefault

isDefault

toString

equals

hashCode

clone

marshall