Class ResponseCard
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ResponseCard.Builder,
ResponseCard>
If you configure a response card when creating your bots, Amazon Lex substitutes the session attributes and slot
values that are available, and then returns it. The response card can also come from a Lambda function (
dialogCodeHook
and fulfillmentActivity
on an intent).
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ResponseCard.Builder
builder()
final ContentType
The content type of the response.final String
The content type of the response.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final List
<GenericAttachment> An array of attachment objects representing options.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 GenericAttachments property.final int
hashCode()
static Class
<? extends ResponseCard.Builder> 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.final String
version()
The version of the response card format.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
version
The version of the response card format.
- Returns:
- The version of the response card format.
-
contentType
The content type of the response.
If the service returns an enum value that is not available in the current SDK version,
contentType
will returnContentType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcontentTypeAsString()
.- Returns:
- The content type of the response.
- See Also:
-
contentTypeAsString
The content type of the response.
If the service returns an enum value that is not available in the current SDK version,
contentType
will returnContentType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcontentTypeAsString()
.- Returns:
- The content type of the response.
- See Also:
-
hasGenericAttachments
public final boolean hasGenericAttachments()For responses, this returns true if the service returned a value for the GenericAttachments 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. -
genericAttachments
An array of attachment objects representing options.
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
hasGenericAttachments()
method.- Returns:
- An array of attachment objects representing options.
-
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<ResponseCard.Builder,
ResponseCard> - 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
-