software.amazon.awssdk.services.lexruntime.model

Class GenericAttachment

java.lang.Object

software.amazon.awssdk.services.lexruntime.model.GenericAttachment

All Implemented Interfaces:

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

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

Represents an option rendered to the user when a prompt is shown. It could be an image, a button, a link, or text.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GenericAttachment.Builder

Method Summary

Modifier and Type	Method and Description
String	attachmentLinkUrl() The URL of an attachment to the response card.
static GenericAttachment.Builder	builder()
List<Button>	buttons() The list of options to show to the user.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasButtons() For responses, this returns true if the service returned a value for the Buttons property.
int	hashCode()
String	imageUrl() The URL of an image that is displayed to the user.
List<SdkField<?>>	sdkFields()
static Class<? extends GenericAttachment.Builder>	serializableBuilderClass()
String	subTitle() The subtitle shown below the title.
String	title() The title of the option.
GenericAttachment.Builder	toBuilder()
String	toString() 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

title

public final String title()

The title of the option.

Returns:

The title of the option.

subTitle

public final String subTitle()

The subtitle shown below the title.

Returns:

The subtitle shown below the title.

attachmentLinkUrl

public final String attachmentLinkUrl()

The URL of an attachment to the response card.

Returns:

The URL of an attachment to the response card.

imageUrl

public final String imageUrl()

The URL of an image that is displayed to the user.

Returns:

The URL of an image that is displayed to the user.

hasButtons

public final boolean hasButtons()

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

buttons

public final List<Button> buttons()

The list of options to show to the user.

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

Returns:

The list of options to show to the user.

toBuilder

public GenericAttachment.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GenericAttachment.Builder,GenericAttachment>

builder

public static GenericAttachment.Builder builder()

serializableBuilderClass

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