All Downloads are FREE. Search and download functionalities are using the official Maven repository.

software.amazon.awssdk.services.connect.model.ListPhoneNumbersV2Request Maven / Gradle / Ivy

Go to download

The AWS Java SDK for Connect module holds the client classes that are used for communicating with Connect.

There is a newer version: 2.29.15
Show newest version
/*
 * 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.Collection;
import java.util.Collections;
import java.util.List;
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.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
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 ListPhoneNumbersV2Request extends ConnectRequest implements
        ToCopyableBuilder {
    private static final SdkField TARGET_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
            .memberName("TargetArn").getter(getter(ListPhoneNumbersV2Request::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(ListPhoneNumbersV2Request::instanceId)).setter(setter(Builder::instanceId))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("InstanceId").build()).build();

    private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
            .memberName("MaxResults").getter(getter(ListPhoneNumbersV2Request::maxResults)).setter(setter(Builder::maxResults))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxResults").build()).build();

    private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
            .memberName("NextToken").getter(getter(ListPhoneNumbersV2Request::nextToken)).setter(setter(Builder::nextToken))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();

    private static final SdkField> PHONE_NUMBER_COUNTRY_CODES_FIELD = SdkField
            .> builder(MarshallingType.LIST)
            .memberName("PhoneNumberCountryCodes")
            .getter(getter(ListPhoneNumbersV2Request::phoneNumberCountryCodesAsStrings))
            .setter(setter(Builder::phoneNumberCountryCodesWithStrings))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PhoneNumberCountryCodes").build(),
                    ListTrait
                            .builder()
                            .memberLocationName(null)
                            .memberFieldInfo(
                                    SdkField. builder(MarshallingType.STRING)
                                            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
                                                    .locationName("member").build()).build()).build()).build();

    private static final SdkField> PHONE_NUMBER_TYPES_FIELD = SdkField
            .> builder(MarshallingType.LIST)
            .memberName("PhoneNumberTypes")
            .getter(getter(ListPhoneNumbersV2Request::phoneNumberTypesAsStrings))
            .setter(setter(Builder::phoneNumberTypesWithStrings))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PhoneNumberTypes").build(),
                    ListTrait
                            .builder()
                            .memberLocationName(null)
                            .memberFieldInfo(
                                    SdkField. builder(MarshallingType.STRING)
                                            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
                                                    .locationName("member").build()).build()).build()).build();

    private static final SdkField PHONE_NUMBER_PREFIX_FIELD = SdkField. builder(MarshallingType.STRING)
            .memberName("PhoneNumberPrefix").getter(getter(ListPhoneNumbersV2Request::phoneNumberPrefix))
            .setter(setter(Builder::phoneNumberPrefix))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PhoneNumberPrefix").build()).build();

    private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TARGET_ARN_FIELD,
            INSTANCE_ID_FIELD, MAX_RESULTS_FIELD, NEXT_TOKEN_FIELD, PHONE_NUMBER_COUNTRY_CODES_FIELD, PHONE_NUMBER_TYPES_FIELD,
            PHONE_NUMBER_PREFIX_FIELD));

    private final String targetArn;

    private final String instanceId;

    private final Integer maxResults;

    private final String nextToken;

    private final List phoneNumberCountryCodes;

    private final List phoneNumberTypes;

    private final String phoneNumberPrefix;

    private ListPhoneNumbersV2Request(BuilderImpl builder) {
        super(builder);
        this.targetArn = builder.targetArn;
        this.instanceId = builder.instanceId;
        this.maxResults = builder.maxResults;
        this.nextToken = builder.nextToken;
        this.phoneNumberCountryCodes = builder.phoneNumberCountryCodes;
        this.phoneNumberTypes = builder.phoneNumberTypes;
        this.phoneNumberPrefix = builder.phoneNumberPrefix;
    }

    /**
     * 

* The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number * inbound traffic is routed through. If both TargetArn and InstanceId input are not * provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the * same Amazon Web Services Region as the request. *

* * @return The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone * number inbound traffic is routed through. If both TargetArn and InstanceId * input are not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to * your account in the same Amazon Web Services Region as the request. */ 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. If both TargetArn and InstanceId are * not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the * same AWS Region as the request. *

