software.amazon.awssdk.services.connect.model.TrafficDistributionGroup Maven / Gradle / Ivy
Show all versions of connect Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.connect.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Information about a traffic distribution group.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class TrafficDistributionGroup implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Id")
.getter(getter(TrafficDistributionGroup::id)).setter(setter(Builder::id))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Id").build()).build();
private static final SdkField ARN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Arn")
.getter(getter(TrafficDistributionGroup::arn)).setter(setter(Builder::arn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Arn").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(TrafficDistributionGroup::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(TrafficDistributionGroup::description)).setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final SdkField INSTANCE_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("InstanceArn").getter(getter(TrafficDistributionGroup::instanceArn)).setter(setter(Builder::instanceArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("InstanceArn").build()).build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Status")
.getter(getter(TrafficDistributionGroup::statusAsString)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Status").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("Tags")
.getter(getter(TrafficDistributionGroup::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final SdkField IS_DEFAULT_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("IsDefault").getter(getter(TrafficDistributionGroup::isDefault)).setter(setter(Builder::isDefault))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("IsDefault").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ID_FIELD, ARN_FIELD,
NAME_FIELD, DESCRIPTION_FIELD, INSTANCE_ARN_FIELD, STATUS_FIELD, TAGS_FIELD, IS_DEFAULT_FIELD));
private static final long serialVersionUID = 1L;
private final String id;
private final String arn;
private final String name;
private final String description;
private final String instanceArn;
private final String status;
private final Map tags;
private final Boolean isDefault;
private TrafficDistributionGroup(BuilderImpl builder) {
this.id = builder.id;
this.arn = builder.arn;
this.name = builder.name;
this.description = builder.description;
this.instanceArn = builder.instanceArn;
this.status = builder.status;
this.tags = builder.tags;
this.isDefault = builder.isDefault;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final String id() {
return id;
}
/**
*
* The Amazon Resource Name (ARN) of the traffic distribution group.
*
*
* @return The Amazon Resource Name (ARN) of the traffic distribution group.
*/
public final String arn() {
return arn;
}
/**
*
* The name of the traffic distribution group.
*
*
* @return The name of the traffic distribution group.
*/
public final String name() {
return name;
}
/**
*
* The description of the traffic distribution group.
*
*
* @return The description of the traffic distribution group.
*/
public final String description() {
return description;
}
/**
*
* The Amazon Resource Name (ARN).
*
*
* @return The Amazon Resource Name (ARN).
*/
public final String instanceArn() {
return instanceArn;
}
/**
*
* 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, {@link #status} will
* return {@link TrafficDistributionGroupStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #statusAsString}.
*
*
* @return 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 TrafficDistributionGroupStatus
*/
public final TrafficDistributionGroupStatus status() {
return TrafficDistributionGroupStatus.fromValue(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, {@link #status} will
* return {@link TrafficDistributionGroupStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #statusAsString}.
*
*
* @return 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 TrafficDistributionGroupStatus
*/
public final String statusAsString() {
return status;
}
/**
* 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 {@code 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.
*/
public final boolean hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructMap);
}
/**
*
* 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 {@link #hasTags} method.
*
*
* @return The tags used to organize, track, or control access for this resource. For example, { "Tags":
* {"key1":"value1", "key2":"value2"} }.
*/
public final Map tags() {
return tags;
}
/**
*
* 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.
*
*
*
* @return 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.
*
*/
public final Boolean isDefault() {
return isDefault;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(id());
hashCode = 31 * hashCode + Objects.hashCode(arn());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(instanceArn());
hashCode = 31 * hashCode + Objects.hashCode(statusAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
hashCode = 31 * hashCode + Objects.hashCode(isDefault());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof TrafficDistributionGroup)) {
return false;
}
TrafficDistributionGroup other = (TrafficDistributionGroup) obj;
return Objects.equals(id(), other.id()) && Objects.equals(arn(), other.arn()) && Objects.equals(name(), other.name())
&& Objects.equals(description(), other.description()) && Objects.equals(instanceArn(), other.instanceArn())
&& Objects.equals(statusAsString(), other.statusAsString()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags()) && Objects.equals(isDefault(), other.isDefault());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("TrafficDistributionGroup").add("Id", id()).add("Arn", arn()).add("Name", name())
.add("Description", description()).add("InstanceArn", instanceArn()).add("Status", statusAsString())
.add("Tags", hasTags() ? tags() : null).add("IsDefault", isDefault()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Id":
return Optional.ofNullable(clazz.cast(id()));
case "Arn":
return Optional.ofNullable(clazz.cast(arn()));
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "InstanceArn":
return Optional.ofNullable(clazz.cast(instanceArn()));
case "Status":
return Optional.ofNullable(clazz.cast(statusAsString()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
case "IsDefault":
return Optional.ofNullable(clazz.cast(isDefault()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((TrafficDistributionGroup) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder id(String id);
/**
*
* The Amazon Resource Name (ARN) of the traffic distribution group.
*
*
* @param arn
* The Amazon Resource Name (ARN) of the traffic distribution group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder arn(String arn);
/**
*
* The name of the traffic distribution group.
*
*
* @param name
* The name of the traffic distribution group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The description of the traffic distribution group.
*
*
* @param description
* The description of the traffic distribution group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* The Amazon Resource Name (ARN).
*
*
* @param instanceArn
* The Amazon Resource Name (ARN).
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder instanceArn(String instanceArn);
/**
*
* 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.
*
*
*
*
* @param 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 TrafficDistributionGroupStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see TrafficDistributionGroupStatus
*/
Builder status(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.
*
*
*
*
* @param 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 TrafficDistributionGroupStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see TrafficDistributionGroupStatus
*/
Builder status(TrafficDistributionGroupStatus status);
/**
*
* The tags used to organize, track, or control access for this resource. For example, { "Tags":
* {"key1":"value1", "key2":"value2"} }.
*
*
* @param tags
* The tags used to organize, track, or control access for this resource. For example, { "Tags":
* {"key1":"value1", "key2":"value2"} }.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Map tags);
/**
*
* 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.
*
*
*
* @param 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.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder isDefault(Boolean isDefault);
}
static final class BuilderImpl implements Builder {
private String id;
private String arn;
private String name;
private String description;
private String instanceArn;
private String status;
private Map tags = DefaultSdkAutoConstructMap.getInstance();
private Boolean isDefault;
private BuilderImpl() {
}
private BuilderImpl(TrafficDistributionGroup model) {
id(model.id);
arn(model.arn);
name(model.name);
description(model.description);
instanceArn(model.instanceArn);
status(model.status);
tags(model.tags);
isDefault(model.isDefault);
}
public final String getId() {
return id;
}
public final void setId(String id) {
this.id = id;
}
@Override
public final Builder id(String id) {
this.id = id;
return this;
}
public final String getArn() {
return arn;
}
public final void setArn(String arn) {
this.arn = arn;
}
@Override
public final Builder arn(String arn) {
this.arn = arn;
return this;
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final String getDescription() {
return description;
}
public final void setDescription(String description) {
this.description = description;
}
@Override
public final Builder description(String description) {
this.description = description;
return this;
}
public final String getInstanceArn() {
return instanceArn;
}
public final void setInstanceArn(String instanceArn) {
this.instanceArn = instanceArn;
}
@Override
public final Builder instanceArn(String instanceArn) {
this.instanceArn = instanceArn;
return this;
}
public final String getStatus() {
return status;
}
public final void setStatus(String status) {
this.status = status;
}
@Override
public final Builder status(String status) {
this.status = status;
return this;
}
@Override
public final Builder status(TrafficDistributionGroupStatus status) {
this.status(status == null ? null : status.toString());
return this;
}
public final Map getTags() {
if (tags instanceof SdkAutoConstructMap) {
return null;
}
return tags;
}
public final void setTags(Map tags) {
this.tags = TagMapCopier.copy(tags);
}
@Override
public final Builder tags(Map tags) {
this.tags = TagMapCopier.copy(tags);
return this;
}
public final Boolean getIsDefault() {
return isDefault;
}
public final void setIsDefault(Boolean isDefault) {
this.isDefault = isDefault;
}
@Override
public final Builder isDefault(Boolean isDefault) {
this.isDefault = isDefault;
return this;
}
@Override
public TrafficDistributionGroup build() {
return new TrafficDistributionGroup(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}