Form (AWS Java SDK :: Services :: Amplify UI Builder 2.21.17 API)

java.lang.Object
- software.amazon.awssdk.services.amplifyuibuilder.model.Form

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Form.Builder,Form>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class Form
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Form.Builder,Form>
```
Contains the configuration settings for a Form user interface (UI) element for an Amplify app. A form is a component you can add to your project by specifying a data source as the default configuration for the form.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Form.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Form.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`appId()` The unique ID of the Amplify app associated with the form.
`static Form.Builder`	`builder()`
`FormCTA`	`cta()` Stores the call to action configuration for the form.
`FormDataTypeConfig`	`dataType()` The type of data source to use to create the form.
`String`	`environmentName()` The name of the backend environment that is a part of the Amplify app.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Map<String,FieldConfig>`	`fields()` Stores the information about the form's fields.
`FormActionType`	`formActionType()` The operation to perform on the specified form.
`String`	`formActionTypeAsString()` The operation to perform on the specified 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.
`String`	`id()` The unique ID of the form.
`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 when it was imported.
`List<SdkField<?>>`	`sdkFields()`
`Map<String,SectionalElement>`	`sectionalElements()` Stores the visual helper elements for the form that are not associated with any data.
`static Class<? extends Form.Builder>`	`serializableBuilderClass()`
`FormStyle`	`style()` Stores the configuration for the form's style.
`Map<String,String>`	`tags()` One or more key-value pairs to use when tagging the form.
`Form.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
  - appId
```
public final String appId()
```
    The unique ID of the Amplify app associated with the form.
    
    Returns:
    
    The unique ID of the Amplify app associated with the form.
  - environmentName
```
public final String environmentName()
```
    The name of the backend environment that is a part of the Amplify app.
    
    Returns:
    
    The name of the backend environment that is a part of the Amplify app.
  - id
```
public final String id()
```
    The unique ID of the form.
    
    Returns:
    
    The unique ID of the form.
  - name
```
public final String name()
```
    The name of the form.
    
    Returns:
    
    The name of the form.
  - formActionType
```
public final FormActionType formActionType()
```
    The operation to perform on the specified 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:
    
    The operation to perform on the specified form.
    
    See Also:
    
    FormActionType
  - formActionTypeAsString
```
public final String formActionTypeAsString()
```
    The operation to perform on the specified 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:
    
    The operation to perform on the specified form.
    
    See Also:
    
    FormActionType
  - style
```
public final FormStyle style()
```
    Stores the configuration for the form's style.
    
    Returns:
    
    Stores the configuration for the form's style.
  - 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.
  - 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()
```
    Stores the information about 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:
    
    Stores the information about the form's fields.
  - 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()
```
    Stores the visual helper elements for the form that 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:
    
    Stores the visual helper elements for the form that are not associated with any data.
  - schemaVersion
```
public final String schemaVersion()
```
    The schema version of the form when it was imported.
    
    Returns:
    
    The schema version of the form when it was imported.
  - 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.
    
    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.
  - cta
```
public final FormCTA cta()
```
    Stores the call to action configuration for the form.
    
    Returns:
    
    Stores the call to action configuration for the form.
  - 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 Form.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Form.Builder,Form>
  - builder
```
public static Form.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Form.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

Class Form

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

appId

environmentName

id

name

formActionType

formActionTypeAsString

style

dataType

hasFields

fields

hasSectionalElements

sectionalElements

schemaVersion

hasTags

tags

cta

labelDecorator

labelDecoratorAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields