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

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FormSummary.Builder

Method Summary

Modifier and Type	Method	Description
String	appId()	The unique ID for the app associated with the form summary.
static FormSummary.Builder	builder()
FormDataTypeConfig	dataType()	The form's data source type.
String	environmentName()	The name of the backend environment that is part of the Amplify app.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FormActionType	formActionType()	The type of operation to perform on the form.
String	formActionTypeAsString()	The type of operation to perform on the form.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	The ID of the form.
String	name()	The name of the form.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends FormSummary.Builder>	serializableBuilderClass()
FormSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

FormActionType

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:

FormActionType

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()

Specified by:

toBuilder in interface ToCopyableBuilder<FormSummary.Builder,FormSummary>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo