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

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface RequestSenderIdRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static RequestSenderIdRequest.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`	`hasMessageTypes()`	For responses, this returns true if the service returned a value for the MessageTypes 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.
`List<MessageType>`	`messageTypes()`	The type of message.
`List<String>`	`messageTypesAsStrings()`	The type of message.
`List<SdkField<?>>`	`sdkFields()`
`String`	`senderId()`	The sender ID string to request.
`static Class<? extends RequestSenderIdRequest.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()`	An array of tags (key and value pairs) to associate with the sender ID.
`RequestSenderIdRequest.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
  - senderId
```
public final String senderId()
```
    The sender ID string to request.
    
    Returns:
    
    The sender ID string to request.
  - 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 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.
  - 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.
  - 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.
  - 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) to associate with the sender ID.
    
    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) to associate with the sender ID.
  - 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 RequestSenderIdRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RequestSenderIdRequest.Builder,RequestSenderIdRequest>
    
    Specified by:
    
    toBuilder in class PinpointSmsVoiceV2Request
  - builder
```
public static RequestSenderIdRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RequestSenderIdRequest.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 RequestSenderIdRequest

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

senderId

isoCountryCode

messageTypes

hasMessageTypes

messageTypesAsStrings

deletionProtectionEnabled

hasTags

tags

clientToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields