Package software.amazon.awssdk.services.chatbot.model

Class CustomActionAttachment

java.lang.Object

software.amazon.awssdk.services.chatbot.model.CustomActionAttachment

All Implemented Interfaces:

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

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

Defines when a custom action button should be attached to a notification.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CustomActionAttachment.Builder

Method Summary

Modifier and Type	Method	Description
static CustomActionAttachment.Builder	builder()
String	buttonText()	The text of the button that appears on the notification.
List<CustomActionAttachmentCriteria>	criteria()	The criteria for when a button should be shown based on values in the notification.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCriteria()	For responses, this returns true if the service returned a value for the Criteria property.
int	hashCode()
boolean	hasVariables()	For responses, this returns true if the service returned a value for the Variables property.
String	notificationType()	The type of notification that the custom action should be attached to.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CustomActionAttachment.Builder>	serializableBuilderClass()
CustomActionAttachment.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Map<String,String>	variables()	The variables to extract from the notification.

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

notificationType

public final String notificationType()

The type of notification that the custom action should be attached to.

Returns:

The type of notification that the custom action should be attached to.

buttonText

public final String buttonText()

The text of the button that appears on the notification.

Returns:

The text of the button that appears on the notification.

hasCriteria

public final boolean hasCriteria()

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

criteria

public final List<CustomActionAttachmentCriteria> criteria()

The criteria for when a button should be shown based on values in the notification.

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

Returns:

The criteria for when a button should be shown based on values in the notification.

hasVariables

public final boolean hasVariables()

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

variables

public final Map<String,String> variables()

The variables to extract from the notification.

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

Returns:

The variables to extract from the notification.

toBuilder

public CustomActionAttachment.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CustomActionAttachment.Builder,CustomActionAttachment>

builder

public static CustomActionAttachment.Builder builder()

serializableBuilderClass

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