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

Class RegistrationFieldDisplayHints

java.lang.Object

software.amazon.awssdk.services.pinpointsmsvoicev2.model.RegistrationFieldDisplayHints

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RegistrationFieldDisplayHints.Builder,RegistrationFieldDisplayHints>

@Generated("software.amazon.awssdk:codegen")
public final class RegistrationFieldDisplayHints
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RegistrationFieldDisplayHints.Builder,RegistrationFieldDisplayHints>

Provides help information on the registration field.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RegistrationFieldDisplayHints.Builder

Method Summary

Modifier and Type	Method	Description
static RegistrationFieldDisplayHints.Builder	builder()
String	documentationLink()	The link to the document the display hint is associated with.
String	documentationTitle()	The title of the document the display hint is associated with.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	exampleTextValue()	Example text of what the value of a field should contain.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSelectOptionDescriptions()	For responses, this returns true if the service returned a value for the SelectOptionDescriptions property.
String	longDescription()	A full description of the display hint.
List<SdkField<?>>	sdkFields()
List<SelectOptionDescription>	selectOptionDescriptions()	An array of SelectOptionDescription objects.
static Class<? extends RegistrationFieldDisplayHints.Builder>	serializableBuilderClass()
String	shortDescription()	A short description of the display hint.
String	textValidationDescription()	The validation rules for the text field.
String	title()	The title of the display hint.
RegistrationFieldDisplayHints.Builder	toBuilder()
String	toString()	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

title

public final String title()

The title of the display hint.

Returns:

The title of the display hint.

shortDescription

public final String shortDescription()

A short description of the display hint.

Returns:

A short description of the display hint.

longDescription

public final String longDescription()

A full description of the display hint.

Returns:

A full description of the display hint.

documentationTitle

public final String documentationTitle()

The title of the document the display hint is associated with.

Returns:

The title of the document the display hint is associated with.

documentationLink

public final String documentationLink()

The link to the document the display hint is associated with.

Returns:

The link to the document the display hint is associated with.

hasSelectOptionDescriptions

public final boolean hasSelectOptionDescriptions()

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

selectOptionDescriptions

public final List<SelectOptionDescription> selectOptionDescriptions()

An array of SelectOptionDescription objects.

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

Returns:

An array of SelectOptionDescription objects.

textValidationDescription

public final String textValidationDescription()

The validation rules for the text field.

Returns:

The validation rules for the text field.

exampleTextValue

public final String exampleTextValue()

Example text of what the value of a field should contain.

Returns:

Example text of what the value of a field should contain.

toBuilder

public RegistrationFieldDisplayHints.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RegistrationFieldDisplayHints.Builder,RegistrationFieldDisplayHints>

builder

public static RegistrationFieldDisplayHints.Builder builder()

serializableBuilderClass

public static Class<? extends RegistrationFieldDisplayHints.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo