Package software.amazon.awssdk.services.connect.model

Class SearchAvailablePhoneNumbersRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.connect.model.ConnectRequest

software.amazon.awssdk.services.connect.model.SearchAvailablePhoneNumbersRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SearchAvailablePhoneNumbersRequest.Builder,SearchAvailablePhoneNumbersRequest>

@Generated("software.amazon.awssdk:codegen")
public final class SearchAvailablePhoneNumbersRequest
extends ConnectRequest
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
static SearchAvailablePhoneNumbersRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	instanceId()	The identifier of the Amazon Connect instance that phone numbers are claimed to.
Integer	maxResults()	The maximum number of results to return per page.
String	nextToken()	The token for the next set of results.
PhoneNumberCountryCode	phoneNumberCountryCode()	The ISO country code.
String	phoneNumberCountryCodeAsString()	The ISO country code.
String	phoneNumberPrefix()	The prefix of the phone number.
PhoneNumberType	phoneNumberType()	The type of phone number.
String	phoneNumberTypeAsString()	The type of phone number.
List<SdkField<?>>	sdkFields()
static Class<? extends SearchAvailablePhoneNumbersRequest.Builder>	serializableBuilderClass()
String	targetArn()	The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through.
SearchAvailablePhoneNumbersRequest.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

targetArn

public final String targetArn()

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter InstanceId or TargetArn.

Returns:

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter InstanceId or TargetArn.

instanceId

public final String instanceId()

The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or TargetArn.

Returns:

The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or TargetArn.

phoneNumberCountryCode

public final PhoneNumberCountryCode phoneNumberCountryCode()

The ISO country code.

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

Returns:

The ISO country code.

See Also:

PhoneNumberCountryCode

phoneNumberCountryCodeAsString

public final String phoneNumberCountryCodeAsString()

The ISO country code.

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

Returns:

The ISO country code.

See Also:

PhoneNumberCountryCode

phoneNumberType

public final PhoneNumberType phoneNumberType()

The type of phone number.

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 type of phone number.

See Also:

PhoneNumberType

phoneNumberTypeAsString

public final String phoneNumberTypeAsString()

The type of phone number.

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 type of phone number.

See Also:

PhoneNumberType

phoneNumberPrefix

public final String phoneNumberPrefix()

The prefix of the phone number. If provided, it must contain + as part of the country code.

Returns:

The prefix of the phone number. If provided, it must contain + as part of the country code.

maxResults

public final Integer maxResults()

The maximum number of results to return per page.

Returns:

The maximum number of results to return per page.

nextToken

public final String nextToken()

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

toBuilder

public SearchAvailablePhoneNumbersRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchAvailablePhoneNumbersRequest.Builder,SearchAvailablePhoneNumbersRequest>

Specified by:

toBuilder in class ConnectRequest

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