Package software.amazon.awssdk.services.chime.model

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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SearchAvailablePhoneNumbersRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	areaCode()	The area code used to filter results.
static SearchAvailablePhoneNumbersRequest.Builder	builder()
String	city()	The city used to filter results.
String	country()	The country used to filter results.
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 in a single call.
String	nextToken()	The token used to retrieve the next page of results.
PhoneNumberType	phoneNumberType()	The phone number type used to filter results.
String	phoneNumberTypeAsString()	The phone number type used to filter results.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends SearchAvailablePhoneNumbersRequest.Builder>	serializableBuilderClass()
String	state()	The state used to filter results.
SearchAvailablePhoneNumbersRequest.Builder	toBuilder()
String	tollFreePrefix()	The toll-free prefix that you use to filter results.
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()

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:

PhoneNumberType

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:

PhoneNumberType

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()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchAvailablePhoneNumbersRequest.Builder,SearchAvailablePhoneNumbersRequest>

Specified by:

toBuilder in class ChimeRequest

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