Class Form

java.lang.Object
software.amazon.awssdk.services.amplifyuibuilder.model.Form
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Form.Builder,Form>
@Generated("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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • toBuilder

      public Form.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Form.Builder,Form>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.