com.amazonaws.services.comprehend.model

Class CreateDocumentClassifierRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.comprehend.model.CreateDocumentClassifierRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateDocumentClassifierRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateDocumentClassifierRequest()

Method Summary

Modifier and Type	Method and Description
CreateDocumentClassifierRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientRequestToken() A unique identifier for the request.
String	getDataAccessRoleArn() The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
String	getDocumentClassifierName() The name of the document classifier.
DocumentClassifierInputDataConfig	getInputDataConfig() Specifies the format and location of the input data for the job.
String	getLanguageCode() The language of the input documents.
String	getMode() Indicates the mode in which the classifier will be trained.
DocumentClassifierOutputDataConfig	getOutputDataConfig() Enables the addition of output results configuration parameters for custom classifier jobs.
List<Tag>	getTags() Tags to be associated with the document classifier being created.
String	getVolumeKmsKeyId() 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.
VpcConfig	getVpcConfig() Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier.
int	hashCode()
void	setClientRequestToken(String clientRequestToken) A unique identifier for the request.
void	setDataAccessRoleArn(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.
void	setDocumentClassifierName(String documentClassifierName) The name of the document classifier.
void	setInputDataConfig(DocumentClassifierInputDataConfig inputDataConfig) Specifies the format and location of the input data for the job.
void	setLanguageCode(String languageCode) The language of the input documents.
void	setMode(String mode) Indicates the mode in which the classifier will be trained.
void	setOutputDataConfig(DocumentClassifierOutputDataConfig outputDataConfig) Enables the addition of output results configuration parameters for custom classifier jobs.
void	setTags(Collection<Tag> tags) Tags to be associated with the document classifier being created.
void	setVolumeKmsKeyId(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.
void	setVpcConfig(VpcConfig vpcConfig) Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier.
String	toString() Returns a string representation of this object.
CreateDocumentClassifierRequest	withClientRequestToken(String clientRequestToken) A unique identifier for the request.
CreateDocumentClassifierRequest	withDataAccessRoleArn(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	withDocumentClassifierName(String documentClassifierName) The name of the document classifier.
CreateDocumentClassifierRequest	withInputDataConfig(DocumentClassifierInputDataConfig inputDataConfig) Specifies the format and location of the input data for the job.
CreateDocumentClassifierRequest	withLanguageCode(LanguageCode languageCode) The language of the input documents.
CreateDocumentClassifierRequest	withLanguageCode(String languageCode) The language of the input documents.
CreateDocumentClassifierRequest	withMode(DocumentClassifierMode mode) Indicates the mode in which the classifier will be trained.
CreateDocumentClassifierRequest	withMode(String mode) Indicates the mode in which the classifier will be trained.
CreateDocumentClassifierRequest	withOutputDataConfig(DocumentClassifierOutputDataConfig outputDataConfig) Enables the addition of output results configuration parameters for custom classifier jobs.
CreateDocumentClassifierRequest	withTags(Collection<Tag> tags) Tags to be associated with the document classifier being created.
CreateDocumentClassifierRequest	withTags(Tag... tags) Tags to be associated with the document classifier being created.
CreateDocumentClassifierRequest	withVolumeKmsKeyId(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.
CreateDocumentClassifierRequest	withVpcConfig(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 class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateDocumentClassifierRequest

public CreateDocumentClassifierRequest()

Method Detail

setDocumentClassifierName

public void setDocumentClassifierName(String documentClassifierName)

The name of the document classifier.

Parameters:

documentClassifierName - The name of the document classifier.

getDocumentClassifierName

public String getDocumentClassifierName()

The name of the document classifier.

Returns:

The name of the document classifier.

withDocumentClassifierName

public CreateDocumentClassifierRequest withDocumentClassifierName(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.

setDataAccessRoleArn

public void setDataAccessRoleArn(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.

Parameters:

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

getDataAccessRoleArn

public String getDataAccessRoleArn()

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

Returns:

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

withDataAccessRoleArn

public CreateDocumentClassifierRequest withDataAccessRoleArn(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.

Parameters:

dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Management (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.

getTags

public List<Tag> getTags()

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.

Returns:

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.

setTags

public void setTags(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.

Parameters:

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.

withTags

public CreateDocumentClassifierRequest withTags(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.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

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

withTags

public CreateDocumentClassifierRequest withTags(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.

Parameters:

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.

Returns:

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

setInputDataConfig

public void setInputDataConfig(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.

getInputDataConfig

public DocumentClassifierInputDataConfig getInputDataConfig()

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

Returns:

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

withInputDataConfig

public CreateDocumentClassifierRequest withInputDataConfig(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.

setOutputDataConfig

public void setOutputDataConfig(DocumentClassifierOutputDataConfig outputDataConfig)

Enables the addition of output results configuration parameters for custom classifier jobs.

Parameters:

outputDataConfig - Enables the addition of output results configuration parameters for custom classifier jobs.

getOutputDataConfig

public DocumentClassifierOutputDataConfig getOutputDataConfig()

Enables the addition of output results configuration parameters for custom classifier jobs.

Returns:

Enables the addition of output results configuration parameters for custom classifier jobs.

withOutputDataConfig

public CreateDocumentClassifierRequest withOutputDataConfig(DocumentClassifierOutputDataConfig outputDataConfig)

Enables the addition of output results configuration parameters for custom classifier jobs.

Parameters:

outputDataConfig - Enables the addition of output results configuration parameters for custom classifier jobs.

Returns:

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

setClientRequestToken

public void setClientRequestToken(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.

getClientRequestToken

public String getClientRequestToken()

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

Returns:

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

withClientRequestToken

public CreateDocumentClassifierRequest withClientRequestToken(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.

setLanguageCode

public void setLanguageCode(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.

Parameters:

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.

See Also:

LanguageCode

getLanguageCode

public String getLanguageCode()

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.

Returns:

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.

See Also:

LanguageCode

withLanguageCode

public CreateDocumentClassifierRequest withLanguageCode(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.

Parameters:

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.

Returns:

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

See Also:

LanguageCode

withLanguageCode

public CreateDocumentClassifierRequest withLanguageCode(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.

Parameters:

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.

Returns:

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

See Also:

LanguageCode

setVolumeKmsKeyId

public void setVolumeKmsKeyId(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"

Parameters:

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"

getVolumeKmsKeyId

public String getVolumeKmsKeyId()

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"

Returns:

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"

withVolumeKmsKeyId

public CreateDocumentClassifierRequest withVolumeKmsKeyId(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"

Parameters:

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"

Returns:

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

setVpcConfig

public void setVpcConfig(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.

getVpcConfig

public VpcConfig getVpcConfig()

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:

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.

withVpcConfig

public CreateDocumentClassifierRequest withVpcConfig(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.

setMode

public void setMode(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 (|).

See Also:

DocumentClassifierMode

getMode

public String getMode()

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:

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

See Also:

DocumentClassifierMode

withMode

public CreateDocumentClassifierRequest withMode(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

withMode

public CreateDocumentClassifierRequest withMode(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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateDocumentClassifierRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()