Package software.amazon.awssdk.services.connect.model

Class TrafficDistributionGroup

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:

  • Method Details

    • 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.

      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.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the traffic distribution group.

      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.

      See Also:

    • 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()
      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 interface ToCopyableBuilder<TrafficDistributionGroup.Builder,TrafficDistributionGroup>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.