Package software.amazon.awssdk.services.qapps.model

Class FormInputCard

java.lang.Object

software.amazon.awssdk.services.qapps.model.FormInputCard

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<FormInputCard.Builder,FormInputCard>

@Generated("software.amazon.awssdk:codegen")
public final class FormInputCard
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<FormInputCard.Builder,FormInputCard>

A card in an Amazon Q App that allows the user to submit a response.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FormInputCard.Builder

Method Summary

Modifier and Type	Method	Description
static FormInputCard.Builder	builder()
InputCardComputeMode	computeMode()	The compute mode of the form input card.
String	computeModeAsString()	The compute mode of the form input card.
List<String>	dependencies()	Any dependencies or requirements for the form input card.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDependencies()	For responses, this returns true if the service returned a value for the Dependencies property.
int	hashCode()
String	id()	The unique identifier of the form input card.
FormInputCardMetadata	metadata()	The metadata that defines the form input card data.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends FormInputCard.Builder>	serializableBuilderClass()
String	title()	The title of the form input card.
FormInputCard.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
CardType	type()	The type of the card.
String	typeAsString()	The type of the card.

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

id

public final String id()

The unique identifier of the form input card.

Returns:

The unique identifier of the form input card.

title

public final String title()

The title of the form input card.

Returns:

The title of the form input card.

hasDependencies

public final boolean hasDependencies()

For responses, this returns true if the service returned a value for the Dependencies 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.

dependencies

public final List<String> dependencies()

Any dependencies or requirements for the form input card.

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 hasDependencies() method.

Returns:

Any dependencies or requirements for the form input card.

type

public final CardType type()

The type of the card.

If the service returns an enum value that is not available in the current SDK version, type will return CardType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of the card.

See Also:

CardType

typeAsString

public final String typeAsString()

The type of the card.

If the service returns an enum value that is not available in the current SDK version, type will return CardType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of the card.

See Also:

CardType

metadata

public final FormInputCardMetadata metadata()

The metadata that defines the form input card data.

Returns:

The metadata that defines the form input card data.

computeMode

public final InputCardComputeMode computeMode()

The compute mode of the form input card. This property determines whether individual participants of a data collection session can submit multiple response or one response. A compute mode of append shall allow participants to submit the same form multiple times with different values. A compute mode of replacecode> shall overwrite the current value for each participant.

If the service returns an enum value that is not available in the current SDK version, computeMode will return InputCardComputeMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from computeModeAsString().

Returns:

The compute mode of the form input card. This property determines whether individual participants of a data collection session can submit multiple response or one response. A compute mode of append shall allow participants to submit the same form multiple times with different values. A compute mode of replacecode> shall overwrite the current value for each participant.

See Also:

InputCardComputeMode

computeModeAsString

public final String computeModeAsString()

The compute mode of the form input card. This property determines whether individual participants of a data collection session can submit multiple response or one response. A compute mode of append shall allow participants to submit the same form multiple times with different values. A compute mode of replacecode> shall overwrite the current value for each participant.

If the service returns an enum value that is not available in the current SDK version, computeMode will return InputCardComputeMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from computeModeAsString().

Returns:

The compute mode of the form input card. This property determines whether individual participants of a data collection session can submit multiple response or one response. A compute mode of append shall allow participants to submit the same form multiple times with different values. A compute mode of replacecode> shall overwrite the current value for each participant.

See Also:

InputCardComputeMode

toBuilder

public FormInputCard.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FormInputCard.Builder,FormInputCard>

builder

public static FormInputCard.Builder builder()

serializableBuilderClass

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