software.amazon.awssdk.services.comprehend.model

Interface CreateDocumentClassifierRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, ComprehendRequest.Builder, CopyableBuilder<CreateDocumentClassifierRequest.Builder,CreateDocumentClassifierRequest>, SdkBuilder<CreateDocumentClassifierRequest.Builder,CreateDocumentClassifierRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateDocumentClassifierRequest

public static interface CreateDocumentClassifierRequest.Builder
extends ComprehendRequest.Builder, SdkPojo, CopyableBuilder<CreateDocumentClassifierRequest.Builder,CreateDocumentClassifierRequest>

Method Summary

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 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.
CreateDocumentClassifierRequest.Builder	modelKmsKeyId(String modelKmsKeyId) ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models.
CreateDocumentClassifierRequest.Builder	modelPolicy(String modelPolicy) The resource-based policy to attach to your custom document classifier model.
default CreateDocumentClassifierRequest.Builder	outputDataConfig(Consumer<DocumentClassifierOutputDataConfig.Builder> outputDataConfig) Specifies the location for the output files from a custom classifier job.
CreateDocumentClassifierRequest.Builder	outputDataConfig(DocumentClassifierOutputDataConfig outputDataConfig) Specifies the location for the output files from a custom classifier job.
CreateDocumentClassifierRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateDocumentClassifierRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateDocumentClassifierRequest.Builder	tags(Collection<Tag> tags) Tags to associate with the document classifier.
CreateDocumentClassifierRequest.Builder	tags(Consumer<Tag.Builder>... tags) Tags to associate with the document classifier.
CreateDocumentClassifierRequest.Builder	tags(Tag... tags) Tags to associate with the document classifier.
CreateDocumentClassifierRequest.Builder	versionName(String versionName) The version name given to the newly created classifier.
CreateDocumentClassifierRequest.Builder	volumeKmsKeyId(String volumeKmsKeyId) ID for the Amazon Web Services 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.

Methods inherited from interface software.amazon.awssdk.services.comprehend.model.ComprehendRequest.Builder

build

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

overrideConfiguration

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

documentClassifierName

CreateDocumentClassifierRequest.Builder documentClassifierName(String documentClassifierName)

The name of the document classifier.

Parameters:

documentClassifierName - The name of the document classifier.

Returns:

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

versionName

CreateDocumentClassifierRequest.Builder versionName(String versionName)

The version name given to the newly created classifier. Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the Amazon Web Services account/Amazon Web Services Region.

Parameters:

versionName - The version name given to the newly created classifier. Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the Amazon Web Services account/Amazon Web Services Region.

Returns:

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

dataAccessRoleArn

CreateDocumentClassifierRequest.Builder dataAccessRoleArn(String dataAccessRoleArn)

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.

Parameters:

dataAccessRoleArn - The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.

Returns:

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

tags

CreateDocumentClassifierRequest.Builder tags(Collection<Tag> tags)

Tags to associate with the document classifier. 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.

Parameters:

tags - Tags to associate with the document classifier. 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.

Returns:

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

tags

CreateDocumentClassifierRequest.Builder tags(Tag... tags)

Tags to associate with the document classifier. 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.

Parameters:

tags - Tags to associate with the document classifier. 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.

Returns:

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

tags

CreateDocumentClassifierRequest.Builder tags(Consumer<Tag.Builder>... tags)

Tags to associate with the document classifier. 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 method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

#tags(java.util.Collection)

inputDataConfig

CreateDocumentClassifierRequest.Builder inputDataConfig(DocumentClassifierInputDataConfig inputDataConfig)

Specifies the format and location of the input data for the job.

Parameters:

inputDataConfig - Specifies the format and location of the input data for the job.

Returns:

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

inputDataConfig

default CreateDocumentClassifierRequest.Builder inputDataConfig(Consumer<DocumentClassifierInputDataConfig.Builder> inputDataConfig)

Specifies the format and location of the input data for the job.

This is a convenience method that creates an instance of the DocumentClassifierInputDataConfig.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).

