Class FormSummary

java.lang.Object
software.amazon.awssdk.services.amplifyuibuilder.model.FormSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<FormSummary.Builder,FormSummary>
@Generated("software.amazon.awssdk:codegen") public final class FormSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FormSummary.Builder,FormSummary>

Describes the basic information about a form.

See Also:

  • Method Details

    • appId

      public final String appId()

      The unique ID for the app associated with the form summary.

      Returns:
      The unique ID for the app associated with the form summary.

    • dataType

      public final FormDataTypeConfig dataType()

      The form's data source type.

      Returns:
      The form's data source type.

    • environmentName

      public final String environmentName()

      The name of the backend environment that is part of the Amplify app.

      Returns:
      The name of the backend environment that is part of the Amplify app.

    • formActionType

      public final FormActionType formActionType()

      The type of operation to perform on the 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 type of operation to perform on the form.
      See Also:

    • formActionTypeAsString

      public final String formActionTypeAsString()

      The type of operation to perform on the 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 type of operation to perform on the form.
      See Also:

    • id

      public final String id()

      The ID of the form.

      Returns:
      The ID of the form.

    • name

      public final String name()

      The name of the form.

      Returns:
      The name of the form.

    • toBuilder

      public FormSummary.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<FormSummary.Builder,FormSummary>
      Returns:
      a builder for type T

    • builder

      public static FormSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends FormSummary.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.