Class SenderIdInformation
- java.lang.Object
-
- software.amazon.awssdk.services.pinpointsmsvoicev2.model.SenderIdInformation
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<SenderIdInformation.Builder,SenderIdInformation>
@Generated("software.amazon.awssdk:codegen") public final class SenderIdInformation extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SenderIdInformation.Builder,SenderIdInformation>
The information for all SenderIds in an Amazon Web Services account.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceSenderIdInformation.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SenderIdInformation.Builderbuilder()BooleandeletionProtectionEnabled()By default this is set to false.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasMessageTypes()For responses, this returns true if the service returned a value for the MessageTypes property.StringisoCountryCode()The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.List<MessageType>messageTypes()The type of message.List<String>messageTypesAsStrings()The type of message.StringmonthlyLeasingPrice()The monthly leasing price, in US dollars.Booleanregistered()True if the sender ID is registered.StringregistrationId()The unique identifier for the registration.List<SdkField<?>>sdkFields()StringsenderId()The alphanumeric sender ID in a specific country that you'd like to describe.StringsenderIdArn()The Amazon Resource Name (ARN) associated with the SenderId.static Class<? extends SenderIdInformation.Builder>serializableBuilderClass()SenderIdInformation.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
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
-
senderIdArn
public final String senderIdArn()
The Amazon Resource Name (ARN) associated with the SenderId.
- Returns:
- The Amazon Resource Name (ARN) associated with the SenderId.
-
senderId
public final String senderId()
The alphanumeric sender ID in a specific country that you'd like to describe.
- Returns:
- The alphanumeric sender ID in a specific country that you'd like to describe.
-
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.
-
messageTypes
public final List<MessageType> messageTypes()
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.
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
hasMessageTypes()method.- 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.
-
hasMessageTypes
public final boolean hasMessageTypes()
For responses, this returns true if the service returned a value for the MessageTypes 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.
-
messageTypesAsStrings
public final List<String> messageTypesAsStrings()
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.
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
hasMessageTypes()method.- 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.
-
monthlyLeasingPrice
public final String monthlyLeasingPrice()
The monthly leasing price, in US dollars.
- Returns:
- The monthly leasing price, in US dollars.
-
deletionProtectionEnabled
public final Boolean deletionProtectionEnabled()
By default this is set to false. When set to true the sender ID can't be deleted.
- Returns:
- By default this is set to false. When set to true the sender ID can't be deleted.
-
registered
public final Boolean registered()
True if the sender ID is registered.
- Returns:
- True if the sender ID is registered.
-
registrationId
public final String registrationId()
The unique identifier for the registration.
- Returns:
- The unique identifier for the registration.
-
toBuilder
public SenderIdInformation.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<SenderIdInformation.Builder,SenderIdInformation>
-
builder
public static SenderIdInformation.Builder builder()
-
serializableBuilderClass
public static Class<? extends SenderIdInformation.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-