* * @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. If both TargetArn and * InstanceId are not provided, this API lists numbers claimed to all the Amazon Connect * instances belonging to your account in the same AWS Region as the request. */ public final String instanceId() { return instanceId; } /** *

* The maximum number of results to return per page. *

* * @return The maximum number of results to return per page. */ public final Integer maxResults() { return maxResults; } /** *

* The token for the next set of results. Use the value returned in the previous response in the next request to * retrieve the next set of results. *

* * @return The token for the next set of results. Use the value returned in the previous response in the next * request to retrieve the next set of results. */ public final String nextToken() { return nextToken; } /** *

* The ISO country code. *

*

* 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 #hasPhoneNumberCountryCodes} method. *

* * @return The ISO country code. */ public final List phoneNumberCountryCodes() { return PhoneNumberCountryCodesCopier.copyStringToEnum(phoneNumberCountryCodes); } /** * For responses, this returns true if the service returned a value for the PhoneNumberCountryCodes 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 hasPhoneNumberCountryCodes() { return phoneNumberCountryCodes != null && !(phoneNumberCountryCodes instanceof SdkAutoConstructList); } /** *

* The ISO country code. *

*

* 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 #hasPhoneNumberCountryCodes} method. *

* * @return The ISO country code. */ public final List phoneNumberCountryCodesAsStrings() { return phoneNumberCountryCodes; } /** *

* The type of phone number. *

*

* 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 #hasPhoneNumberTypes} method. *

* * @return The type of phone number. */ public final List phoneNumberTypes() { return PhoneNumberTypesCopier.copyStringToEnum(phoneNumberTypes); } /** * For responses, this returns true if the service returned a value for the PhoneNumberTypes 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 hasPhoneNumberTypes() { return phoneNumberTypes != null && !(phoneNumberTypes instanceof SdkAutoConstructList); } /** *

* The type of phone number. *

*

* 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 #hasPhoneNumberTypes} method. *

* * @return The type of phone number. */ public final List phoneNumberTypesAsStrings() { return phoneNumberTypes; } /** *

* The prefix of the phone number. If provided, it must contain + as part of the country code. *

* * @return The prefix of the phone number. If provided, it must contain + as part of the country code. */ public final String phoneNumberPrefix() { return phoneNumberPrefix; } @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(maxResults()); hashCode = 31 * hashCode + Objects.hashCode(nextToken()); hashCode = 31 * hashCode + Objects.hashCode(hasPhoneNumberCountryCodes() ? phoneNumberCountryCodesAsStrings() : null); hashCode = 31 * hashCode + Objects.hashCode(hasPhoneNumberTypes() ? phoneNumberTypesAsStrings() : null); hashCode = 31 * hashCode + Objects.hashCode(phoneNumberPrefix()); 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 ListPhoneNumbersV2Request)) { return false; } ListPhoneNumbersV2Request other = (ListPhoneNumbersV2Request) obj; return Objects.equals(targetArn(), other.targetArn()) && Objects.equals(instanceId(), other.instanceId()) && Objects.equals(maxResults(), other.maxResults()) && Objects.equals(nextToken(), other.nextToken()) && hasPhoneNumberCountryCodes() == other.hasPhoneNumberCountryCodes() && Objects.equals(phoneNumberCountryCodesAsStrings(), other.phoneNumberCountryCodesAsStrings()) && hasPhoneNumberTypes() == other.hasPhoneNumberTypes() && Objects.equals(phoneNumberTypesAsStrings(), other.phoneNumberTypesAsStrings()) && Objects.equals(phoneNumberPrefix(), other.phoneNumberPrefix()); } /** * 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("ListPhoneNumbersV2Request").add("TargetArn", targetArn()).add("InstanceId", instanceId()) .add("MaxResults", maxResults()).add("NextToken", nextToken()) .add("PhoneNumberCountryCodes", hasPhoneNumberCountryCodes() ? phoneNumberCountryCodesAsStrings() : null) .add("PhoneNumberTypes", hasPhoneNumberTypes() ? phoneNumberTypesAsStrings() : null) .add("PhoneNumberPrefix", phoneNumberPrefix()).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 "MaxResults": return Optional.ofNullable(clazz.cast(maxResults())); case "NextToken": return Optional.ofNullable(clazz.cast(nextToken())); case "PhoneNumberCountryCodes": return Optional.ofNullable(clazz.cast(phoneNumberCountryCodesAsStrings())); case "PhoneNumberTypes": return Optional.ofNullable(clazz.cast(phoneNumberTypesAsStrings())); case "PhoneNumberPrefix": return Optional.ofNullable(clazz.cast(phoneNumberPrefix())); default: return Optional.empty(); } } @Override public final List> sdkFields() { return SDK_FIELDS; } private static Function getter(Function g) { return obj -> g.apply((ListPhoneNumbersV2Request) 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. If both TargetArn and InstanceId input are not * provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the * same Amazon Web Services Region as the request. *

* * @param targetArn * The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone * number inbound traffic is routed through. If both TargetArn and InstanceId * input are not provided, this API lists numbers claimed to all the Amazon Connect instances belonging * to your account in the same Amazon Web Services Region as the request. * @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. If both TargetArn and InstanceId * are not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your * account in the same AWS Region as the request. *

* * @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. If both TargetArn and * InstanceId are not provided, this API lists numbers claimed to all the Amazon Connect * instances belonging to your account in the same AWS Region as the request. * @return Returns a reference to this object so that method calls can be chained together. */ Builder instanceId(String instanceId); /** *

* The maximum number of results to return per page. *

* * @param maxResults * The maximum number of results to return per page. * @return Returns a reference to this object so that method calls can be chained together. */ Builder maxResults(Integer maxResults); /** *

* The token for the next set of results. Use the value returned in the previous response in the next request to * retrieve the next set of results. *

* * @param nextToken * The token for the next set of results. Use the value returned in the previous response in the next * request to retrieve the next set of results. * @return Returns a reference to this object so that method calls can be chained together. */ Builder nextToken(String nextToken); /** *

* The ISO country code. *

* * @param phoneNumberCountryCodes * The ISO country code. * @return Returns a reference to this object so that method calls can be chained together. */ Builder phoneNumberCountryCodesWithStrings(Collection phoneNumberCountryCodes); /** *

* The ISO country code. *

* * @param phoneNumberCountryCodes * The ISO country code. * @return Returns a reference to this object so that method calls can be chained together. */ Builder phoneNumberCountryCodesWithStrings(String... phoneNumberCountryCodes); /** *

* The ISO country code. *

* * @param phoneNumberCountryCodes * The ISO country code. * @return Returns a reference to this object so that method calls can be chained together. */ Builder phoneNumberCountryCodes(Collection phoneNumberCountryCodes); /** *

* The ISO country code. *

* * @param phoneNumberCountryCodes * The ISO country code. * @return Returns a reference to this object so that method calls can be chained together. */ Builder phoneNumberCountryCodes(PhoneNumberCountryCode... phoneNumberCountryCodes); /** *

* The type of phone number. *

* * @param phoneNumberTypes * The type of phone number. * @return Returns a reference to this object so that method calls can be chained together. */ Builder phoneNumberTypesWithStrings(Collection phoneNumberTypes); /** *

* The type of phone number. *

* * @param phoneNumberTypes * The type of phone number. * @return Returns a reference to this object so that method calls can be chained together. */ Builder phoneNumberTypesWithStrings(String... phoneNumberTypes); /** *

* The type of phone number. *

* * @param phoneNumberTypes * The type of phone number. * @return Returns a reference to this object so that method calls can be chained together. */ Builder phoneNumberTypes(Collection phoneNumberTypes); /** *

* The type of phone number. *

* * @param phoneNumberTypes * The type of phone number. * @return Returns a reference to this object so that method calls can be chained together. */ Builder phoneNumberTypes(PhoneNumberType... phoneNumberTypes); /** *

* The prefix of the phone number. If provided, it must contain + as part of the country code. *

* * @param phoneNumberPrefix * The prefix of the phone number. If provided, it must contain + as part of the country * code. * @return Returns a reference to this object so that method calls can be chained together. */ Builder phoneNumberPrefix(String phoneNumberPrefix); @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 Integer maxResults; private String nextToken; private List phoneNumberCountryCodes = DefaultSdkAutoConstructList.getInstance(); private List phoneNumberTypes = DefaultSdkAutoConstructList.getInstance(); private String phoneNumberPrefix; private BuilderImpl() { } private BuilderImpl(ListPhoneNumbersV2Request model) { super(model); targetArn(model.targetArn); instanceId(model.instanceId); maxResults(model.maxResults); nextToken(model.nextToken); phoneNumberCountryCodesWithStrings(model.phoneNumberCountryCodes); phoneNumberTypesWithStrings(model.phoneNumberTypes); phoneNumberPrefix(model.phoneNumberPrefix); } 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 Integer getMaxResults() { return maxResults; } public final void setMaxResults(Integer maxResults) { this.maxResults = maxResults; } @Override public final Builder maxResults(Integer maxResults) { this.maxResults = maxResults; return this; } public final String getNextToken() { return nextToken; } public final void setNextToken(String nextToken) { this.nextToken = nextToken; } @Override public final Builder nextToken(String nextToken) { this.nextToken = nextToken; return this; } public final Collection getPhoneNumberCountryCodes() { if (phoneNumberCountryCodes instanceof SdkAutoConstructList) { return null; } return phoneNumberCountryCodes; } public final void setPhoneNumberCountryCodes(Collection phoneNumberCountryCodes) { this.phoneNumberCountryCodes = PhoneNumberCountryCodesCopier.copy(phoneNumberCountryCodes); } @Override public final Builder phoneNumberCountryCodesWithStrings(Collection phoneNumberCountryCodes) { this.phoneNumberCountryCodes = PhoneNumberCountryCodesCopier.copy(phoneNumberCountryCodes); return this; } @Override @SafeVarargs public final Builder phoneNumberCountryCodesWithStrings(String... phoneNumberCountryCodes) { phoneNumberCountryCodesWithStrings(Arrays.asList(phoneNumberCountryCodes)); return this; } @Override public final Builder phoneNumberCountryCodes(Collection phoneNumberCountryCodes) { this.phoneNumberCountryCodes = PhoneNumberCountryCodesCopier.copyEnumToString(phoneNumberCountryCodes); return this; } @Override @SafeVarargs public final Builder phoneNumberCountryCodes(PhoneNumberCountryCode... phoneNumberCountryCodes) { phoneNumberCountryCodes(Arrays.asList(phoneNumberCountryCodes)); return this; } public final Collection getPhoneNumberTypes() { if (phoneNumberTypes instanceof SdkAutoConstructList) { return null; } return phoneNumberTypes; } public final void setPhoneNumberTypes(Collection phoneNumberTypes) { this.phoneNumberTypes = PhoneNumberTypesCopier.copy(phoneNumberTypes); } @Override public final Builder phoneNumberTypesWithStrings(Collection phoneNumberTypes) { this.phoneNumberTypes = PhoneNumberTypesCopier.copy(phoneNumberTypes); return this; } @Override @SafeVarargs public final Builder phoneNumberTypesWithStrings(String... phoneNumberTypes) { phoneNumberTypesWithStrings(Arrays.asList(phoneNumberTypes)); return this; } @Override public final Builder phoneNumberTypes(Collection phoneNumberTypes) { this.phoneNumberTypes = PhoneNumberTypesCopier.copyEnumToString(phoneNumberTypes); return this; } @Override @SafeVarargs public final Builder phoneNumberTypes(PhoneNumberType... phoneNumberTypes) { phoneNumberTypes(Arrays.asList(phoneNumberTypes)); return this; } public final String getPhoneNumberPrefix() { return phoneNumberPrefix; } public final void setPhoneNumberPrefix(String phoneNumberPrefix) { this.phoneNumberPrefix = phoneNumberPrefix; } @Override public final Builder phoneNumberPrefix(String phoneNumberPrefix) { this.phoneNumberPrefix = phoneNumberPrefix; 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 ListPhoneNumbersV2Request build() { return new ListPhoneNumbersV2Request(this); } @Override public List> sdkFields() { return SDK_FIELDS; } } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy