Class UpdatePhoneNumberResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdatePhoneNumberResponse.Builder,
UpdatePhoneNumberResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Instant
The time when the phone number was created, in UNIX epoch time format.final Boolean
When set to true the phone number can't be deleted.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the NumberCapabilities property.final String
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.final MessageType
The type of message.final String
The type of message.final String
The monthly leasing price of the phone number, in US dollars.final List
<NumberCapability> Specifies if the number could be used for text messages, voice or both.Specifies if the number could be used for text messages, voice or both.final NumberType
The type of number that was requested.final String
The type of number that was requested.final String
The name of the OptOutList associated with the phone number.final String
The phone number that was updated.final String
The Amazon Resource Name (ARN) of the updated phone number.final String
The unique identifier of the phone number.final String
The unique identifier for the registration.final Boolean
This is true if self managed opt-out are enabled.static Class
<? extends UpdatePhoneNumberResponse.Builder> final NumberStatus
status()
The current status of the request.final String
The current status of the request.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The Amazon Resource Name (ARN) of the two way channel.final String
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.final Boolean
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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
phoneNumberArn
The Amazon Resource Name (ARN) of the updated phone number.
- Returns:
- The Amazon Resource Name (ARN) of the updated phone number.
-
phoneNumberId
The unique identifier of the phone number.
- Returns:
- The unique identifier of the phone number.
-
phoneNumber
The phone number that was updated.
- Returns:
- The phone number that was updated.
-
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 returnNumberStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the request.
- See Also:
-
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 returnNumberStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the request.
- See Also:
-
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
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 returnMessageType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommessageTypeAsString()
.- 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:
-
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 returnMessageType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommessageTypeAsString()
.- 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:
-
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 theisEmpty()
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
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
The type of number that was requested.
If the service returns an enum value that is not available in the current SDK version,
numberType
will returnNumberType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnumberTypeAsString()
.- Returns:
- The type of number that was requested.
- See Also:
-
numberTypeAsString
The type of number that was requested.
If the service returns an enum value that is not available in the current SDK version,
numberType
will returnNumberType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnumberTypeAsString()
.- Returns:
- The type of number that was requested.
- See Also:
-
monthlyLeasingPrice
The monthly leasing price of the phone number, in US dollars.
- Returns:
- The monthly leasing price of the phone number, in US dollars.
-
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
The Amazon Resource Name (ARN) of the two way channel.
- Returns:
- The Amazon Resource Name (ARN) of the two way channel.
-
twoWayChannelRole
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
- Returns:
- An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
-
selfManagedOptOutsEnabled
This is true if self managed opt-out are enabled.
- Returns:
- This is true if self managed opt-out are enabled.
-
optOutListName
The name of the OptOutList associated with the phone number.
- Returns:
- The name of the OptOutList associated with the phone number.
-
deletionProtectionEnabled
When set to true the phone number can't be deleted.
- Returns:
- When set to true the phone number can't be deleted.
-
registrationId
The unique identifier for the registration.
- Returns:
- The unique identifier for the registration.
-
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<UpdatePhoneNumberResponse.Builder,
UpdatePhoneNumberResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-