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

Interface SearchAvailablePhoneNumbersRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, ChimeRequest.Builder, CopyableBuilder<SearchAvailablePhoneNumbersRequest.Builder,SearchAvailablePhoneNumbersRequest>, SdkBuilder<SearchAvailablePhoneNumbersRequest.Builder,SearchAvailablePhoneNumbersRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

SearchAvailablePhoneNumbersRequest

public static interface SearchAvailablePhoneNumbersRequest.Builder
extends ChimeRequest.Builder, SdkPojo, CopyableBuilder<SearchAvailablePhoneNumbersRequest.Builder,SearchAvailablePhoneNumbersRequest>

Method Summary

Modifier and Type	Method	Description
SearchAvailablePhoneNumbersRequest.Builder	areaCode(String areaCode)	The area code used to filter results.
SearchAvailablePhoneNumbersRequest.Builder	city(String city)	The city used to filter results.
SearchAvailablePhoneNumbersRequest.Builder	country(String country)	The country used to filter results.
SearchAvailablePhoneNumbersRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return in a single call.
SearchAvailablePhoneNumbersRequest.Builder	nextToken(String nextToken)	The token used to retrieve the next page of results.
SearchAvailablePhoneNumbersRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
SearchAvailablePhoneNumbersRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
SearchAvailablePhoneNumbersRequest.Builder	phoneNumberType(String phoneNumberType)	The phone number type used to filter results.
SearchAvailablePhoneNumbersRequest.Builder	phoneNumberType(PhoneNumberType phoneNumberType)	The phone number type used to filter results.
SearchAvailablePhoneNumbersRequest.Builder	state(String state)	The state used to filter results.
SearchAvailablePhoneNumbersRequest.Builder	tollFreePrefix(String tollFreePrefix)	The toll-free prefix that you use to filter results.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.chime.model.ChimeRequest.Builder

build

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Details

areaCode

SearchAvailablePhoneNumbersRequest.Builder areaCode(String areaCode)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

city

SearchAvailablePhoneNumbersRequest.Builder city(String city)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

country

SearchAvailablePhoneNumbersRequest.Builder country(String country)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

state

SearchAvailablePhoneNumbersRequest.Builder state(String state)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

tollFreePrefix

SearchAvailablePhoneNumbersRequest.Builder tollFreePrefix(String tollFreePrefix)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

phoneNumberType

SearchAvailablePhoneNumbersRequest.Builder phoneNumberType(String phoneNumberType)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• PhoneNumberType
• PhoneNumberType

phoneNumberType

SearchAvailablePhoneNumbersRequest.Builder phoneNumberType(PhoneNumberType phoneNumberType)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• PhoneNumberType
• PhoneNumberType

maxResults

SearchAvailablePhoneNumbersRequest.Builder maxResults(Integer maxResults)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

nextToken

SearchAvailablePhoneNumbersRequest.Builder nextToken(String nextToken)

The token used to retrieve the next page of results.

Parameters:

nextToken - The token used to retrieve the next page of results.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

SearchAvailablePhoneNumbersRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

SearchAvailablePhoneNumbersRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.