Package software.amazon.awssdk.services.amplifyuibuilder.model

Interface Form.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Form.Builder,Form>, SdkBuilder<Form.Builder,Form>, SdkPojo
Enclosing class:
Form
public static interface Form.Builder extends SdkPojo, CopyableBuilder<Form.Builder,Form>

  • Method Details

    • appId

      Form.Builder appId(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.

    • environmentName

      Form.Builder environmentName(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.

    • id

      Form.Builder id(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.

    • name

      Form.Builder name(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.

    • formActionType

      Form.Builder formActionType(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

      Form.Builder formActionType(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:

    • style

      Form.Builder style(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.

    • style

      default Form.Builder style(Consumer<FormStyle.Builder> style)

      Stores the configuration for the form's style.

      This is a convenience method that creates an instance of the FormStyle.Builder avoiding the need to create one manually via FormStyle.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to style(FormStyle).

      Parameters:
      style - a consumer that will call methods on FormStyle.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dataType

      Form.Builder dataType(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.

    • dataType

      default Form.Builder dataType(Consumer<FormDataTypeConfig.Builder> dataType)

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

      This is a convenience method that creates an instance of the FormDataTypeConfig.Builder avoiding the need to create one manually via FormDataTypeConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dataType(FormDataTypeConfig).

      Parameters:
      dataType - a consumer that will call methods on FormDataTypeConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • fields

      Form.Builder fields(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.

    • sectionalElements

      Form.Builder sectionalElements(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.

    • schemaVersion

      Form.Builder schemaVersion(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.

    • tags

      Form.Builder tags(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.

    • cta

      Form.Builder cta(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.

    • cta

      default Form.Builder cta(Consumer<FormCTA.Builder> cta)

      Stores the call to action configuration for the form.

      This is a convenience method that creates an instance of the FormCTA.Builder avoiding the need to create one manually via FormCTA.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to cta(FormCTA).

      Parameters:
      cta - a consumer that will call methods on FormCTA.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • labelDecorator

      Form.Builder labelDecorator(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

      Form.Builder labelDecorator(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: