Class CardStatus
- java.lang.Object
-
- software.amazon.awssdk.services.qapps.model.CardStatus
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<CardStatus.Builder,CardStatus>
@Generated("software.amazon.awssdk:codegen") public final class CardStatus extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CardStatus.Builder,CardStatus>
The current status and value of a card in an active Amazon Q App session.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCardStatus.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CardStatus.Builderbuilder()ExecutionStatuscurrentState()The current state of the card.StringcurrentStateAsString()The current state of the card.StringcurrentValue()The current value or result associated with the card.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasSubmissions()For responses, this returns true if the service returned a value for the Submissions property.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends CardStatus.Builder>serializableBuilderClass()List<Submission>submissions()A list of previous submissions, if the card is a form card.CardStatus.BuildertoBuilder()StringtoString()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
-
currentState
public final ExecutionStatus currentState()
The current state of the card.
If the service returns an enum value that is not available in the current SDK version,
currentStatewill returnExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcurrentStateAsString().- Returns:
- The current state of the card.
- See Also:
ExecutionStatus
-
currentStateAsString
public final String currentStateAsString()
The current state of the card.
If the service returns an enum value that is not available in the current SDK version,
currentStatewill returnExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcurrentStateAsString().- Returns:
- The current state of the card.
- See Also:
ExecutionStatus
-
currentValue
public final String currentValue()
The current value or result associated with the card.
- Returns:
- The current value or result associated with the card.
-
hasSubmissions
public final boolean hasSubmissions()
For responses, this returns true if the service returned a value for the Submissions 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.
-
submissions
public final List<Submission> submissions()
A list of previous submissions, if the card is a form 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
hasSubmissions()method.- Returns:
- A list of previous submissions, if the card is a form card.
-
toBuilder
public CardStatus.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CardStatus.Builder,CardStatus>
-
builder
public static CardStatus.Builder builder()
-
serializableBuilderClass
public static Class<? extends CardStatus.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-