java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.chimesdkvoice.model.ChimeSdkVoiceRequest
    - - software.amazon.awssdk.services.chimesdkvoice.model.SearchAvailablePhoneNumbersRequest

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface SearchAvailablePhoneNumbersRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`areaCode()`	Confines a search to just the phone numbers associated with the specified area code.
`static SearchAvailablePhoneNumbersRequest.Builder`	`builder()`
`String`	`city()`	Confines a search to just the phone numbers associated with the specified city.
`String`	`country()`	Confines a search to just the phone numbers associated with the specified country.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Integer`	`maxResults()`	The maximum number of results to return.
`String`	`nextToken()`	The token used to return the next page of results.
`PhoneNumberType`	`phoneNumberType()`	Confines a search to just the phone numbers associated with the specified phone number type, either local or toll-free.
`String`	`phoneNumberTypeAsString()`	Confines a search to just the phone numbers associated with the specified phone number type, either local or toll-free.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends SearchAvailablePhoneNumbersRequest.Builder>`	`serializableBuilderClass()`
`String`	`state()`	Confines a search to just the phone numbers associated with the specified state.
`SearchAvailablePhoneNumbersRequest.Builder`	`toBuilder()`
`String`	`tollFreePrefix()`	Confines a search to just the phone numbers associated with the specified toll-free prefix.
`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
  - areaCode
```
public final String areaCode()
```
    Confines a search to just the phone numbers associated with the specified area code.
    
    Returns:
    
    Confines a search to just the phone numbers associated with the specified area code.
  - city
```
public final String city()
```
    Confines a search to just the phone numbers associated with the specified city.
    
    Returns:
    
    Confines a search to just the phone numbers associated with the specified city.
  - country
```
public final String country()
```
    Confines a search to just the phone numbers associated with the specified country.
    
    Returns:
    
    Confines a search to just the phone numbers associated with the specified country.
  - state
```
public final String state()
```
    Confines a search to just the phone numbers associated with the specified state.
    
    Returns:
    
    Confines a search to just the phone numbers associated with the specified state.
  - tollFreePrefix
```
public final String tollFreePrefix()
```
    Confines a search to just the phone numbers associated with the specified toll-free prefix.
    
    Returns:
    
    Confines a search to just the phone numbers associated with the specified toll-free prefix.
  - phoneNumberType
```
public final PhoneNumberType phoneNumberType()
```
    Confines a search to just the phone numbers associated with the specified phone number type, either local or toll-free.
    
    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:
    
    Confines a search to just the phone numbers associated with the specified phone number type, either local or toll-free.
    
    See Also:
    
    PhoneNumberType
  - phoneNumberTypeAsString
```
public final String phoneNumberTypeAsString()
```
    Confines a search to just the phone numbers associated with the specified phone number type, either local or toll-free.
    
    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:
    
    Confines a search to just the phone numbers associated with the specified phone number type, either local or toll-free.
    
    See Also:
    
    PhoneNumberType
  - maxResults
```
public final Integer maxResults()
```
    The maximum number of results to return.
    
    Returns:
    
    The maximum number of results to return.
  - nextToken
```
public final String nextToken()
```
    The token used to return the next page of results.
    
    Returns:
    
    The token used to return the next page of results.
  - toBuilder
```
public SearchAvailablePhoneNumbersRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SearchAvailablePhoneNumbersRequest.Builder,SearchAvailablePhoneNumbersRequest>
    
    Specified by:
    
    toBuilder in class ChimeSdkVoiceRequest
  - 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)
```
    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 SearchAvailablePhoneNumbersRequest

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

areaCode

city

country

state

tollFreePrefix

phoneNumberType

phoneNumberTypeAsString

maxResults

nextToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField