RequestPhoneNumberRequest (AWS Java SDK :: Services :: Pinpoint SMS Voice V2 2.20.110 API)

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.RequestPhoneNumberRequest

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface RequestPhoneNumberRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`RequestPhoneNumberRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static RequestPhoneNumberRequest.Builder`	`builder()`
`String`	`clientToken()` Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`Boolean`	`deletionProtectionEnabled()` By default this is set to false.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasNumberCapabilities()` For responses, this returns true if the service returned a value for the NumberCapabilities property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`String`	`isoCountryCode()` The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
`MessageType`	`messageType()` The type of message.
`String`	`messageTypeAsString()` The type of message.
`List<NumberCapability>`	`numberCapabilities()` Indicates if the phone number will be used for text messages, voice messages, or both.
`List<String>`	`numberCapabilitiesAsStrings()` Indicates if the phone number will be used for text messages, voice messages, or both.
`RequestableNumberType`	`numberType()` The type of phone number to request.
`String`	`numberTypeAsString()` The type of phone number to request.
`String`	`optOutListName()` The name of the OptOutList to associate with the phone number.
`String`	`poolId()` The pool to associated with the phone number.
`String`	`registrationId()` Use this field to attach your phone number for an external registration process.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends RequestPhoneNumberRequest.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()` An array of tags (key and value pairs) associate with the requested phone number.
`RequestPhoneNumberRequest.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
  - isoCountryCode
```
public final String isoCountryCode()
```
    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    
    Returns:
    
    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
  - messageType
```
public final MessageType messageType()
```
    The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
    
    If the service returns an enum value that is not available in the current SDK version, messageType will return MessageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from messageTypeAsString().
    
    Returns:
    
    The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
    
    See Also:
    
    MessageType
  - messageTypeAsString
```
public final String messageTypeAsString()
```
    The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
    
    If the service returns an enum value that is not available in the current SDK version, messageType will return MessageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from messageTypeAsString().
    
    Returns:
    
    The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
    
    See Also:
    
    MessageType
  - numberCapabilities
```
public final List<NumberCapability> numberCapabilities()
```
    Indicates if the phone number will be used for text messages, voice messages, or both.
    
    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 hasNumberCapabilities() method.
    
    Returns:
    
    Indicates if the phone number will be used for text messages, voice messages, or both.
  - hasNumberCapabilities
```
public final boolean hasNumberCapabilities()
```
    For responses, this returns true if the service returned a value for the NumberCapabilities 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.
  - numberCapabilitiesAsStrings
```
public final List<String> numberCapabilitiesAsStrings()
```
    Indicates if the phone number will be used for text messages, voice messages, or both.
    
    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 hasNumberCapabilities() method.
    
    Returns:
    
    Indicates if the phone number will be used for text messages, voice messages, or both.
  - numberType
```
public final RequestableNumberType numberType()
```
    The type of phone number to request.
    
    If the service returns an enum value that is not available in the current SDK version, numberType will return RequestableNumberType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from numberTypeAsString().
    
    Returns:
    
    The type of phone number to request.
    
    See Also:
    
    RequestableNumberType
  - numberTypeAsString
```
public final String numberTypeAsString()
```
    The type of phone number to request.
    
    If the service returns an enum value that is not available in the current SDK version, numberType will return RequestableNumberType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from numberTypeAsString().
    
    Returns:
    
    The type of phone number to request.
    
    See Also:
    
    RequestableNumberType
  - optOutListName
```
public final String optOutListName()
```
    The name of the OptOutList to associate with the phone number. You can use the OutOutListName or OptPutListArn.
    
    Returns:
    
    The name of the OptOutList to associate with the phone number. You can use the OutOutListName or OptPutListArn.
  - poolId
```
public final String poolId()
```
    The pool to associated with the phone number. You can use the PoolId or PoolArn.
    
    Returns:
    
    The pool to associated with the phone number. You can use the PoolId or PoolArn.
  - registrationId
```
public final String registrationId()
```
    Use this field to attach your phone number for an external registration process.
    
    Returns:
    
    Use this field to attach your phone number for an external registration process.
  - deletionProtectionEnabled
```
public final Boolean deletionProtectionEnabled()
```
    By default this is set to false. When set to true the phone number can't be deleted.
    
    Returns:
    
    By default this is set to false. When set to true the phone number can't be deleted.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags 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.
  - tags
```
public final List<Tag> tags()
```
    An array of tags (key and value pairs) associate with the requested phone number.
    
    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 hasTags() method.
    
    Returns:
    
    An array of tags (key and value pairs) associate with the requested phone number.
  - clientToken
```
public final String clientToken()
```
    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
    
    Returns:
    
    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
  - toBuilder
```
public RequestPhoneNumberRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RequestPhoneNumberRequest.Builder,RequestPhoneNumberRequest>
    
    Specified by:
    
    toBuilder in class PinpointSmsVoiceV2Request
  - builder
```
public static RequestPhoneNumberRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RequestPhoneNumberRequest.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

Class RequestPhoneNumberRequest

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

isoCountryCode

messageType

messageTypeAsString

numberCapabilities

hasNumberCapabilities

numberCapabilitiesAsStrings

numberType

numberTypeAsString

optOutListName

poolId

registrationId

deletionProtectionEnabled

hasTags

tags

clientToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields