Package software.amazon.awssdk.services.pinpointsmsvoicev2.model

Class PutRegistrationFieldValueRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutRegistrationFieldValueRequest.Builder,PutRegistrationFieldValueRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutRegistrationFieldValueRequest.Builder

Method Summary

Modifier and Type	Method	Description
static PutRegistrationFieldValueRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fieldPath()	The path to the registration form field.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSelectChoices()	For responses, this returns true if the service returned a value for the SelectChoices property.
String	registrationAttachmentId()	The unique identifier for the registration attachment.
String	registrationId()	The unique identifier for the registration.
List<SdkField<?>>	sdkFields()
List<String>	selectChoices()	An array of values for the form field.
static Class<? extends PutRegistrationFieldValueRequest.Builder>	serializableBuilderClass()
String	textValue()	The text data for a free form field.
PutRegistrationFieldValueRequest.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

registrationId

public final String registrationId()

The unique identifier for the registration.

Returns:

The unique identifier for the registration.

fieldPath

public final String fieldPath()

The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.

Returns:

The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.

hasSelectChoices

public final boolean hasSelectChoices()

For responses, this returns true if the service returned a value for the SelectChoices 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.

selectChoices

public final List<String> selectChoices()

An array of values for the form field.

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 hasSelectChoices() method.

Returns:

An array of values for the form field.

textValue

public final String textValue()

The text data for a free form field.

Returns:

The text data for a free form field.

registrationAttachmentId

public final String registrationAttachmentId()

The unique identifier for the registration attachment.

Returns:

The unique identifier for the registration attachment.

toBuilder

public PutRegistrationFieldValueRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutRegistrationFieldValueRequest.Builder,PutRegistrationFieldValueRequest>

Specified by:

toBuilder in class PinpointSmsVoiceV2Request

builder

public static PutRegistrationFieldValueRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PutRegistrationFieldValueRequest.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