Interface Agent.Builder

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

  • Method Details

    • spaces

      Agent.Builder spaces(Collection<String> spaces)

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

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

    • spaces

      Agent.Builder spaces(String... spaces)

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

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

    • actionConnectors

      Agent.Builder actionConnectors(Collection<String> actionConnectors)

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

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

    • actionConnectors

      Agent.Builder actionConnectors(String... actionConnectors)

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

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

    • description

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

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

    • name

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

    • starterPrompts

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

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

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

    • arn

      Agent.Builder arn(String arn)

      The Amazon Resource Name (ARN) of the agent.

      Parameters:
      arn - The Amazon Resource Name (ARN) of the agent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • agentId

      Agent.Builder agentId(String agentId)

      The unique identifier for the agent.

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

    • agentLifecycle

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

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

    • agentStatus

      Agent.Builder agentStatus(String agentStatus)

      The status of the agent.

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

    • agentStatus

      Agent.Builder agentStatus(AgentStatus agentStatus)

      The status of the agent.

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

    • createdAt

      Agent.Builder createdAt(Instant createdAt)

      The date and time that the agent was created.

      Parameters:
      createdAt - The date and time that the agent was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • creator

      Agent.Builder creator(String creator)

      The identity of the user who created the agent.

      Parameters:
      creator - The identity of the user who created the agent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customPromptInterface

      Agent.Builder customPromptInterface(CustomPromptInterface customPromptInterface)

      The custom prompt interface configuration for the agent.

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

    • customPromptInterface

      default Agent.Builder customPromptInterface(Consumer<CustomPromptInterface.Builder> customPromptInterface)

      The custom prompt interface configuration for the agent.

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

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

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

    • errorMessage

      Agent.Builder errorMessage(String errorMessage)

      An error message associated with the agent, if applicable.

      Parameters:
      errorMessage - An error message associated with the agent, if applicable.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updatedAt

      Agent.Builder updatedAt(Instant updatedAt)

      The date and time that the agent was last updated.

      Parameters:
      updatedAt - The date and time that the agent was last updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.