Interface KnowledgeBaseSummary.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<KnowledgeBaseSummary.Builder,
,KnowledgeBaseSummary> SdkBuilder<KnowledgeBaseSummary.Builder,
,KnowledgeBaseSummary> SdkPojo
- Enclosing class:
KnowledgeBaseSummary
-
Method Summary
Modifier and TypeMethodDescriptiondescription
(String description) The description of the knowledge base.knowledgeBaseArn
(String knowledgeBaseArn) The Amazon Resource Name (ARN) of the knowledge base.knowledgeBaseId
(String knowledgeBaseId) The identifier of the knowledge base.knowledgeBaseType
(String knowledgeBaseType) The type of knowledge base.knowledgeBaseType
(KnowledgeBaseType knowledgeBaseType) The type of knowledge base.The name of the knowledge base.default KnowledgeBaseSummary.Builder
renderingConfiguration
(Consumer<RenderingConfiguration.Builder> renderingConfiguration) Information about how to render the content.renderingConfiguration
(RenderingConfiguration renderingConfiguration) Information about how to render the content.default KnowledgeBaseSummary.Builder
serverSideEncryptionConfiguration
(Consumer<ServerSideEncryptionConfiguration.Builder> serverSideEncryptionConfiguration) The configuration information for the customer managed key used for encryption.serverSideEncryptionConfiguration
(ServerSideEncryptionConfiguration serverSideEncryptionConfiguration) The configuration information for the customer managed key used for encryption.default KnowledgeBaseSummary.Builder
sourceConfiguration
(Consumer<SourceConfiguration.Builder> sourceConfiguration) Configuration information about the external data source.sourceConfiguration
(SourceConfiguration sourceConfiguration) Configuration information about the external data source.The status of the knowledge base summary.status
(KnowledgeBaseStatus status) The status of the knowledge base summary.The tags used to organize, track, or control access for this resource.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 Details
-
description
The description of the knowledge base.
- Parameters:
description
- The description of the knowledge base.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
knowledgeBaseArn
The Amazon Resource Name (ARN) of the knowledge base.
- Parameters:
knowledgeBaseArn
- The Amazon Resource Name (ARN) of the knowledge base.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
knowledgeBaseId
The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
- Parameters:
knowledgeBaseId
- The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
knowledgeBaseType
The type of knowledge base.
- Parameters:
knowledgeBaseType
- The type of knowledge base.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
knowledgeBaseType
The type of knowledge base.
- Parameters:
knowledgeBaseType
- The type of knowledge base.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
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 KnowledgeBaseSummary.Builder renderingConfiguration(Consumer<RenderingConfiguration.Builder> renderingConfiguration) Information about how to render the content.
This is a convenience method that creates an instance of theRenderingConfiguration.Builder
avoiding the need to create one manually viaRenderingConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed torenderingConfiguration(RenderingConfiguration)
.- Parameters:
renderingConfiguration
- a consumer that will call methods onRenderingConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
serverSideEncryptionConfiguration
KnowledgeBaseSummary.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/kms:GenerateDataKey
permissions to the IAM identity using the key to invoke Wisdom.For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom 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/kms:GenerateDataKey
permissions to the IAM identity using the key to invoke Wisdom.For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
serverSideEncryptionConfiguration
default KnowledgeBaseSummary.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/kms:GenerateDataKey
permissions to the IAM identity using the key to invoke Wisdom.For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance.
This is a convenience method that creates an instance of theServerSideEncryptionConfiguration.Builder
avoiding the need to create one manually viaServerSideEncryptionConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toserverSideEncryptionConfiguration(ServerSideEncryptionConfiguration)
.- Parameters:
serverSideEncryptionConfiguration
- a consumer that will call methods onServerSideEncryptionConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sourceConfiguration
Configuration information about the external data source.
- Parameters:
sourceConfiguration
- Configuration information about the external data source.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceConfiguration
default KnowledgeBaseSummary.Builder sourceConfiguration(Consumer<SourceConfiguration.Builder> sourceConfiguration) Configuration information about the external data source.
This is a convenience method that creates an instance of theSourceConfiguration.Builder
avoiding the need to create one manually viaSourceConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosourceConfiguration(SourceConfiguration)
.- Parameters:
sourceConfiguration
- a consumer that will call methods onSourceConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
status
The status of the knowledge base summary.
- Parameters:
status
- The status of the knowledge base summary.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
status
The status of the knowledge base summary.
- Parameters:
status
- The status of the knowledge base summary.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-