Class SearchAvailablePhoneNumbersRequest

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

  • Method Details

    • areaCode

      public final String areaCode()

      The area code used to filter results. Only applies to the US.

      Returns:
      The area code used to filter results. Only applies to the US.

    • city

      public final String city()

      The city used to filter results. Only applies to the US.

      Returns:
      The city used to filter results. Only applies to the US.

    • country

      public final String country()

      The country used to filter results. Defaults to the US Format: ISO 3166-1 alpha-2.

      Returns:
      The country used to filter results. Defaults to the US Format: ISO 3166-1 alpha-2.

    • state

      public final String state()

      The state used to filter results. Required only if you provide City. Only applies to the US.

      Returns:
      The state used to filter results. Required only if you provide City. Only applies to the US.

    • tollFreePrefix

      public final String tollFreePrefix()

      The toll-free prefix that you use to filter results. Only applies to the US.

      Returns:
      The toll-free prefix that you use to filter results. Only applies to the US.

    • phoneNumberType

      public final PhoneNumberType phoneNumberType()

      The phone number type used to filter results. Required for non-US numbers.

      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 phone number type used to filter results. Required for non-US numbers.
      See Also:

    • phoneNumberTypeAsString

      public final String phoneNumberTypeAsString()

      The phone number type used to filter results. Required for non-US numbers.

      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 phone number type used to filter results. Required for non-US numbers.
      See Also:

    • maxResults

      public final Integer maxResults()

      The maximum number of results to return in a single call.

      Returns:
      The maximum number of results to return in a single call.

    • nextToken

      public final String nextToken()

      The token used to retrieve the next page of results.

      Returns:
      The token used to retrieve the next page 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 ChimeRequest
      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.