Form (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.amplifyuibuilder.model.Form

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Form
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Form()

Constructors
Constructor and Description
`Form()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Form`	`addFieldsEntry(String key, FieldConfig value)` Add a single Fields entry
`Form`	`addSectionalElementsEntry(String key, SectionalElement value)` Add a single SectionalElements entry
`Form`	`addTagsEntry(String key, String value)` Add a single Tags entry
`Form`	`clearFieldsEntries()` Removes all the entries added into Fields.
`Form`	`clearSectionalElementsEntries()` Removes all the entries added into SectionalElements.
`Form`	`clearTagsEntries()` Removes all the entries added into Tags.
`Form`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAppId()` The unique ID of the Amplify app associated with the form.
`FormCTA`	`getCta()` Stores the call to action configuration for the form.
`FormDataTypeConfig`	`getDataType()` The type of data source to use to create the form.
`String`	`getEnvironmentName()` The name of the backend environment that is a part of the Amplify app.
`Map<String,FieldConfig>`	`getFields()` Stores the information about the form's fields.
`String`	`getFormActionType()` The operation to perform on the specified form.
`String`	`getId()` The unique ID of the form.
`String`	`getLabelDecorator()` Specifies an icon or decoration to display on the form.
`String`	`getName()` The name of the form.
`String`	`getSchemaVersion()` The schema version of the form when it was imported.
`Map<String,SectionalElement>`	`getSectionalElements()` Stores the visual helper elements for the form that are not associated with any data.
`FormStyle`	`getStyle()` Stores the configuration for the form's style.
`Map<String,String>`	`getTags()` One or more key-value pairs to use when tagging the form.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAppId(String appId)` The unique ID of the Amplify app associated with the form.
`void`	`setCta(FormCTA cta)` Stores the call to action configuration for the form.
`void`	`setDataType(FormDataTypeConfig dataType)` The type of data source to use to create the form.
`void`	`setEnvironmentName(String environmentName)` The name of the backend environment that is a part of the Amplify app.
`void`	`setFields(Map<String,FieldConfig> fields)` Stores the information about the form's fields.
`void`	`setFormActionType(String formActionType)` The operation to perform on the specified form.
`void`	`setId(String id)` The unique ID of the form.
`void`	`setLabelDecorator(String labelDecorator)` Specifies an icon or decoration to display on the form.
`void`	`setName(String name)` The name of the form.
`void`	`setSchemaVersion(String schemaVersion)` The schema version of the form when it was imported.
`void`	`setSectionalElements(Map<String,SectionalElement> sectionalElements)` Stores the visual helper elements for the form that are not associated with any data.
`void`	`setStyle(FormStyle style)` Stores the configuration for the form's style.
`void`	`setTags(Map<String,String> tags)` One or more key-value pairs to use when tagging the form.
`String`	`toString()` Returns a string representation of this object.
`Form`	`withAppId(String appId)` The unique ID of the Amplify app associated with the form.
`Form`	`withCta(FormCTA cta)` Stores the call to action configuration for the form.
`Form`	`withDataType(FormDataTypeConfig dataType)` The type of data source to use to create the form.
`Form`	`withEnvironmentName(String environmentName)` The name of the backend environment that is a part of the Amplify app.
`Form`	`withFields(Map<String,FieldConfig> fields)` Stores the information about the form's fields.
`Form`	`withFormActionType(FormActionType formActionType)` The operation to perform on the specified form.
`Form`	`withFormActionType(String formActionType)` The operation to perform on the specified form.
`Form`	`withId(String id)` The unique ID of the form.
`Form`	`withLabelDecorator(LabelDecorator labelDecorator)` Specifies an icon or decoration to display on the form.
`Form`	`withLabelDecorator(String labelDecorator)` Specifies an icon or decoration to display on the form.
`Form`	`withName(String name)` The name of the form.
`Form`	`withSchemaVersion(String schemaVersion)` The schema version of the form when it was imported.
`Form`	`withSectionalElements(Map<String,SectionalElement> sectionalElements)` Stores the visual helper elements for the form that are not associated with any data.
`Form`	`withStyle(FormStyle style)` Stores the configuration for the form's style.
`Form`	`withTags(Map<String,String> tags)` One or more key-value pairs to use when tagging the form.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Form
```
public Form()
```
- Method Detail
  - setAppId
```
public void setAppId(String appId)
```
    The unique ID of the Amplify app associated with the form.
    
    Parameters:
    
    appId - The unique ID of the Amplify app associated with the form.
  - getAppId
```
public String getAppId()
```
    The unique ID of the Amplify app associated with the form.
    
    Returns:
    
    The unique ID of the Amplify app associated with the form.
  - withAppId
```
public Form withAppId(String appId)
```
    The unique ID of the Amplify app associated with the form.
    
    Parameters:
    
    appId - The unique ID of the Amplify app associated with the form.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEnvironmentName
```
public void setEnvironmentName(String environmentName)
```
    The name of the backend environment that is a part of the Amplify app.
    
    Parameters:
    
    environmentName - The name of the backend environment that is a part of the Amplify app.
  - getEnvironmentName
```
public String getEnvironmentName()
```
    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.
  - withEnvironmentName
```
public Form withEnvironmentName(String environmentName)
```
    The name of the backend environment that is a part of the Amplify app.
    
    Parameters:
    
    environmentName - The name of the backend environment that is a part of the Amplify app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setId
```
public void setId(String id)
```
    The unique ID of the form.
    
    Parameters:
    
    id - The unique ID of the form.
  - getId
```
public String getId()
```
    The unique ID of the form.
    
    Returns:
    
    The unique ID of the form.
  - withId
```
public Form withId(String id)
```
    The unique ID of the form.
    
    Parameters:
    
    id - The unique ID of the form.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the form.
    
    Parameters:
    
    name - The name of the form.
  - getName
```
public String getName()
```
    The name of the form.
    
    Returns:
    
    The name of the form.
  - withName
```
public Form withName(String name)
```
    The name of the form.
    
    Parameters:
    
    name - The name of the form.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFormActionType
```
public void setFormActionType(String formActionType)
```
    The operation to perform on the specified form.
    
    Parameters:
    
    formActionType - The operation to perform on the specified form.
    
    See Also:
    
    FormActionType
  - getFormActionType
```
public String getFormActionType()
```
    The operation to perform on the specified form.
    
    Returns:
    
    The operation to perform on the specified form.
    
    See Also:
    
    FormActionType
  - withFormActionType
```
public Form withFormActionType(String formActionType)
```
    The operation to perform on the specified form.
    
    Parameters:
    
    formActionType - The operation to perform on the specified form.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    FormActionType
  - withFormActionType
```
public Form withFormActionType(FormActionType formActionType)
```
    The operation to perform on the specified form.
    
    Parameters:
    
    formActionType - The operation to perform on the specified form.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    FormActionType
  - setStyle
```
public void setStyle(FormStyle style)
```
    Stores the configuration for the form's style.
    
    Parameters:
    
    style - Stores the configuration for the form's style.
  - getStyle
```
public FormStyle getStyle()
```
    Stores the configuration for the form's style.
    
    Returns:
    
    Stores the configuration for the form's style.
  - withStyle
```
public Form withStyle(FormStyle style)
```
    Stores the configuration for the form's style.
    
    Parameters:
    
    style - Stores the configuration for the form's style.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDataType
```
public void setDataType(FormDataTypeConfig dataType)
```
    The type of data source to use to create the form.
    
    Parameters:
    
    dataType - The type of data source to use to create the form.
  - getDataType
```
public FormDataTypeConfig getDataType()
```
    The type of data source to use to create the form.
    
    Returns:
    
    The type of data source to use to create the form.
  - withDataType
```
public Form withDataType(FormDataTypeConfig dataType)
```
    The type of data source to use to create the form.
    
    Parameters:
    
    dataType - The type of data source to use to create the form.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getFields
```
public Map<String,FieldConfig> getFields()
```
    Stores the information about the form's fields.
    
    Returns:
    
    Stores the information about the form's fields.
  - setFields
```
public void setFields(Map<String,FieldConfig> fields)
```
    Stores the information about the form's fields.
    
    Parameters:
    
    fields - Stores the information about the form's fields.
  - withFields
```
public Form withFields(Map<String,FieldConfig> fields)
```
    Stores the information about the form's fields.
    
    Parameters:
    
    fields - Stores the information about the form's fields.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addFieldsEntry
```
public Form addFieldsEntry(String key,
                           FieldConfig value)
```
    Add a single Fields entry
    
    See Also:
    
    withFields(java.util.Map<java.lang.String, com.amazonaws.services.amplifyuibuilder.model.FieldConfig>)
  - clearFieldsEntries
```
public Form clearFieldsEntries()
```
    Removes all the entries added into Fields.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSectionalElements
```
public Map<String,SectionalElement> getSectionalElements()
```
    Stores the visual helper elements for the form that are not associated with any data.
    
    Returns:
    
    Stores the visual helper elements for the form that are not associated with any data.
  - setSectionalElements
```
public void setSectionalElements(Map<String,SectionalElement> sectionalElements)
```
    Stores the visual helper elements for the form that are not associated with any data.
    
    Parameters:
    
    sectionalElements - Stores the visual helper elements for the form that are not associated with any data.
  - withSectionalElements
```
public Form withSectionalElements(Map<String,SectionalElement> sectionalElements)
```
    Stores the visual helper elements for the form that are not associated with any data.
    
    Parameters:
    
    sectionalElements - Stores the visual helper elements for the form that are not associated with any data.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addSectionalElementsEntry
```
public Form addSectionalElementsEntry(String key,
                                      SectionalElement value)
```
    Add a single SectionalElements entry
    
    See Also:
    
    withSectionalElements(java.util.Map<java.lang.String, com.amazonaws.services.amplifyuibuilder.model.SectionalElement>)
  - clearSectionalElementsEntries
```
public Form clearSectionalElementsEntries()
```
    Removes all the entries added into SectionalElements.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSchemaVersion
```
public void setSchemaVersion(String schemaVersion)
```
    The schema version of the form when it was imported.
    
    Parameters:
    
    schemaVersion - The schema version of the form when it was imported.
  - getSchemaVersion
```
public String getSchemaVersion()
```
    The schema version of the form when it was imported.
    
    Returns:
    
    The schema version of the form when it was imported.
  - withSchemaVersion
```
public Form withSchemaVersion(String schemaVersion)
```
    The schema version of the form when it was imported.
    
    Parameters:
    
    schemaVersion - The schema version of the form when it was imported.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    One or more key-value pairs to use when tagging the form.
    
    Returns:
    
    One or more key-value pairs to use when tagging the form.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    One or more key-value pairs to use when tagging the form.
    
    Parameters:
    
    tags - One or more key-value pairs to use when tagging the form.
  - withTags
```
public Form withTags(Map<String,String> tags)
```
    One or more key-value pairs to use when tagging the form.
    
    Parameters:
    
    tags - One or more key-value pairs to use when tagging the form.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public Form addTagsEntry(String key,
                         String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public Form clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCta
```
public void setCta(FormCTA cta)
```
    Stores the call to action configuration for the form.
    
    Parameters:
    
    cta - Stores the call to action configuration for the form.
  - getCta
```
public FormCTA getCta()
```
    Stores the call to action configuration for the form.
    
    Returns:
    
    Stores the call to action configuration for the form.
  - withCta
```
public Form withCta(FormCTA cta)
```
    Stores the call to action configuration for the form.
    
    Parameters:
    
    cta - Stores the call to action configuration for the form.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLabelDecorator
```
public void setLabelDecorator(String labelDecorator)
```
    Specifies an icon or decoration to display on the form.
    
    Parameters:
    
    labelDecorator - Specifies an icon or decoration to display on the form.
    
    See Also:
    
    LabelDecorator
  - getLabelDecorator
```
public String getLabelDecorator()
```
    Specifies an icon or decoration to display on the form.
    
    Returns:
    
    Specifies an icon or decoration to display on the form.
    
    See Also:
    
    LabelDecorator
  - withLabelDecorator
```
public Form withLabelDecorator(String labelDecorator)
```
    Specifies an icon or decoration to display on the form.
    
    Parameters:
    
    labelDecorator - Specifies an icon or decoration to display on the form.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LabelDecorator
  - withLabelDecorator
```
public Form withLabelDecorator(LabelDecorator labelDecorator)
```
    Specifies an icon or decoration to display on the form.
    
    Parameters:
    
    labelDecorator - Specifies an icon or decoration to display on the form.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LabelDecorator
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Form clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Form

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Form

Method Detail

setAppId

getAppId

withAppId

setEnvironmentName

getEnvironmentName

withEnvironmentName

setId

getId

withId

setName

getName

withName

setFormActionType

getFormActionType

withFormActionType

withFormActionType

setStyle

getStyle

withStyle

setDataType

getDataType

withDataType

getFields

setFields

withFields

addFieldsEntry

clearFieldsEntries

getSectionalElements

setSectionalElements

withSectionalElements

addSectionalElementsEntry

clearSectionalElementsEntries

setSchemaVersion

getSchemaVersion

withSchemaVersion

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setCta

getCta

withCta

setLabelDecorator

getLabelDecorator

withLabelDecorator

withLabelDecorator

toString

equals

hashCode

clone

marshall