Interface CreateFormData.Builder

All Superinterfaces:
Buildable, CopyableBuilder<CreateFormData.Builder,CreateFormData>, SdkBuilder<CreateFormData.Builder,CreateFormData>, SdkPojo
Enclosing class:
CreateFormData
@Mutable @NotThreadSafe public static interface CreateFormData.Builder extends SdkPojo, CopyableBuilder<CreateFormData.Builder,CreateFormData>

  • Method Details

    • name

      CreateFormData.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.

    • dataType

      CreateFormData.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 CreateFormData.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:

    • formActionType

      CreateFormData.Builder formActionType(String formActionType)

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

      Parameters:
      formActionType - Specifies whether to perform a create or update action on the form.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • formActionType

      CreateFormData.Builder formActionType(FormActionType formActionType)

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

      Parameters:
      formActionType - Specifies whether to perform a create or update action on the form.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • fields

      CreateFormData.Builder fields(Map<String,FieldConfig> fields)

      The configuration information for the form's fields.

      Parameters:
      fields - The configuration information for the form's fields.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • style

      CreateFormData.Builder style(FormStyle style)

      The configuration for the form's style.

      Parameters:
      style - The configuration for the form's style.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • style

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

      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:

    • sectionalElements

      CreateFormData.Builder sectionalElements(Map<String,SectionalElement> sectionalElements)

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

      Parameters:
      sectionalElements - The configuration information for the visual helper elements for the form. These elements are not associated with any data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • schemaVersion

      CreateFormData.Builder schemaVersion(String schemaVersion)

      The schema version of the form.

      Parameters:
      schemaVersion - The schema version of the form.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cta

      CreateFormData.Builder cta(FormCTA cta)

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

      Parameters:
      cta - The FormCTA object that 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 CreateFormData.Builder cta(Consumer<FormCTA.Builder> cta)

      The FormCTA object that 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:

    • tags

      CreateFormData.Builder tags(Map<String,String> tags)

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

      Parameters:
      tags - One or more key-value pairs to use when tagging the form data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • labelDecorator

      CreateFormData.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

      CreateFormData.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: