Class CreateCustomActionRequest

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