Package software.amazon.awssdk.services.bedrockagent.model

Interface AgentAlias.Builder

All Superinterfaces:

Buildable, CopyableBuilder<AgentAlias.Builder,AgentAlias>, SdkBuilder<AgentAlias.Builder,AgentAlias>, SdkPojo

Enclosing class:

AgentAlias

public static interface AgentAlias.Builder
extends SdkPojo, CopyableBuilder<AgentAlias.Builder,AgentAlias>

Method Summary

Modifier and Type	Method	Description
AgentAlias.Builder	agentAliasArn(String agentAliasArn)	The Amazon Resource Name (ARN) of the alias of the agent.
AgentAlias.Builder	agentAliasHistoryEvents(Collection<AgentAliasHistoryEvent> agentAliasHistoryEvents)	Contains details about the history of the alias.
AgentAlias.Builder	agentAliasHistoryEvents(Consumer<AgentAliasHistoryEvent.Builder>... agentAliasHistoryEvents)	Contains details about the history of the alias.
AgentAlias.Builder	agentAliasHistoryEvents(AgentAliasHistoryEvent... agentAliasHistoryEvents)	Contains details about the history of the alias.
AgentAlias.Builder	agentAliasId(String agentAliasId)	The unique identifier of the alias of the agent.
AgentAlias.Builder	agentAliasName(String agentAliasName)	The name of the alias of the agent.
AgentAlias.Builder	agentAliasStatus(String agentAliasStatus)	The status of the alias of the agent and whether it is ready for use.
AgentAlias.Builder	agentAliasStatus(AgentAliasStatus agentAliasStatus)	The status of the alias of the agent and whether it is ready for use.
AgentAlias.Builder	agentId(String agentId)	The unique identifier of the agent.
AgentAlias.Builder	clientToken(String clientToken)	A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
AgentAlias.Builder	createdAt(Instant createdAt)	The time at which the alias of the agent was created.
AgentAlias.Builder	description(String description)	The description of the alias of the agent.
AgentAlias.Builder	failureReasons(String... failureReasons)	Information on the failure of Provisioned Throughput assigned to an agent alias.
AgentAlias.Builder	failureReasons(Collection<String> failureReasons)	Information on the failure of Provisioned Throughput assigned to an agent alias.
AgentAlias.Builder	routingConfiguration(Collection<AgentAliasRoutingConfigurationListItem> routingConfiguration)	Contains details about the routing configuration of the alias.
AgentAlias.Builder	routingConfiguration(Consumer<AgentAliasRoutingConfigurationListItem.Builder>... routingConfiguration)	Contains details about the routing configuration of the alias.
AgentAlias.Builder	routingConfiguration(AgentAliasRoutingConfigurationListItem... routingConfiguration)	Contains details about the routing configuration of the alias.
AgentAlias.Builder	updatedAt(Instant updatedAt)	The time at which the alias was last updated.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

agentAliasArn

AgentAlias.Builder agentAliasArn(String agentAliasArn)

The Amazon Resource Name (ARN) of the alias of the agent.

Parameters:

agentAliasArn - The Amazon Resource Name (ARN) of the alias of the agent.

Returns:

Returns a reference to this object so that method calls can be chained together.

agentAliasHistoryEvents

AgentAlias.Builder agentAliasHistoryEvents(Collection<AgentAliasHistoryEvent> agentAliasHistoryEvents)

Contains details about the history of the alias.

Parameters:

agentAliasHistoryEvents - Contains details about the history of the alias.

Returns:

Returns a reference to this object so that method calls can be chained together.

agentAliasHistoryEvents

AgentAlias.Builder agentAliasHistoryEvents(AgentAliasHistoryEvent... agentAliasHistoryEvents)

Contains details about the history of the alias.

Parameters:

agentAliasHistoryEvents - Contains details about the history of the alias.

Returns:

Returns a reference to this object so that method calls can be chained together.

agentAliasHistoryEvents

AgentAlias.Builder agentAliasHistoryEvents(Consumer<AgentAliasHistoryEvent.Builder>... agentAliasHistoryEvents)

Contains details about the history of the alias.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #agentAliasHistoryEvents(List).

Parameters:

agentAliasHistoryEvents - a consumer that will call methods on AgentAliasHistoryEvent.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#agentAliasHistoryEvents(java.util.Collection)

agentAliasId

AgentAlias.Builder agentAliasId(String agentAliasId)

The unique identifier of the alias of the agent.

Parameters:

agentAliasId - The unique identifier of the alias of the agent.

Returns:

Returns a reference to this object so that method calls can be chained together.

agentAliasName

