java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.pinpointsmsvoicev2.model.PinpointSmsVoiceV2Request
    - - software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribePhoneNumbersRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribePhoneNumbersRequest.Builder,DescribePhoneNumbersRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DescribePhoneNumbersRequest
extends PinpointSmsVoiceV2Request
implements ToCopyableBuilder<DescribePhoneNumbersRequest.Builder,DescribePhoneNumbersRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DescribePhoneNumbersRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DescribePhoneNumbersRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<PhoneNumberFilter>`	`filters()`	An array of PhoneNumberFilter objects to filter the results.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasFilters()`	For responses, this returns true if the service returned a value for the Filters property.
`int`	`hashCode()`
`boolean`	`hasPhoneNumberIds()`	For responses, this returns true if the service returned a value for the PhoneNumberIds property.
`Integer`	`maxResults()`	The maximum number of results to return per each request.
`String`	`nextToken()`	The token to be used for the next set of paginated results.
`Owner`	`owner()`	Use `SELF` to filter the list of phone numbers to ones your account owns or use `SHARED` to filter on phone numbers shared with your account.
`String`	`ownerAsString()`	Use `SELF` to filter the list of phone numbers to ones your account owns or use `SHARED` to filter on phone numbers shared with your account.
`List<String>`	`phoneNumberIds()`	The unique identifier of phone numbers to find information about.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribePhoneNumbersRequest.Builder>`	`serializableBuilderClass()`
`DescribePhoneNumbersRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - hasPhoneNumberIds
```
public final boolean hasPhoneNumberIds()
```
    For responses, this returns true if the service returned a value for the PhoneNumberIds property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - phoneNumberIds
```
public final List<String> phoneNumberIds()
```
    The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.
    
    If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
    
    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 hasPhoneNumberIds() method.
    
    Returns:
    
    The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.
    
    If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
  - hasFilters
```
public final boolean hasFilters()
```
    For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - filters
```
public final List<PhoneNumberFilter> filters()
```
    An array of PhoneNumberFilter objects to filter the results.
    
    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 hasFilters() method.
    
    Returns:
    
    An array of PhoneNumberFilter objects to filter the results.
  - nextToken
```
public final String nextToken()
```
    The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
    
    Returns:
    
    The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
  - maxResults
```
public final Integer maxResults()
```
    The maximum number of results to return per each request.
    
    Returns:
    
    The maximum number of results to return per each request.
  - owner
```
public final Owner owner()
```
    Use SELF to filter the list of phone numbers to ones your account owns or use SHARED to filter on phone numbers shared with your account. The Owner and PhoneNumberIds parameters can't be used at the same time.
    
    If the service returns an enum value that is not available in the current SDK version, owner will return Owner.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ownerAsString().
    
    Returns:
    
    Use SELF to filter the list of phone numbers to ones your account owns or use SHARED to filter on phone numbers shared with your account. The Owner and PhoneNumberIds parameters can't be used at the same time.
    
    See Also:
    
    Owner
  - ownerAsString
```
public final String ownerAsString()
```
    Use SELF to filter the list of phone numbers to ones your account owns or use SHARED to filter on phone numbers shared with your account. The Owner and PhoneNumberIds parameters can't be used at the same time.
    
    If the service returns an enum value that is not available in the current SDK version, owner will return Owner.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ownerAsString().
    
    Returns:
    
    Use SELF to filter the list of phone numbers to ones your account owns or use SHARED to filter on phone numbers shared with your account. The Owner and PhoneNumberIds parameters can't be used at the same time.
    
    See Also:
    
    Owner
  - toBuilder
```
public DescribePhoneNumbersRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribePhoneNumbersRequest.Builder,DescribePhoneNumbersRequest>
    
    Specified by:
    
    toBuilder in class PinpointSmsVoiceV2Request
  - builder
```
public static DescribePhoneNumbersRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribePhoneNumbersRequest.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class DescribePhoneNumbersRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasPhoneNumberIds

phoneNumberIds

hasFilters

filters

nextToken

maxResults

owner

ownerAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField