Interface UpdateAgentRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<UpdateAgentRequest.Builder,UpdateAgentRequest>, QuickSightRequest.Builder, SdkBuilder<UpdateAgentRequest.Builder,UpdateAgentRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateAgentRequest
@Mutable @NotThreadSafe public static interface UpdateAgentRequest.Builder extends QuickSightRequest.Builder, SdkPojo, CopyableBuilder<UpdateAgentRequest.Builder,UpdateAgentRequest>

  • Method Details

    • agentId

      UpdateAgentRequest.Builder agentId(String agentId)

      The unique identifier for the agent to update.

      Parameters:
      agentId - The unique identifier for the agent to update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • awsAccountId

      UpdateAgentRequest.Builder awsAccountId(String awsAccountId)

      The ID of the Amazon Web Services account that contains the agent.

      Parameters:
      awsAccountId - The ID of the Amazon Web Services account that contains the agent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      UpdateAgentRequest.Builder name(String name)

      The name of the agent.

      Parameters:
      name - The name of the agent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      UpdateAgentRequest.Builder description(String description)

      A description of the agent.

      Parameters:
      description - A description of the agent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • iconId

      UpdateAgentRequest.Builder iconId(String iconId)

      The icon identifier for the agent.

      Parameters:
      iconId - The icon identifier for the agent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • starterPrompts

      UpdateAgentRequest.Builder starterPrompts(Collection<String> starterPrompts)

      A list of starter prompts that are displayed to users when they begin interacting with the agent.

      Parameters:
      starterPrompts - A list of starter prompts that are displayed to users when they begin interacting with the agent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • starterPrompts

      UpdateAgentRequest.Builder starterPrompts(String... starterPrompts)

      A list of starter prompts that are displayed to users when they begin interacting with the agent.

      Parameters:
      starterPrompts - A list of starter prompts that are displayed to users when they begin interacting with the agent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • welcomeMessage

      UpdateAgentRequest.Builder welcomeMessage(String welcomeMessage)

      The welcome message that is displayed when a user starts a conversation with the agent.

      Parameters:
      welcomeMessage - The welcome message that is displayed when a user starts a conversation with the agent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customPromptInput

      UpdateAgentRequest.Builder customPromptInput(CustomPromptInput customPromptInput)

      The custom prompt configuration for the agent.

      Parameters:
      customPromptInput - The custom prompt configuration for the agent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customPromptInput

      default UpdateAgentRequest.Builder customPromptInput(Consumer<CustomPromptInput.Builder> customPromptInput)

      The custom prompt configuration for the agent.

      This is a convenience method that creates an instance of the CustomPromptInput.Builder avoiding the need to create one manually via CustomPromptInput.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customPromptInput(CustomPromptInput).

      Parameters:
      customPromptInput - a consumer that will call methods on CustomPromptInput.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • spacesToAdd

      UpdateAgentRequest.Builder spacesToAdd(Collection<String> spacesToAdd)

      The Amazon Resource Names (ARNs) of the spaces to attach to the agent.

      Parameters:
      spacesToAdd - The Amazon Resource Names (ARNs) of the spaces to attach to the agent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • spacesToAdd

      UpdateAgentRequest.Builder spacesToAdd(String... spacesToAdd)

      The Amazon Resource Names (ARNs) of the spaces to attach to the agent.

      Parameters:
      spacesToAdd - The Amazon Resource Names (ARNs) of the spaces to attach to the agent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • spacesToRemove

      UpdateAgentRequest.Builder spacesToRemove(Collection<String> spacesToRemove)

      The Amazon Resource Names (ARNs) of the spaces to detach from the agent.

      Parameters:
      spacesToRemove - The Amazon Resource Names (ARNs) of the spaces to detach from the agent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • spacesToRemove

      UpdateAgentRequest.Builder spacesToRemove(String... spacesToRemove)

      The Amazon Resource Names (ARNs) of the spaces to detach from the agent.

      Parameters:
      spacesToRemove - The Amazon Resource Names (ARNs) of the spaces to detach from the agent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • actionConnectorsToAdd

      UpdateAgentRequest.Builder actionConnectorsToAdd(Collection<String> actionConnectorsToAdd)

      The Amazon Resource Names (ARNs) of the action connectors to attach to the agent.

      Parameters:
      actionConnectorsToAdd - The Amazon Resource Names (ARNs) of the action connectors to attach to the agent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • actionConnectorsToAdd

      UpdateAgentRequest.Builder actionConnectorsToAdd(String... actionConnectorsToAdd)

      The Amazon Resource Names (ARNs) of the action connectors to attach to the agent.

      Parameters:
      actionConnectorsToAdd - The Amazon Resource Names (ARNs) of the action connectors to attach to the agent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • actionConnectorsToRemove

      UpdateAgentRequest.Builder actionConnectorsToRemove(Collection<String> actionConnectorsToRemove)

      The Amazon Resource Names (ARNs) of the action connectors to detach from the agent.

      Parameters:
      actionConnectorsToRemove - The Amazon Resource Names (ARNs) of the action connectors to detach from the agent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • actionConnectorsToRemove

      UpdateAgentRequest.Builder actionConnectorsToRemove(String... actionConnectorsToRemove)

      The Amazon Resource Names (ARNs) of the action connectors to detach from the agent.

      Parameters:
      actionConnectorsToRemove - The Amazon Resource Names (ARNs) of the action connectors to detach from the agent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      UpdateAgentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateAgentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.