java.lang.Object
- software.amazon.awssdk.services.chatbot.model.CustomAction

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CustomAction.Builder,CustomAction>
```
@Generated("software.amazon.awssdk:codegen")
public final class CustomAction
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CustomAction.Builder,CustomAction>
```
Represents a parameterized command that can be invoked as an alias or as a notification button in the chat client.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CustomAction.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`actionName()`	The name of the custom action that is included in the ARN.
`String`	`aliasName()`	The name used to invoke this action in the chat channel.
`List<CustomActionAttachment>`	`attachments()`	Defines when this custom action button should be attached to a notification.
`static CustomAction.Builder`	`builder()`
`String`	`customActionArn()`	The fully defined Amazon Resource Name (ARN) of the custom action.
`CustomActionDefinition`	`definition()`	The definition of the command to run when invoked an alias or as an action button.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAttachments()`	For responses, this returns true if the service returned a value for the Attachments property.
`int`	`hashCode()`
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CustomAction.Builder>`	`serializableBuilderClass()`
`CustomAction.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
  - customActionArn
```
public final String customActionArn()
```
    The fully defined Amazon Resource Name (ARN) of the custom action.
    
    Returns:
    
    The fully defined Amazon Resource Name (ARN) of the custom action.
  - definition
```
public final CustomActionDefinition definition()
```
    The definition of the command to run when invoked an alias or as an action button.
    
    Returns:
    
    The definition of the command to run when invoked an alias or as an action button.
  - aliasName
```
public final String aliasName()
```
    The name used to invoke this action in the chat channel. For example, @aws run my-alias.
    
    Returns:
    
    The name used to invoke this action in the chat channel. For example, @aws run my-alias.
  - hasAttachments
```
public final boolean hasAttachments()
```
    For responses, this returns true if the service returned a value for the Attachments 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.
  - attachments
```
public final List<CustomActionAttachment> attachments()
```
    Defines when this custom action button should be attached to a 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 hasAttachments() method.
    
    Returns:
    
    Defines when this custom action button should be attached to a notification.
  - actionName
```
public final String actionName()
```
    The name of the custom action that is included in the ARN.
    
    Returns:
    
    The name of the custom action that is included in the ARN.
  - toBuilder
```
public CustomAction.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CustomAction.Builder,CustomAction>
  - builder
```
public static CustomAction.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CustomAction.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

Class CustomAction

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

customActionArn

definition

aliasName

hasAttachments

attachments

actionName

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField