Interface ActionReviewEvent.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ActionReviewEvent.Builder,ActionReviewEvent>, SdkBuilder<ActionReviewEvent.Builder,ActionReviewEvent>, SdkPojo
All Known Subinterfaces:
DefaultActionReviewEvent.Builder
Enclosing class:
ActionReviewEvent
@Mutable @NotThreadSafe public static interface ActionReviewEvent.Builder extends SdkPojo, CopyableBuilder<ActionReviewEvent.Builder,ActionReviewEvent>

  • Method Details

    • conversationId

      ActionReviewEvent.Builder conversationId(String conversationId)

      The identifier of the conversation with which the action review event is associated.

      Parameters:
      conversationId - The identifier of the conversation with which the action review event is associated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userMessageId

      ActionReviewEvent.Builder userMessageId(String userMessageId)

      The identifier of the conversation with which the plugin action is associated.

      Parameters:
      userMessageId - The identifier of the conversation with which the plugin action is associated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • systemMessageId

      ActionReviewEvent.Builder systemMessageId(String systemMessageId)

      The identifier of an Amazon Q Business AI generated associated with the action review event.

      Parameters:
      systemMessageId - The identifier of an Amazon Q Business AI generated associated with the action review event.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pluginId

      ActionReviewEvent.Builder pluginId(String pluginId)

      The identifier of the plugin associated with the action review event.

      Parameters:
      pluginId - The identifier of the plugin associated with the action review event.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pluginType

      ActionReviewEvent.Builder pluginType(String pluginType)

      The type of plugin.

      Parameters:
      pluginType - The type of plugin.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • pluginType

      ActionReviewEvent.Builder pluginType(PluginType pluginType)

      The type of plugin.

      Parameters:
      pluginType - The type of plugin.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • payload

      ActionReviewEvent.Builder payload(Map<String,ActionReviewPayloadField> payload)

      Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.

      Parameters:
      payload - Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • payloadFieldNameSeparator

      ActionReviewEvent.Builder payloadFieldNameSeparator(String payloadFieldNameSeparator)

      A string used to retain information about the hierarchical contexts within an action review event payload.

      Parameters:
      payloadFieldNameSeparator - A string used to retain information about the hierarchical contexts within an action review event payload.
      Returns:
      Returns a reference to this object so that method calls can be chained together.