Interface CreateThesaurusRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateThesaurusRequest.Builder,
,CreateThesaurusRequest> KendraRequest.Builder
,SdkBuilder<CreateThesaurusRequest.Builder,
,CreateThesaurusRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateThesaurusRequest
-
Method Summary
Modifier and TypeMethodDescriptionclientToken
(String clientToken) A token that you provide to identify the request to create a thesaurus.description
(String description) A description for the thesaurus.The identifier of the index for the thesaurus.A name for the thesaurus.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket that contains the thesaurus file.default CreateThesaurusRequest.Builder
sourceS3Path
(Consumer<S3Path.Builder> sourceS3Path) The path to the thesaurus file in S3.sourceS3Path
(S3Path sourceS3Path) The path to the thesaurus file in S3.tags
(Collection<Tag> tags) A list of key-value pairs that identify or categorize the thesaurus.tags
(Consumer<Tag.Builder>... tags) A list of key-value pairs that identify or categorize the thesaurus.A list of key-value pairs that identify or categorize the thesaurus.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.kendra.model.KendraRequest.Builder
build
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
-
indexId
The identifier of the index for the thesaurus.
- Parameters:
indexId
- The identifier of the index for the thesaurus.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
name
A name for the thesaurus.
- Parameters:
name
- A name for the thesaurus.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
A description for the thesaurus.
- Parameters:
description
- A description for the thesaurus.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
roleArn
The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket that contains the thesaurus file. For more information, see IAM access roles for Amazon Kendra.
- Parameters:
roleArn
- The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket that contains the thesaurus file. For more information, see IAM access roles for Amazon Kendra.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A list of key-value pairs that identify or categorize the thesaurus. You can also use tags to help control access to the thesaurus. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
- Parameters:
tags
- A list of key-value pairs that identify or categorize the thesaurus. You can also use tags to help control access to the thesaurus. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A list of key-value pairs that identify or categorize the thesaurus. You can also use tags to help control access to the thesaurus. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
- Parameters:
tags
- A list of key-value pairs that identify or categorize the thesaurus. You can also use tags to help control access to the thesaurus. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A list of key-value pairs that identify or categorize the thesaurus. You can also use tags to help control access to the thesaurus. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sourceS3Path
The path to the thesaurus file in S3.
- Parameters:
sourceS3Path
- The path to the thesaurus file in S3.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceS3Path
The path to the thesaurus file in S3.
This is a convenience method that creates an instance of theS3Path.Builder
avoiding the need to create one manually viaS3Path.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosourceS3Path(S3Path)
.- Parameters:
sourceS3Path
- a consumer that will call methods onS3Path.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
clientToken
A token that you provide to identify the request to create a thesaurus. Multiple calls to the
CreateThesaurus
API with the same client token will create only one thesaurus.- Parameters:
clientToken
- A token that you provide to identify the request to create a thesaurus. Multiple calls to theCreateThesaurus
API with the same client token will create only one thesaurus.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CreateThesaurusRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateThesaurusRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-