Parameters:

inputDataConfig - a consumer that will call methods on DocumentClassifierInputDataConfig.Builder

Returns:

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

See Also:

inputDataConfig(DocumentClassifierInputDataConfig)

outputDataConfig

CreateDocumentClassifierRequest.Builder outputDataConfig(DocumentClassifierOutputDataConfig outputDataConfig)

Specifies the location for the output files from a custom classifier job. This parameter is required for a request that creates a native classifier model.

Parameters:

outputDataConfig - Specifies the location for the output files from a custom classifier job. This parameter is required for a request that creates a native classifier model.

Returns:

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

outputDataConfig

default CreateDocumentClassifierRequest.Builder outputDataConfig(Consumer<DocumentClassifierOutputDataConfig.Builder> outputDataConfig)

Specifies the location for the output files from a custom classifier job. This parameter is required for a request that creates a native classifier model.

This is a convenience method that creates an instance of the DocumentClassifierOutputDataConfig.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).

Parameters:

outputDataConfig - a consumer that will call methods on DocumentClassifierOutputDataConfig.Builder

Returns:

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

See Also:

outputDataConfig(DocumentClassifierOutputDataConfig)

clientRequestToken

CreateDocumentClassifierRequest.Builder clientRequestToken(String clientRequestToken)

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Parameters:

clientRequestToken - A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Returns:

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

languageCode

CreateDocumentClassifierRequest.Builder languageCode(String languageCode)

The language of the input documents. You can specify any of the languages supported by Amazon Comprehend. All documents must be in the same language.

Parameters:

languageCode - The language of the input documents. You can specify any of the languages supported by Amazon Comprehend. All documents must be in the same language.

Returns:

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

See Also:

LanguageCode, LanguageCode

languageCode

CreateDocumentClassifierRequest.Builder languageCode(LanguageCode languageCode)

The language of the input documents. You can specify any of the languages supported by Amazon Comprehend. All documents must be in the same language.

Parameters:

languageCode - The language of the input documents. You can specify any of the languages supported by Amazon Comprehend. All documents must be in the same language.

Returns:

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

See Also:

LanguageCode, LanguageCode

volumeKmsKeyId

CreateDocumentClassifierRequest.Builder volumeKmsKeyId(String volumeKmsKeyId)

ID for the Amazon Web Services 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"

Parameters:

volumeKmsKeyId - ID for the Amazon Web Services 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"

Returns:

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

vpcConfig

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.

Parameters:

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.

Returns:

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

vpcConfig

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 method that creates an instance of the VpcConfig.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).

Parameters:

vpcConfig - a consumer that will call methods on VpcConfig.Builder

Returns:

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

See Also:

vpcConfig(VpcConfig)

mode

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 (|).

Parameters:

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 (|).

Returns:

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

See Also:

DocumentClassifierMode, DocumentClassifierMode

mode

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 (|).

Parameters:

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 (|).

Returns:

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

See Also:

DocumentClassifierMode, DocumentClassifierMode

modelKmsKeyId

CreateDocumentClassifierRequest.Builder modelKmsKeyId(String modelKmsKeyId)

ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId 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"

Parameters:

modelKmsKeyId - ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId 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"

Returns:

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

modelPolicy

CreateDocumentClassifierRequest.Builder modelPolicy(String modelPolicy)

The resource-based policy to attach to your custom document classifier model. You can use this policy to allow another Amazon Web Services account to import your custom model.

Provide your policy as a JSON body that you enter as a UTF-8 encoded string without line breaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:

"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"

To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:

'{"attribute": "value", "attribute": ["value"]}'

Parameters:

modelPolicy - The resource-based policy to attach to your custom document classifier model. You can use this policy to allow another Amazon Web Services account to import your custom model.

Provide your policy as a JSON body that you enter as a UTF-8 encoded string without line breaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:

"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"

To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:

'{"attribute": "value", "attribute": ["value"]}'

Returns:

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

overrideConfiguration

CreateDocumentClassifierRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateDocumentClassifierRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder