Class SearchAvailablePhoneNumbersRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.connect.model.ConnectRequest
software.amazon.awssdk.services.connect.model.SearchAvailablePhoneNumbersRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<SearchAvailablePhoneNumbersRequest.Builder,SearchAvailablePhoneNumbersRequest>
@Generated("software.amazon.awssdk:codegen") public final class SearchAvailablePhoneNumbersRequest extends ConnectRequest implements ToCopyableBuilder<SearchAvailablePhoneNumbersRequest.Builder,SearchAvailablePhoneNumbersRequest>

  • Method Details

    • targetArn

      public final String 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.

      Returns:
      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.

    • instanceId

      public final String 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.

      Returns:
      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.

    • phoneNumberCountryCode

      public final PhoneNumberCountryCode phoneNumberCountryCode()

      The ISO country code.

      If the service returns an enum value that is not available in the current SDK version, phoneNumberCountryCode will return PhoneNumberCountryCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from phoneNumberCountryCodeAsString().

      Returns:
      The ISO country code.
      See Also:

    • phoneNumberCountryCodeAsString

      public final String phoneNumberCountryCodeAsString()

      The ISO country code.

      If the service returns an enum value that is not available in the current SDK version, phoneNumberCountryCode will return PhoneNumberCountryCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from phoneNumberCountryCodeAsString().

      Returns:
      The ISO country code.
      See Also:

    • phoneNumberType

      public final PhoneNumberType phoneNumberType()

      The type of phone number.

      If the service returns an enum value that is not available in the current SDK version, phoneNumberType will return PhoneNumberType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from phoneNumberTypeAsString().

      Returns:
      The type of phone number.
      See Also:

    • phoneNumberTypeAsString

      public final String phoneNumberTypeAsString()

      The type of phone number.

      If the service returns an enum value that is not available in the current SDK version, phoneNumberType will return PhoneNumberType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from phoneNumberTypeAsString().

      Returns:
      The type of phone number.
      See Also:

    • phoneNumberPrefix

      public final String phoneNumberPrefix()

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

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

    • maxResults

      public final Integer maxResults()

      The maximum number of results to return per page.

      Returns:
      The maximum number of results to return per page.

    • nextToken

      public final String 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.

      Returns:
      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.

    • toBuilder

      public SearchAvailablePhoneNumbersRequest.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<SearchAvailablePhoneNumbersRequest.Builder,SearchAvailablePhoneNumbersRequest>
      Specified by:
      toBuilder in class ConnectRequest
      Returns:
      a builder for type T

    • builder

      public static SearchAvailablePhoneNumbersRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SearchAvailablePhoneNumbersRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.