Class ListPhoneNumbersRequest

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.ListPhoneNumbersRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListPhoneNumbersRequest.Builder,ListPhoneNumbersRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListPhoneNumbersRequest extends ChimeRequest implements ToCopyableBuilder<ListPhoneNumbersRequest.Builder,ListPhoneNumbersRequest>

  • Method Details

    • status

      public final PhoneNumberStatus status()

      The phone number status.

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

      Returns:
      The phone number status.
      See Also:

    • statusAsString

      public final String statusAsString()

      The phone number status.

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

      Returns:
      The phone number status.
      See Also:

    • productType

      public final PhoneNumberProductType productType()

      The phone number product type.

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

      Returns:
      The phone number product type.
      See Also:

    • productTypeAsString

      public final String productTypeAsString()

      The phone number product type.

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

      Returns:
      The phone number product type.
      See Also:

    • filterName

      public final PhoneNumberAssociationName filterName()

      The filter to use to limit the number of results.

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

      Returns:
      The filter to use to limit the number of results.
      See Also:

    • filterNameAsString

      public final String filterNameAsString()

      The filter to use to limit the number of results.

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

      Returns:
      The filter to use to limit the number of results.
      See Also:

    • filterValue

      public final String filterValue()

      The value to use for the filter.

      Returns:
      The value to use for the filter.

    • 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 to use to retrieve the next page of results.

      Returns:
      The token to use to retrieve the next page of results.

    • toBuilder

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

    • builder

      public static ListPhoneNumbersRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListPhoneNumbersRequest.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.