software.amazon.awssdk.services.amplifyuibuilder.model

Class CreateFormData

java.lang.Object

software.amazon.awssdk.services.amplifyuibuilder.model.CreateFormData

All Implemented Interfaces:

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

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

Represents all of the information that is required to create a form.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateFormData.Builder

Method Summary

Modifier and Type	Method and Description
static CreateFormData.Builder	builder()
FormCTA	cta() The FormCTA object that stores the call to action configuration for the form.
FormDataTypeConfig	dataType() The type of data source to use to create the form.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Map<String,FieldConfig>	fields() The configuration information for the form's fields.
FormActionType	formActionType() Specifies whether to perform a create or update action on the form.
String	formActionTypeAsString() Specifies whether to perform a create or update action on the form.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFields() For responses, this returns true if the service returned a value for the Fields property.
int	hashCode()
boolean	hasSectionalElements() For responses, this returns true if the service returned a value for the SectionalElements property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
LabelDecorator	labelDecorator() Specifies an icon or decoration to display on the form.
String	labelDecoratorAsString() Specifies an icon or decoration to display on the form.
String	name() The name of the form.
String	schemaVersion() The schema version of the form.
List<SdkField<?>>	sdkFields()
Map<String,SectionalElement>	sectionalElements() The configuration information for the visual helper elements for the form.
static Class<? extends CreateFormData.Builder>	serializableBuilderClass()
FormStyle	style() The configuration for the form's style.
Map<String,String>	tags() One or more key-value pairs to use when tagging the form data.
CreateFormData.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

name

public final String name()

The name of the form.

Returns:

The name of the form.

dataType

public final FormDataTypeConfig dataType()

The type of data source to use to create the form.

Returns:

The type of data source to use to create the form.

formActionType

public final FormActionType formActionType()

Specifies whether to perform a create or update action on the form.

If the service returns an enum value that is not available in the current SDK version, formActionType will return FormActionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formActionTypeAsString().

Returns:

Specifies whether to perform a create or update action on the form.

See Also:

FormActionType

formActionTypeAsString

public final String formActionTypeAsString()

Specifies whether to perform a create or update action on the form.

If the service returns an enum value that is not available in the current SDK version, formActionType will return FormActionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formActionTypeAsString().

Returns:

Specifies whether to perform a create or update action on the form.

See Also:

FormActionType

hasFields

public final boolean hasFields()

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

fields

public final Map<String,FieldConfig> fields()

The configuration information for the form's fields.

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

Returns:

The configuration information for the form's fields.

style

public final FormStyle style()

The configuration for the form's style.

Returns:

The configuration for the form's style.

hasSectionalElements

public final boolean hasSectionalElements()

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

sectionalElements

public final Map<String,SectionalElement> sectionalElements()

The configuration information for the visual helper elements for the form. These elements are not associated with any data.

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

Returns:

The configuration information for the visual helper elements for the form. These elements are not associated with any data.

schemaVersion

public final String schemaVersion()

The schema version of the form.

Returns:

The schema version of the form.

cta

public final FormCTA cta()

The FormCTA object that stores the call to action configuration for the form.

Returns:

The FormCTA object that stores the call to action configuration for the form.

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 Map<String,String> tags()

One or more key-value pairs to use when tagging the form data.

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:

One or more key-value pairs to use when tagging the form data.

labelDecorator

public final LabelDecorator labelDecorator()

Specifies an icon or decoration to display on the form.

If the service returns an enum value that is not available in the current SDK version, labelDecorator will return LabelDecorator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from labelDecoratorAsString().

Returns:

Specifies an icon or decoration to display on the form.

See Also:

LabelDecorator

labelDecoratorAsString

public final String labelDecoratorAsString()

Specifies an icon or decoration to display on the form.

If the service returns an enum value that is not available in the current SDK version, labelDecorator will return LabelDecorator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from labelDecoratorAsString().

Returns:

Specifies an icon or decoration to display on the form.

See Also:

LabelDecorator

toBuilder

public CreateFormData.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateFormData.Builder,CreateFormData>

builder

public static CreateFormData.Builder builder()

serializableBuilderClass

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