Interface CreateKnowledgeBaseRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateKnowledgeBaseRequest

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

Method Summary

Modifier and Type	Method	Description
CreateKnowledgeBaseRequest.Builder	clientToken(String clientToken)	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
CreateKnowledgeBaseRequest.Builder	description(String description)	The description.
CreateKnowledgeBaseRequest.Builder	knowledgeBaseType(String knowledgeBaseType)	The type of knowledge base.
CreateKnowledgeBaseRequest.Builder	knowledgeBaseType(KnowledgeBaseType knowledgeBaseType)	The type of knowledge base.
CreateKnowledgeBaseRequest.Builder	name(String name)	The name of the knowledge base.
CreateKnowledgeBaseRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateKnowledgeBaseRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default CreateKnowledgeBaseRequest.Builder	renderingConfiguration(Consumer<RenderingConfiguration.Builder> renderingConfiguration)	Information about how to render the content.
CreateKnowledgeBaseRequest.Builder	renderingConfiguration(RenderingConfiguration renderingConfiguration)	Information about how to render the content.
default CreateKnowledgeBaseRequest.Builder	serverSideEncryptionConfiguration(Consumer<ServerSideEncryptionConfiguration.Builder> serverSideEncryptionConfiguration)	The configuration information for the customer managed key used for encryption.
CreateKnowledgeBaseRequest.Builder	serverSideEncryptionConfiguration(ServerSideEncryptionConfiguration serverSideEncryptionConfiguration)	The configuration information for the customer managed key used for encryption.
default CreateKnowledgeBaseRequest.Builder	sourceConfiguration(Consumer<SourceConfiguration.Builder> sourceConfiguration)	The source of the knowledge base content.
CreateKnowledgeBaseRequest.Builder	sourceConfiguration(SourceConfiguration sourceConfiguration)	The source of the knowledge base content.
CreateKnowledgeBaseRequest.Builder	tags(Map<String,String> tags)	The tags used to organize, track, or control access for this resource.
default CreateKnowledgeBaseRequest.Builder	vectorIngestionConfiguration(Consumer<VectorIngestionConfiguration.Builder> vectorIngestionConfiguration)	Contains details about how to ingest the documents in a data source.
CreateKnowledgeBaseRequest.Builder	vectorIngestionConfiguration(VectorIngestionConfiguration vectorIngestionConfiguration)	Contains details about how to ingest the documents in a data source.

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

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

name

CreateKnowledgeBaseRequest.Builder name(String name)

The name of the knowledge base.

Parameters:

name - The name of the knowledge base.

Returns:

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

knowledgeBaseType

CreateKnowledgeBaseRequest.Builder knowledgeBaseType(String knowledgeBaseType)

The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.

Parameters:

knowledgeBaseType - The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.

Returns:

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

See Also:

• KnowledgeBaseType
• KnowledgeBaseType

knowledgeBaseType

CreateKnowledgeBaseRequest.Builder knowledgeBaseType(KnowledgeBaseType knowledgeBaseType)

The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.

Parameters:

knowledgeBaseType - The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.

Returns:

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

See Also:

• KnowledgeBaseType
• KnowledgeBaseType

sourceConfiguration

CreateKnowledgeBaseRequest.Builder sourceConfiguration(SourceConfiguration sourceConfiguration)

The source of the knowledge base content. Only set this argument for EXTERNAL or Managed knowledge bases.

Parameters:

sourceConfiguration - The source of the knowledge base content. Only set this argument for EXTERNAL or Managed knowledge bases.

Returns:

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

sourceConfiguration

default CreateKnowledgeBaseRequest.Builder sourceConfiguration(Consumer<SourceConfiguration.Builder> sourceConfiguration)

The source of the knowledge base content. Only set this argument for EXTERNAL or Managed knowledge bases.

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

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

Parameters:

sourceConfiguration - a consumer that will call methods on SourceConfiguration.Builder

Returns:

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

See Also:

• sourceConfiguration(SourceConfiguration)

renderingConfiguration

CreateKnowledgeBaseRequest.Builder renderingConfiguration(RenderingConfiguration renderingConfiguration)

Information about how to render the content.

Parameters:

renderingConfiguration - Information about how to render the content.

Returns:

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

renderingConfiguration

default CreateKnowledgeBaseRequest.Builder renderingConfiguration(Consumer<RenderingConfiguration.Builder> renderingConfiguration)

Information about how to render the content.

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

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

Parameters:

renderingConfiguration - a consumer that will call methods on RenderingConfiguration.Builder

Returns:

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

See Also:

• renderingConfiguration(RenderingConfiguration)

vectorIngestionConfiguration

CreateKnowledgeBaseRequest.Builder vectorIngestionConfiguration(VectorIngestionConfiguration vectorIngestionConfiguration)

Contains details about how to ingest the documents in a data source.

Parameters:

vectorIngestionConfiguration - Contains details about how to ingest the documents in a data source.

Returns:

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

vectorIngestionConfiguration

default CreateKnowledgeBaseRequest.Builder vectorIngestionConfiguration(Consumer<VectorIngestionConfiguration.Builder> vectorIngestionConfiguration)

Contains details about how to ingest the documents in a data source.

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

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

Parameters:

vectorIngestionConfiguration - a consumer that will call methods on VectorIngestionConfiguration.Builder

Returns:

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

See Also:

• vectorIngestionConfiguration(VectorIngestionConfiguration)

serverSideEncryptionConfiguration

CreateKnowledgeBaseRequest.Builder serverSideEncryptionConfiguration(ServerSideEncryptionConfiguration serverSideEncryptionConfiguration)

The configuration information for the customer managed key used for encryption.

This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect.

For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.

Parameters:

serverSideEncryptionConfiguration - The configuration information for the customer managed key used for encryption.

This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect.

For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.

Returns:

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

serverSideEncryptionConfiguration

default CreateKnowledgeBaseRequest.Builder serverSideEncryptionConfiguration(Consumer<ServerSideEncryptionConfiguration.Builder> serverSideEncryptionConfiguration)

The configuration information for the customer managed key used for encryption.

This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect.

For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.

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

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

Parameters:

serverSideEncryptionConfiguration - a consumer that will call methods on ServerSideEncryptionConfiguration.Builder

Returns:

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

See Also:

• serverSideEncryptionConfiguration(ServerSideEncryptionConfiguration)

description

CreateKnowledgeBaseRequest.Builder description(String description)

The description.

Parameters:

description - The description.

Returns:

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

tags

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

overrideConfiguration

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

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