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

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.pinpointsmsvoicev2.model.PinpointSmsVoiceV2Response
    - - software.amazon.awssdk.services.pinpointsmsvoicev2.model.RequestPhoneNumberResponse

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface RequestPhoneNumberResponse.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static RequestPhoneNumberResponse.Builder`	`builder()`
`Instant`	`createdTimestamp()` The time when the phone number was created, in UNIX epoch time format.
`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.
`String`	`monthlyLeasingPrice()` The monthly price, in US dollars, to lease the phone number.
`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 number that was released.
`String`	`numberTypeAsString()` The type of number that was released.
`String`	`optOutListName()` The name of the OptOutList that is associated with the requested phone number.
`String`	`phoneNumber()` The new phone number that was requested.
`String`	`phoneNumberArn()` The Amazon Resource Name (ARN) of the requested phone number.
`String`	`phoneNumberId()` The unique identifier of the new phone number.
`String`	`poolId()` The unique identifier of the pool associated with the phone number
`List<SdkField<?>>`	`sdkFields()`
`Boolean`	`selfManagedOptOutsEnabled()` By default this is set to false.
`static Class<? extends RequestPhoneNumberResponse.Builder>`	`serializableBuilderClass()`
`NumberStatus`	`status()` The current status of the request.
`String`	`statusAsString()` The current status of the request.
`List<Tag>`	`tags()` An array of key and value pair tags that are associated with the phone number.
`RequestPhoneNumberResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`twoWayChannelArn()` The ARN used to identify the two way channel.
`Boolean`	`twoWayEnabled()` By default this is set to false.

Methods inherited from class software.amazon.awssdk.services.pinpointsmsvoicev2.model.PinpointSmsVoiceV2Response
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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
  - phoneNumberArn
```
public final String phoneNumberArn()
```
    The Amazon Resource Name (ARN) of the requested phone number.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the requested phone number.
  - phoneNumberId
```
public final String phoneNumberId()
```
    The unique identifier of the new phone number.
    
    Returns:
    
    The unique identifier of the new phone number.
  - phoneNumber
```
public final String phoneNumber()
```
    The new phone number that was requested.
    
    Returns:
    
    The new phone number that was requested.
  - status
```
public final NumberStatus status()
```
    The current status of the request.
    
    If the service returns an enum value that is not available in the current SDK version, status will return NumberStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The current status of the request.
    
    See Also:
    
    NumberStatus
  - statusAsString
```
public final String statusAsString()
```
    The current status of the request.
    
    If the service returns an enum value that is not available in the current SDK version, status will return NumberStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The current status of the request.
    
    See Also:
    
    NumberStatus
  - 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 number that was released.
    
    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 number that was released.
    
    See Also:
    
    RequestableNumberType
  - numberTypeAsString
```
public final String numberTypeAsString()
```
    The type of number that was released.
    
    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 number that was released.
    
    See Also:
    
    RequestableNumberType
  - monthlyLeasingPrice
```
public final String monthlyLeasingPrice()
```
    The monthly price, in US dollars, to lease the phone number.
    
    Returns:
    
    The monthly price, in US dollars, to lease the phone number.
  - twoWayEnabled
```
public final Boolean twoWayEnabled()
```
    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
    
    Returns:
    
    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
  - twoWayChannelArn
```
public final String twoWayChannelArn()
```
    The ARN used to identify the two way channel.
    
    Returns:
    
    The ARN used to identify the two way channel.
  - selfManagedOptOutsEnabled
```
public final Boolean selfManagedOptOutsEnabled()
```
    By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
    
    Returns:
    
    By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
  - optOutListName
```
public final String optOutListName()
```
    The name of the OptOutList that is associated with the requested phone number.
    
    Returns:
    
    The name of the OptOutList that is associated with the requested phone number.
  - 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.
  - poolId
```
public final String poolId()
```
    The unique identifier of the pool associated with the phone number
    
    Returns:
    
    The unique identifier of the pool associated with the phone number
  - 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 key and value pair tags that are associated with the 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 key and value pair tags that are associated with the phone number.
  - createdTimestamp
```
public final Instant createdTimestamp()
```
    The time when the phone number was created, in UNIX epoch time format.
    
    Returns:
    
    The time when the phone number was created, in UNIX epoch time format.
  - toBuilder
```
public RequestPhoneNumberResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RequestPhoneNumberResponse.Builder,RequestPhoneNumberResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static RequestPhoneNumberResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RequestPhoneNumberResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - 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 SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class RequestPhoneNumberResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.pinpointsmsvoicev2.model.PinpointSmsVoiceV2Response

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

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

Method Detail

phoneNumberArn

phoneNumberId

phoneNumber

status

statusAsString

isoCountryCode

messageType

messageTypeAsString

numberCapabilities

hasNumberCapabilities

numberCapabilitiesAsStrings

numberType

numberTypeAsString

monthlyLeasingPrice

twoWayEnabled

twoWayChannelArn

selfManagedOptOutsEnabled

optOutListName

deletionProtectionEnabled

poolId

hasTags

tags

createdTimestamp

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields