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

Class DescribeRegistrationFieldDefinitionsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeRegistrationFieldDefinitionsRequest.Builder,DescribeRegistrationFieldDefinitionsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeRegistrationFieldDefinitionsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeRegistrationFieldDefinitionsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	fieldPaths()	An array of paths to the registration form field.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFieldPaths()	For responses, this returns true if the service returned a value for the FieldPaths property.
int	hashCode()
Integer	maxResults()	The maximum number of results to return per each request.
String	nextToken()	The token to be used for the next set of paginated results.
String	registrationType()	The type of registration form.
List<SdkField<?>>	sdkFields()
String	sectionPath()	The path to the section of the registration.
static Class<? extends DescribeRegistrationFieldDefinitionsRequest.Builder>	serializableBuilderClass()
DescribeRegistrationFieldDefinitionsRequest.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

registrationType

public final String registrationType()

The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

Returns:

The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

sectionPath

public final String sectionPath()

The path to the section of the registration.

Returns:

The path to the section of the registration.

hasFieldPaths

public final boolean hasFieldPaths()

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

fieldPaths

public final List<String> fieldPaths()

An array of paths to the registration 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 hasFieldPaths() method.

Returns:

An array of paths to the registration form field.

nextToken

public final String nextToken()

The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

Returns:

The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

maxResults

public final Integer maxResults()

The maximum number of results to return per each request.

Returns:

The maximum number of results to return per each request.

toBuilder

public DescribeRegistrationFieldDefinitionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeRegistrationFieldDefinitionsRequest.Builder,DescribeRegistrationFieldDefinitionsRequest>

Specified by:

toBuilder in class PinpointSmsVoiceV2Request

builder

public static DescribeRegistrationFieldDefinitionsRequest.Builder builder()

serializableBuilderClass

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