Interface CreateAiAgentRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateAiAgentRequest.Builder,CreateAiAgentRequest>, QConnectRequest.Builder, SdkBuilder<CreateAiAgentRequest.Builder,CreateAiAgentRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateAiAgentRequest

@Mutable
@NotThreadSafe
public static interface CreateAiAgentRequest.Builder
extends QConnectRequest.Builder, SdkPojo, CopyableBuilder<CreateAiAgentRequest.Builder,CreateAiAgentRequest>

Method Summary

Modifier and Type	Method	Description
CreateAiAgentRequest.Builder	assistantId(String assistantId)	The identifier of the Amazon Q in Connect assistant.
CreateAiAgentRequest.Builder	clientToken(String clientToken)	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
default CreateAiAgentRequest.Builder	configuration(Consumer<AIAgentConfiguration.Builder> configuration)	The configuration of the AI Agent.
CreateAiAgentRequest.Builder	configuration(AIAgentConfiguration configuration)	The configuration of the AI Agent.
CreateAiAgentRequest.Builder	description(String description)	The description of the AI Agent.
CreateAiAgentRequest.Builder	name(String name)	The name of the AI Agent.
CreateAiAgentRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateAiAgentRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateAiAgentRequest.Builder	tags(Map<String,String> tags)	The tags used to organize, track, or control access for this resource.
CreateAiAgentRequest.Builder	type(String type)	The type of the AI Agent.
CreateAiAgentRequest.Builder	type(AIAgentType type)	The type of the AI Agent.
CreateAiAgentRequest.Builder	visibilityStatus(String visibilityStatus)	The visibility status of the AI Agent.
CreateAiAgentRequest.Builder	visibilityStatus(VisibilityStatus visibilityStatus)	The visibility status of the AI Agent.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.qconnect.model.QConnectRequest.Builder

build

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

clientToken

CreateAiAgentRequest.Builder clientToken(String clientToken)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..

Parameters:

clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..

Returns:

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

assistantId

CreateAiAgentRequest.Builder assistantId(String assistantId)

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

Parameters:

assistantId - The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

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

name

CreateAiAgentRequest.Builder name(String name)

The name of the AI Agent.

Parameters:

name - The name of the AI Agent.

Returns:

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

type

CreateAiAgentRequest.Builder type(String type)

The type of the AI Agent.

Parameters:

type - The type of the AI Agent.

Returns:

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

See Also:

• AIAgentType
• AIAgentType

type

CreateAiAgentRequest.Builder type(AIAgentType type)

The type of the AI Agent.

Parameters:

type - The type of the AI Agent.

Returns:

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

See Also:

• AIAgentType
• AIAgentType

configuration

CreateAiAgentRequest.Builder configuration(AIAgentConfiguration configuration)

The configuration of the AI Agent.

Parameters:

configuration - The configuration of the AI Agent.

Returns:

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

configuration

default CreateAiAgentRequest.Builder configuration(Consumer<AIAgentConfiguration.Builder> configuration)

The configuration of the AI Agent.

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

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

Parameters:

configuration - a consumer that will call methods on AIAgentConfiguration.Builder

Returns:

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

See Also:

• configuration(AIAgentConfiguration)

visibilityStatus

CreateAiAgentRequest.Builder visibilityStatus(String visibilityStatus)

The visibility status of the AI Agent.

Parameters:

visibilityStatus - The visibility status of the AI Agent.

Returns:

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

See Also:

• VisibilityStatus
• VisibilityStatus

visibilityStatus

CreateAiAgentRequest.Builder visibilityStatus(VisibilityStatus visibilityStatus)

The visibility status of the AI Agent.

Parameters:

visibilityStatus - The visibility status of the AI Agent.

Returns:

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

See Also:

• VisibilityStatus
• VisibilityStatus

tags

CreateAiAgentRequest.Builder tags(Map<String,String> tags)

The tags used to organize, track, or control access for this resource.

Parameters:

tags - The tags used to organize, track, or control access for this resource.

Returns:

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

description

CreateAiAgentRequest.Builder description(String description)

The description of the AI Agent.

Parameters:

description - The description of the AI Agent.

Returns:

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

overrideConfiguration

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

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