Class CreateFormData
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<CreateFormData.Builder,
CreateFormData>
Represents all of the information that is required to create a form.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic CreateFormData.Builder
builder()
final FormCTA
cta()
TheFormCTA
object that stores the call to action configuration for the form.final FormDataTypeConfig
dataType()
The type of data source to use to create the form.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Map
<String, FieldConfig> fields()
The configuration information for the form's fields.final FormActionType
Specifies whether to perform a create or update action on the form.final String
Specifies whether to perform a create or update action on the form.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Fields property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SectionalElements property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final LabelDecorator
Specifies an icon or decoration to display on the form.final String
Specifies an icon or decoration to display on the form.final String
name()
The name of the form.final String
The schema version of the form.final Map
<String, SectionalElement> The configuration information for the visual helper elements for the form.static Class
<? extends CreateFormData.Builder> final FormStyle
style()
The configuration for the form's style.tags()
One or more key-value pairs to use when tagging the form data.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the form.
- Returns:
- The name of the form.
-
dataType
The type of data source to use to create the form.
- Returns:
- The type of data source to use to create the form.
-
formActionType
Specifies whether to perform a create or update action on the form.
If the service returns an enum value that is not available in the current SDK version,
formActionType
will returnFormActionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromformActionTypeAsString()
.- Returns:
- Specifies whether to perform a create or update action on the form.
- See Also:
-
formActionTypeAsString
Specifies whether to perform a create or update action on the form.
If the service returns an enum value that is not available in the current SDK version,
formActionType
will returnFormActionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromformActionTypeAsString()
.- Returns:
- Specifies whether to perform a create or update action on the form.
- See Also:
-
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 theisEmpty()
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
The configuration information for 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:
- The configuration information for the form's fields.
-
style
The configuration for the form's style.
- Returns:
- The configuration for the form's style.
-
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 theisEmpty()
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
The configuration information for the visual helper elements for the form. These elements 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:
- The configuration information for the visual helper elements for the form. These elements are not associated with any data.
-
schemaVersion
The schema version of the form.
- Returns:
- The schema version of the form.
-
cta
The
FormCTA
object that stores the call to action configuration for the form.- Returns:
- The
FormCTA
object that stores the call to action configuration for the form.
-
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 theisEmpty()
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
One or more key-value pairs to use when tagging the form 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
hasTags()
method.- Returns:
- One or more key-value pairs to use when tagging the form data.
-
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 returnLabelDecorator.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlabelDecoratorAsString()
.- Returns:
- Specifies an icon or decoration to display on the form.
- See Also:
-
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 returnLabelDecorator.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlabelDecoratorAsString()
.- Returns:
- Specifies an icon or decoration to display on the form.
- See Also:
-
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 interfaceToCopyableBuilder<CreateFormData.Builder,
CreateFormData> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-