AgentAlias.Builder agentAliasName(String agentAliasName)

The name of the alias of the agent.

Parameters:

agentAliasName - The name of the alias of the agent.

Returns:

Returns a reference to this object so that method calls can be chained together.

agentAliasStatus

AgentAlias.Builder agentAliasStatus(String agentAliasStatus)

The status of the alias of the agent and whether it is ready for use. The following statuses are possible:

• CREATING – The agent alias is being created.

• PREPARED – The agent alias is finished being created or updated and is ready to be invoked.

• FAILED – The agent alias API operation failed.

• UPDATING – The agent alias is being updated.

• DELETING – The agent alias is being deleted.

Parameters:

agentAliasStatus - The status of the alias of the agent and whether it is ready for use. The following statuses are possible:

• CREATING – The agent alias is being created.

• PREPARED – The agent alias is finished being created or updated and is ready to be invoked.

• FAILED – The agent alias API operation failed.

• UPDATING – The agent alias is being updated.

• DELETING – The agent alias is being deleted.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AgentAliasStatus, AgentAliasStatus

agentAliasStatus

AgentAlias.Builder agentAliasStatus(AgentAliasStatus agentAliasStatus)

The status of the alias of the agent and whether it is ready for use. The following statuses are possible:

• CREATING – The agent alias is being created.

• PREPARED – The agent alias is finished being created or updated and is ready to be invoked.

• FAILED – The agent alias API operation failed.

• UPDATING – The agent alias is being updated.

• DELETING – The agent alias is being deleted.

Parameters:

agentAliasStatus - The status of the alias of the agent and whether it is ready for use. The following statuses are possible:

• CREATING – The agent alias is being created.

• PREPARED – The agent alias is finished being created or updated and is ready to be invoked.

• FAILED – The agent alias API operation failed.

• UPDATING – The agent alias is being updated.

• DELETING – The agent alias is being deleted.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AgentAliasStatus, AgentAliasStatus

agentId

AgentAlias.Builder agentId(String agentId)

The unique identifier of the agent.

Parameters:

agentId - The unique identifier of the agent.

Returns:

Returns a reference to this object so that method calls can be chained together.

clientToken

AgentAlias.Builder clientToken(String clientToken)

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

Parameters:

clientToken - A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

Returns:

Returns a reference to this object so that method calls can be chained together.

createdAt

AgentAlias.Builder createdAt(Instant createdAt)

The time at which the alias of the agent was created.

Parameters:

createdAt - The time at which the alias of the agent was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

AgentAlias.Builder description(String description)

The description of the alias of the agent.

Parameters:

description - The description of the alias of the agent.

Returns:

Returns a reference to this object so that method calls can be chained together.

failureReasons

AgentAlias.Builder failureReasons(Collection<String> failureReasons)

Information on the failure of Provisioned Throughput assigned to an agent alias.

Parameters:

failureReasons - Information on the failure of Provisioned Throughput assigned to an agent alias.

Returns:

Returns a reference to this object so that method calls can be chained together.

failureReasons

AgentAlias.Builder failureReasons(String... failureReasons)

Information on the failure of Provisioned Throughput assigned to an agent alias.

Parameters:

failureReasons - Information on the failure of Provisioned Throughput assigned to an agent alias.

Returns:

Returns a reference to this object so that method calls can be chained together.

routingConfiguration

AgentAlias.Builder routingConfiguration(Collection<AgentAliasRoutingConfigurationListItem> routingConfiguration)

Contains details about the routing configuration of the alias.

Parameters:

routingConfiguration - Contains details about the routing configuration of the alias.

Returns:

Returns a reference to this object so that method calls can be chained together.

routingConfiguration

AgentAlias.Builder routingConfiguration(AgentAliasRoutingConfigurationListItem... routingConfiguration)

Contains details about the routing configuration of the alias.

Parameters:

routingConfiguration - Contains details about the routing configuration of the alias.

Returns:

Returns a reference to this object so that method calls can be chained together.

routingConfiguration

AgentAlias.Builder routingConfiguration(Consumer<AgentAliasRoutingConfigurationListItem.Builder>... routingConfiguration)

Contains details about the routing configuration of the alias.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #routingConfiguration(List).

Parameters:

routingConfiguration - a consumer that will call methods on AgentAliasRoutingConfigurationListItem.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#routingConfiguration(java.util.Collection)

updatedAt

AgentAlias.Builder updatedAt(Instant updatedAt)

The time at which the alias was last updated.

Parameters:

updatedAt - The time at which the alias was last updated.

Returns:

Returns a reference to this object so that method calls can be chained together.