public static interface CreateDocumentClassifierRequest.Builder extends ComprehendRequest.Builder, SdkPojo, CopyableBuilder<CreateDocumentClassifierRequest.Builder,CreateDocumentClassifierRequest>
Modifier and Type | Method and Description |
---|---|
CreateDocumentClassifierRequest.Builder |
clientRequestToken(String clientRequestToken)
A unique identifier for the request.
|
CreateDocumentClassifierRequest.Builder |
dataAccessRoleArn(String dataAccessRoleArn)
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend
read access to your input data.
|
CreateDocumentClassifierRequest.Builder |
documentClassifierName(String documentClassifierName)
The name of the document classifier.
|
default CreateDocumentClassifierRequest.Builder |
inputDataConfig(Consumer<DocumentClassifierInputDataConfig.Builder> inputDataConfig)
Specifies the format and location of the input data for the job.
|
CreateDocumentClassifierRequest.Builder |
inputDataConfig(DocumentClassifierInputDataConfig inputDataConfig)
Specifies the format and location of the input data for the job.
|
CreateDocumentClassifierRequest.Builder |
languageCode(LanguageCode languageCode)
The language of the input documents.
|
CreateDocumentClassifierRequest.Builder |
languageCode(String languageCode)
The language of the input documents.
|
CreateDocumentClassifierRequest.Builder |
mode(DocumentClassifierMode mode)
Indicates the mode in which the classifier will be trained.
|
CreateDocumentClassifierRequest.Builder |
mode(String mode)
Indicates the mode in which the classifier will be trained.
|
default CreateDocumentClassifierRequest.Builder |
outputDataConfig(Consumer<DocumentClassifierOutputDataConfig.Builder> outputDataConfig)
Enables the addition of output results configuration parameters for custom classifier jobs.
|
CreateDocumentClassifierRequest.Builder |
outputDataConfig(DocumentClassifierOutputDataConfig outputDataConfig)
Enables the addition of output results configuration parameters for custom classifier jobs.
|
CreateDocumentClassifierRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
CreateDocumentClassifierRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
CreateDocumentClassifierRequest.Builder |
tags(Collection<Tag> tags)
Tags to be associated with the document classifier being created.
|
CreateDocumentClassifierRequest.Builder |
tags(Consumer<Tag.Builder>... tags)
Tags to be associated with the document classifier being created.
|
CreateDocumentClassifierRequest.Builder |
tags(Tag... tags)
Tags to be associated with the document classifier being created.
|
CreateDocumentClassifierRequest.Builder |
volumeKmsKeyId(String volumeKmsKeyId)
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage
volume attached to the ML compute instance(s) that process the analysis job.
|
default CreateDocumentClassifierRequest.Builder |
vpcConfig(Consumer<VpcConfig.Builder> vpcConfig)
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are
using for your custom classifier.
|
CreateDocumentClassifierRequest.Builder |
vpcConfig(VpcConfig vpcConfig)
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are
using for your custom classifier.
|
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
CreateDocumentClassifierRequest.Builder documentClassifierName(String documentClassifierName)
The name of the document classifier.
documentClassifierName
- The name of the document classifier.CreateDocumentClassifierRequest.Builder dataAccessRoleArn(String dataAccessRoleArn)
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
dataAccessRoleArn
- The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon
Comprehend read access to your input data.CreateDocumentClassifierRequest.Builder tags(Collection<Tag> tags)
Tags to be associated with the document classifier being created. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
tags
- Tags to be associated with the document classifier being created. A tag is a key-value pair that adds
as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key
might be added to a resource to indicate its use by the sales department.CreateDocumentClassifierRequest.Builder tags(Tag... tags)
Tags to be associated with the document classifier being created. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
tags
- Tags to be associated with the document classifier being created. A tag is a key-value pair that adds
as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key
might be added to a resource to indicate its use by the sales department.CreateDocumentClassifierRequest.Builder tags(Consumer<Tag.Builder>... tags)
Tags to be associated with the document classifier being created. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
This is a convenience that creates an instance of theList.Builder
avoiding the need to create
one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and its result
is passed to #tags(List)
.tags
- a consumer that will call methods on List.Builder
#tags(List)
CreateDocumentClassifierRequest.Builder inputDataConfig(DocumentClassifierInputDataConfig inputDataConfig)
Specifies the format and location of the input data for the job.
inputDataConfig
- Specifies the format and location of the input data for the job.default CreateDocumentClassifierRequest.Builder inputDataConfig(Consumer<DocumentClassifierInputDataConfig.Builder> inputDataConfig)
Specifies the format and location of the input data for the job.
This is a convenience that creates an instance of theDocumentClassifierInputDataConfig.Builder
avoiding the need to create one manually via DocumentClassifierInputDataConfig.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called
immediately and its result is passed to inputDataConfig(DocumentClassifierInputDataConfig)
.inputDataConfig
- a consumer that will call methods on DocumentClassifierInputDataConfig.Builder
inputDataConfig(DocumentClassifierInputDataConfig)
CreateDocumentClassifierRequest.Builder outputDataConfig(DocumentClassifierOutputDataConfig outputDataConfig)
Enables the addition of output results configuration parameters for custom classifier jobs.
outputDataConfig
- Enables the addition of output results configuration parameters for custom classifier jobs.default CreateDocumentClassifierRequest.Builder outputDataConfig(Consumer<DocumentClassifierOutputDataConfig.Builder> outputDataConfig)
Enables the addition of output results configuration parameters for custom classifier jobs.
This is a convenience that creates an instance of theDocumentClassifierOutputDataConfig.Builder
avoiding the need to create one manually via DocumentClassifierOutputDataConfig.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called
immediately and its result is passed to outputDataConfig(DocumentClassifierOutputDataConfig)
.outputDataConfig
- a consumer that will call methods on DocumentClassifierOutputDataConfig.Builder
outputDataConfig(DocumentClassifierOutputDataConfig)
CreateDocumentClassifierRequest.Builder clientRequestToken(String clientRequestToken)
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
clientRequestToken
- A unique identifier for the request. If you don't set the client request token, Amazon Comprehend
generates one.CreateDocumentClassifierRequest.Builder languageCode(String languageCode)
The language of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All documents must be in the same language.
languageCode
- The language of the input documents. You can specify any of the following languages supported by
Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or
Portuguese ("pt"). All documents must be in the same language.LanguageCode
,
LanguageCode
CreateDocumentClassifierRequest.Builder languageCode(LanguageCode languageCode)
The language of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All documents must be in the same language.
languageCode
- The language of the input documents. You can specify any of the following languages supported by
Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or
Portuguese ("pt"). All documents must be in the same language.LanguageCode
,
LanguageCode
CreateDocumentClassifierRequest.Builder volumeKmsKeyId(String volumeKmsKeyId)
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
volumeKmsKeyId
- ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the
storage volume attached to the ML compute instance(s) that process the analysis job. The
VolumeKmsKeyId can be either of the following formats:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
CreateDocumentClassifierRequest.Builder vpcConfig(VpcConfig vpcConfig)
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC.
vpcConfig
- Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources
you are using for your custom classifier. For more information, see Amazon VPC.default CreateDocumentClassifierRequest.Builder vpcConfig(Consumer<VpcConfig.Builder> vpcConfig)
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC.
This is a convenience that creates an instance of theVpcConfig.Builder
avoiding the need to create
one manually via VpcConfig.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its result
is passed to vpcConfig(VpcConfig)
.vpcConfig
- a consumer that will call methods on VpcConfig.Builder
vpcConfig(VpcConfig)
CreateDocumentClassifierRequest.Builder mode(String mode)
Indicates the mode in which the classifier will be trained. The classifier can be trained in multi-class mode, which identifies one and only one class for each document, or multi-label mode, which identifies one or more labels for each document. In multi-label mode, multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).
mode
- Indicates the mode in which the classifier will be trained. The classifier can be trained in
multi-class mode, which identifies one and only one class for each document, or multi-label mode,
which identifies one or more labels for each document. In multi-label mode, multiple labels for an
individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).DocumentClassifierMode
,
DocumentClassifierMode
CreateDocumentClassifierRequest.Builder mode(DocumentClassifierMode mode)
Indicates the mode in which the classifier will be trained. The classifier can be trained in multi-class mode, which identifies one and only one class for each document, or multi-label mode, which identifies one or more labels for each document. In multi-label mode, multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).
mode
- Indicates the mode in which the classifier will be trained. The classifier can be trained in
multi-class mode, which identifies one and only one class for each document, or multi-label mode,
which identifies one or more labels for each document. In multi-label mode, multiple labels for an
individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).DocumentClassifierMode
,
DocumentClassifierMode
CreateDocumentClassifierRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.CreateDocumentClassifierRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.