Class CreateCustomActionRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.chatbot.model.ChatbotRequest
-
- software.amazon.awssdk.services.chatbot.model.CreateCustomActionRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateCustomActionRequest.Builder,CreateCustomActionRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateCustomActionRequest extends ChatbotRequest implements ToCopyableBuilder<CreateCustomActionRequest.Builder,CreateCustomActionRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateCustomActionRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringactionName()The name of the custom action.StringaliasName()The name used to invoke this action in a chat channel.List<CustomActionAttachment>attachments()Defines when this custom action button should be attached to a notification.static CreateCustomActionRequest.Builderbuilder()StringclientToken()A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.CustomActionDefinitiondefinition()The definition of the command to run when invoked as an alias or as an action button.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAttachments()For responses, this returns true if the service returned a value for the Attachments property.inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends CreateCustomActionRequest.Builder>serializableBuilderClass()List<Tag>tags()A map of tags assigned to a resource.CreateCustomActionRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
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
-
definition
public final CustomActionDefinition definition()
The definition of the command to run when invoked as an alias or as an action button.
- Returns:
- The definition of the command to run when invoked as an alias or as an action button.
-
aliasName
public final String aliasName()
The name used to invoke this action in a chat channel. For example,
@aws run my-alias.- Returns:
- The name used to invoke this action in a 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 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.
-
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.
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags 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.
-
tags
public final List<Tag> tags()
A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.
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
hasTags()method.- Returns:
- A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.
-
clientToken
public final String clientToken()
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.
If you do not specify a client token, one is automatically generated by the SDK.
- Returns:
- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Idempotency ensures that an API request completes only once. With an idempotent request, if the original
request completes successfully, subsequent retries with the same client token returns the result from the
original successful request.
If you do not specify a client token, one is automatically generated by the SDK.
-
actionName
public final String actionName()
The name of the custom action. This name is included in the Amazon Resource Name (ARN).
- Returns:
- The name of the custom action. This name is included in the Amazon Resource Name (ARN).
-
toBuilder
public CreateCustomActionRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateCustomActionRequest.Builder,CreateCustomActionRequest>- Specified by:
toBuilderin classChatbotRequest
-
builder
public static CreateCustomActionRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateCustomActionRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-