ReleasePhoneNumberResponse (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.ReleasePhoneNumberResponse

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ReleasePhoneNumberResponse.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ReleasePhoneNumberResponse.Builder`	`builder()`
`Instant`	`createdTimestamp()` The time when the phone number was created, in UNIX epoch time format.
`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.
`String`	`isoCountryCode()` The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
`MessageType`	`messageType()` The message type that was associated with the phone number.
`String`	`messageTypeAsString()` The message type that was associated with the phone number.
`String`	`monthlyLeasingPrice()` The monthly price of the phone number, in US dollars.
`List<NumberCapability>`	`numberCapabilities()` Specifies if the number could be used for text messages, voice, or both.
`List<String>`	`numberCapabilitiesAsStrings()` Specifies if the number could be used for text messages, voice, or both.
`NumberType`	`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 was associated with the phone number.
`String`	`phoneNumber()` The phone number that was released.
`String`	`phoneNumberArn()` The PhoneNumberArn of the phone number that was released.
`String`	`phoneNumberId()` The PhoneNumberId of the phone number that was released.
`List<SdkField<?>>`	`sdkFields()`
`Boolean`	`selfManagedOptOutsEnabled()` By default this is set to false.
`static Class<? extends ReleasePhoneNumberResponse.Builder>`	`serializableBuilderClass()`
`NumberStatus`	`status()` The current status of the request.
`String`	`statusAsString()` The current status of the request.
`ReleasePhoneNumberResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`twoWayChannelArn()` The Amazon Resource Name (ARN) of the TwoWayChannel.
`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 PhoneNumberArn of the phone number that was released.
    
    Returns:
    
    The PhoneNumberArn of the phone number that was released.
  - phoneNumberId
```
public final String phoneNumberId()
```
    The PhoneNumberId of the phone number that was released.
    
    Returns:
    
    The PhoneNumberId of the phone number that was released.
  - phoneNumber
```
public final String phoneNumber()
```
    The phone number that was released.
    
    Returns:
    
    The phone number that was released.
  - 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 message type that was associated with the phone number.
    
    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 message type that was associated with the phone number.
    
    See Also:
    
    MessageType
  - messageTypeAsString
```
public final String messageTypeAsString()
```
    The message type that was associated with the phone number.
    
    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 message type that was associated with the phone number.
    
    See Also:
    
    MessageType
  - numberCapabilities
```
public final List<NumberCapability> numberCapabilities()
```
    Specifies if the number could be used for text messages, voice, 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:
    
    Specifies if the number could be used for text messages, voice, 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()
```
    Specifies if the number could be used for text messages, voice, 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:
    
    Specifies if the number could be used for text messages, voice, or both.
  - numberType
```
public final NumberType 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 NumberType.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:
    
    NumberType
  - 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 NumberType.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:
    
    NumberType
  - monthlyLeasingPrice
```
public final String monthlyLeasingPrice()
```
    The monthly price of the phone number, in US dollars.
    
    Returns:
    
    The monthly price of the phone number, in US dollars.
  - 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 Amazon Resource Name (ARN) of the TwoWayChannel.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the TwoWayChannel.
  - 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 was associated with the phone number.
    
    Returns:
    
    The name of the OptOutList that was 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 ReleasePhoneNumberResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ReleasePhoneNumberResponse.Builder,ReleasePhoneNumberResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static ReleasePhoneNumberResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ReleasePhoneNumberResponse.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 ReleasePhoneNumberResponse

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

createdTimestamp

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields