Interface CreateAgentRequest.Builder

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

  • Method Details

    • spaces

      CreateAgentRequest.Builder spaces(Collection<String> spaces)

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

      Parameters:
      spaces - 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.

    • spaces

      CreateAgentRequest.Builder spaces(String... spaces)

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

      Parameters:
      spaces - 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.

    • actionConnectors

      CreateAgentRequest.Builder actionConnectors(Collection<String> actionConnectors)

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

      Parameters:
      actionConnectors - 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.

    • actionConnectors

      CreateAgentRequest.Builder actionConnectors(String... actionConnectors)

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

      Parameters:
      actionConnectors - 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.

    • awsAccountId

      CreateAgentRequest.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.

    • agentId

      CreateAgentRequest.Builder agentId(String agentId)

      A unique identifier for the agent.

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

    • name

      CreateAgentRequest.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

      CreateAgentRequest.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

      CreateAgentRequest.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

      CreateAgentRequest.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

      CreateAgentRequest.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

      CreateAgentRequest.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.

    • agentLifecycle

      CreateAgentRequest.Builder agentLifecycle(String agentLifecycle)

      The lifecycle state of the agent. Valid values are PREVIEW and PUBLISHED.

      Parameters:
      agentLifecycle - The lifecycle state of the agent. Valid values are PREVIEW and PUBLISHED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • agentLifecycle

      CreateAgentRequest.Builder agentLifecycle(AgentLifecycle agentLifecycle)

      The lifecycle state of the agent. Valid values are PREVIEW and PUBLISHED.

      Parameters:
      agentLifecycle - The lifecycle state of the agent. Valid values are PREVIEW and PUBLISHED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • customPromptInput

      CreateAgentRequest.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 CreateAgentRequest.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:

    • overrideConfiguration

      CreateAgentRequest.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

      CreateAgentRequest.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.