software.amazon.awssdk.services.connect.model.ClaimPhoneNumberRequest 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.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.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
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.DefaultValueTrait;
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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class ClaimPhoneNumberRequest extends ConnectRequest implements
ToCopyableBuilder {
private static final SdkField TARGET_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TargetArn").getter(getter(ClaimPhoneNumberRequest::targetArn)).setter(setter(Builder::targetArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TargetArn").build()).build();
private static final SdkField INSTANCE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("InstanceId").getter(getter(ClaimPhoneNumberRequest::instanceId)).setter(setter(Builder::instanceId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("InstanceId").build()).build();
private static final SdkField PHONE_NUMBER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("PhoneNumber").getter(getter(ClaimPhoneNumberRequest::phoneNumber)).setter(setter(Builder::phoneNumber))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PhoneNumber").build()).build();
private static final SdkField PHONE_NUMBER_DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("PhoneNumberDescription").getter(getter(ClaimPhoneNumberRequest::phoneNumberDescription))
.setter(setter(Builder::phoneNumberDescription))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PhoneNumberDescription").build())
.build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("Tags")
.getter(getter(ClaimPhoneNumberRequest::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 CLIENT_TOKEN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ClientToken")
.getter(getter(ClaimPhoneNumberRequest::clientToken))
.setter(setter(Builder::clientToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ClientToken").build(),
DefaultValueTrait.idempotencyToken()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TARGET_ARN_FIELD,
INSTANCE_ID_FIELD, PHONE_NUMBER_FIELD, PHONE_NUMBER_DESCRIPTION_FIELD, TAGS_FIELD, CLIENT_TOKEN_FIELD));
private final String targetArn;
private final String instanceId;
private final String phoneNumber;
private final String phoneNumberDescription;
private final Map tags;
private final String clientToken;
private ClaimPhoneNumberRequest(BuilderImpl builder) {
super(builder);
this.targetArn = builder.targetArn;
this.instanceId = builder.instanceId;
this.phoneNumber = builder.phoneNumber;
this.phoneNumberDescription = builder.phoneNumberDescription;
this.tags = builder.tags;
this.clientToken = builder.clientToken;
}
/**
*
* The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number
* inbound traffic is routed through. You must enter InstanceId or TargetArn.
*
*
* @return The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone
* number inbound traffic is routed through. You must enter InstanceId or
* TargetArn.
*/
public final String targetArn() {
return targetArn;
}
/**
*
* The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in
* the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or TargetArn.
*
*
* @return The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance
* ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or
* TargetArn.
*/
public final String instanceId() {
return instanceId;
}
/**
*
* The phone number you want to claim. Phone numbers are formatted
* [+] [country code] [subscriber number including area code].
*
*
* @return The phone number you want to claim. Phone numbers are formatted
* [+] [country code] [subscriber number including area code].
*/
public final String phoneNumber() {
return phoneNumber;
}
/**
*
* The description of the phone number.
*
*
* @return The description of the phone number.
*/
public final String phoneNumberDescription() {
return phoneNumberDescription;
}
/**
* 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;
}
/**
*
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided,
* the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with
* idempotent APIs.
*
*
* Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
*
*
* @return A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not
* provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see
* Making
* retries safe with idempotent APIs.
*
* Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
*/
public final String clientToken() {
return clientToken;
}
@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 + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(targetArn());
hashCode = 31 * hashCode + Objects.hashCode(instanceId());
hashCode = 31 * hashCode + Objects.hashCode(phoneNumber());
hashCode = 31 * hashCode + Objects.hashCode(phoneNumberDescription());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
hashCode = 31 * hashCode + Objects.hashCode(clientToken());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ClaimPhoneNumberRequest)) {
return false;
}
ClaimPhoneNumberRequest other = (ClaimPhoneNumberRequest) obj;
return Objects.equals(targetArn(), other.targetArn()) && Objects.equals(instanceId(), other.instanceId())
&& Objects.equals(phoneNumber(), other.phoneNumber())
&& Objects.equals(phoneNumberDescription(), other.phoneNumberDescription()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags()) && Objects.equals(clientToken(), other.clientToken());
}
/**
* 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("ClaimPhoneNumberRequest").add("TargetArn", targetArn()).add("InstanceId", instanceId())
.add("PhoneNumber", phoneNumber()).add("PhoneNumberDescription", phoneNumberDescription())
.add("Tags", hasTags() ? tags() : null).add("ClientToken", clientToken()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "TargetArn":
return Optional.ofNullable(clazz.cast(targetArn()));
case "InstanceId":
return Optional.ofNullable(clazz.cast(instanceId()));
case "PhoneNumber":
return Optional.ofNullable(clazz.cast(phoneNumber()));
case "PhoneNumberDescription":
return Optional.ofNullable(clazz.cast(phoneNumberDescription()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
case "ClientToken":
return Optional.ofNullable(clazz.cast(clientToken()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ClaimPhoneNumberRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends ConnectRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number
* inbound traffic is routed through. You must enter InstanceId or TargetArn.
*
*
* @param targetArn
* The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone
* number inbound traffic is routed through. You must enter InstanceId or
* TargetArn.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder targetArn(String targetArn);
/**
*
* The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID
* in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or
* TargetArn.
*
*
* @param instanceId
* The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance
* ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or
* TargetArn.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder instanceId(String instanceId);
/**
*
* The phone number you want to claim. Phone numbers are formatted
* [+] [country code] [subscriber number including area code].
*
*
* @param phoneNumber
* The phone number you want to claim. Phone numbers are formatted
* [+] [country code] [subscriber number including area code].
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder phoneNumber(String phoneNumber);
/**
*
* The description of the phone number.
*
*
* @param phoneNumberDescription
* The description of the phone number.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder phoneNumberDescription(String phoneNumberDescription);
/**
*
* 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);
/**
*
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not
* provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe
* with idempotent APIs.
*
*
* Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
*
*
* @param clientToken
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not
* provided, the Amazon Web Services SDK populates this field. For more information about idempotency,
* see Making
* retries safe with idempotent APIs.
*
* Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder clientToken(String clientToken);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends ConnectRequest.BuilderImpl implements Builder {
private String targetArn;
private String instanceId;
private String phoneNumber;
private String phoneNumberDescription;
private Map tags = DefaultSdkAutoConstructMap.getInstance();
private String clientToken;
private BuilderImpl() {
}
private BuilderImpl(ClaimPhoneNumberRequest model) {
super(model);
targetArn(model.targetArn);
instanceId(model.instanceId);
phoneNumber(model.phoneNumber);
phoneNumberDescription(model.phoneNumberDescription);
tags(model.tags);
clientToken(model.clientToken);
}
public final String getTargetArn() {
return targetArn;
}
public final void setTargetArn(String targetArn) {
this.targetArn = targetArn;
}
@Override
public final Builder targetArn(String targetArn) {
this.targetArn = targetArn;
return this;
}
public final String getInstanceId() {
return instanceId;
}
public final void setInstanceId(String instanceId) {
this.instanceId = instanceId;
}
@Override
public final Builder instanceId(String instanceId) {
this.instanceId = instanceId;
return this;
}
public final String getPhoneNumber() {
return phoneNumber;
}
public final void setPhoneNumber(String phoneNumber) {
this.phoneNumber = phoneNumber;
}
@Override
public final Builder phoneNumber(String phoneNumber) {
this.phoneNumber = phoneNumber;
return this;
}
public final String getPhoneNumberDescription() {
return phoneNumberDescription;
}
public final void setPhoneNumberDescription(String phoneNumberDescription) {
this.phoneNumberDescription = phoneNumberDescription;
}
@Override
public final Builder phoneNumberDescription(String phoneNumberDescription) {
this.phoneNumberDescription = phoneNumberDescription;
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 String getClientToken() {
return clientToken;
}
public final void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
@Override
public final Builder clientToken(String clientToken) {
this.clientToken = clientToken;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public ClaimPhoneNumberRequest build() {
return new ClaimPhoneNumberRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}