software.amazon.awssdk.services.lexruntime.model

Class ResponseCard

java.lang.Object

software.amazon.awssdk.services.lexruntime.model.ResponseCard

All Implemented Interfaces:

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

@Generated(value="software.amazon.awssdk:codegen")
public final class ResponseCard
extends Object
implements SdkPojo, Serializable, 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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ResponseCard.Builder

Method Summary

Modifier and Type	Method and Description
static ResponseCard.Builder	builder()
ContentType	contentType() The content type of the response.
String	contentTypeAsString() The content type of the response.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<GenericAttachment>	genericAttachments() An array of attachment objects representing options.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasGenericAttachments() For responses, this returns true if the service returned a value for the GenericAttachments property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends ResponseCard.Builder>	serializableBuilderClass()
ResponseCard.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	version() The version of the response card format.

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

version

public final String version()

The version of the response card format.

Returns:

The version of the response card format.

contentType

public final ContentType 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 return ContentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentTypeAsString().

Returns:

The content type of the response.

See Also:

ContentType

contentTypeAsString

public final String 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 return ContentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentTypeAsString().

Returns:

The content type of the response.

See Also:

ContentType

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 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.

genericAttachments

public final List<GenericAttachment> 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

public ResponseCard.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ResponseCard.Builder,ResponseCard>

builder

public static ResponseCard.Builder builder()

serializableBuilderClass

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