public class StartEntitiesDetectionJobRequest extends AmazonWebServiceRequest implements java.io.Serializable
Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.
 This API can be used for either standard entity detection or custom entity
 recognition. In order to be used for custom entity recognition, the optional
 EntityRecognizerArn must be used in order to provide access to
 the recognizer being used to detect the custom entity.
 
| Constructor and Description | 
|---|
StartEntitiesDetectionJobRequest()  | 
| Modifier and Type | Method and Description | 
|---|---|
boolean | 
equals(java.lang.Object obj)  | 
java.lang.String | 
getClientRequestToken()
 A unique identifier for the request. 
 | 
java.lang.String | 
getDataAccessRoleArn()
 The Amazon Resource Name (ARN) of the AWS Identity and Access Management
 (IAM) role that grants Amazon Comprehend read access to your input data. 
 | 
java.lang.String | 
getEntityRecognizerArn()
 The Amazon Resource Name (ARN) that identifies the specific entity
 recognizer to be used by the  
StartEntitiesDetectionJob. | 
InputDataConfig | 
getInputDataConfig()
 Specifies the format and location of the input data for the job. 
 | 
java.lang.String | 
getJobName()
 The identifier of the job. 
 | 
java.lang.String | 
getLanguageCode()
 The language of the input documents. 
 | 
OutputDataConfig | 
getOutputDataConfig()
 Specifies where to send the output files. 
 | 
java.lang.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 entity detection
 job. 
 | 
int | 
hashCode()  | 
void | 
setClientRequestToken(java.lang.String clientRequestToken)
 A unique identifier for the request. 
 | 
void | 
setDataAccessRoleArn(java.lang.String dataAccessRoleArn)
 The Amazon Resource Name (ARN) of the AWS Identity and Access Management
 (IAM) role that grants Amazon Comprehend read access to your input data. 
 | 
void | 
setEntityRecognizerArn(java.lang.String entityRecognizerArn)
 The Amazon Resource Name (ARN) that identifies the specific entity
 recognizer to be used by the  
StartEntitiesDetectionJob. | 
void | 
setInputDataConfig(InputDataConfig inputDataConfig)
 Specifies the format and location of the input data for the job. 
 | 
void | 
setJobName(java.lang.String jobName)
 The identifier of the job. 
 | 
void | 
setLanguageCode(LanguageCode languageCode)
 The language of the input documents. 
 | 
void | 
setLanguageCode(java.lang.String languageCode)
 The language of the input documents. 
 | 
void | 
setOutputDataConfig(OutputDataConfig outputDataConfig)
 Specifies where to send the output files. 
 | 
void | 
setVolumeKmsKeyId(java.lang.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 entity detection
 job. 
 | 
java.lang.String | 
toString()
Returns a string representation of this object; useful for testing and
 debugging. 
 | 
StartEntitiesDetectionJobRequest | 
withClientRequestToken(java.lang.String clientRequestToken)
 A unique identifier for the request. 
 | 
StartEntitiesDetectionJobRequest | 
withDataAccessRoleArn(java.lang.String dataAccessRoleArn)
 The Amazon Resource Name (ARN) of the AWS Identity and Access Management
 (IAM) role that grants Amazon Comprehend read access to your input data. 
 | 
StartEntitiesDetectionJobRequest | 
withEntityRecognizerArn(java.lang.String entityRecognizerArn)
 The Amazon Resource Name (ARN) that identifies the specific entity
 recognizer to be used by the  
StartEntitiesDetectionJob. | 
StartEntitiesDetectionJobRequest | 
withInputDataConfig(InputDataConfig inputDataConfig)
 Specifies the format and location of the input data for the job. 
 | 
StartEntitiesDetectionJobRequest | 
withJobName(java.lang.String jobName)
 The identifier of the job. 
 | 
StartEntitiesDetectionJobRequest | 
withLanguageCode(LanguageCode languageCode)
 The language of the input documents. 
 | 
StartEntitiesDetectionJobRequest | 
withLanguageCode(java.lang.String languageCode)
 The language of the input documents. 
 | 
StartEntitiesDetectionJobRequest | 
withOutputDataConfig(OutputDataConfig outputDataConfig)
 Specifies where to send the output files. 
 | 
StartEntitiesDetectionJobRequest | 
withVolumeKmsKeyId(java.lang.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. 
 | 
StartEntitiesDetectionJobRequest | 
withVpcConfig(VpcConfig vpcConfig)
 Configuration parameters for an optional private Virtual Private Cloud
 (VPC) containing the resources you are using for your entity detection
 job. 
 | 
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollectorpublic InputDataConfig getInputDataConfig()
Specifies the format and location of the input data for the job.
Specifies the format and location of the input data for the job.
public void setInputDataConfig(InputDataConfig 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.
public StartEntitiesDetectionJobRequest withInputDataConfig(InputDataConfig inputDataConfig)
Specifies the format and location of the input data for the job.
Returns a reference to this object so that method calls can be chained together.
inputDataConfig - Specifies the format and location of the input data for the job.
public OutputDataConfig getOutputDataConfig()
Specifies where to send the output files.
Specifies where to send the output files.
public void setOutputDataConfig(OutputDataConfig outputDataConfig)
Specifies where to send the output files.
outputDataConfig - Specifies where to send the output files.
public StartEntitiesDetectionJobRequest withOutputDataConfig(OutputDataConfig outputDataConfig)
Specifies where to send the output files.
Returns a reference to this object so that method calls can be chained together.
outputDataConfig - Specifies where to send the output files.
public java.lang.String getDataAccessRoleArn()
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing -permissions.html#auth-role-permissions.
 Constraints:
 Length: 20 - 2048
 Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control- managing-permissions.html#auth-role-permissions.
public void setDataAccessRoleArn(java.lang.String dataAccessRoleArn)
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing -permissions.html#auth-role-permissions.
 Constraints:
 Length: 20 - 2048
 Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access- control-managing-permissions.html#auth-role-permissions.
public StartEntitiesDetectionJobRequest withDataAccessRoleArn(java.lang.String dataAccessRoleArn)
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing -permissions.html#auth-role-permissions.
Returns a reference to this object so that method calls can be chained together.
 Constraints:
 Length: 20 - 2048
 Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access- control-managing-permissions.html#auth-role-permissions.
public java.lang.String getJobName()
The identifier of the job.
 Constraints:
 Length: 1 - 256
 Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
The identifier of the job.
public void setJobName(java.lang.String jobName)
The identifier of the job.
 Constraints:
 Length: 1 - 256
 Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
jobName - The identifier of the job.
public StartEntitiesDetectionJobRequest withJobName(java.lang.String jobName)
The identifier of the job.
Returns a reference to this object so that method calls can be chained together.
 Constraints:
 Length: 1 - 256
 Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
jobName - The identifier of the job.
public java.lang.String getEntityRecognizerArn()
 The Amazon Resource Name (ARN) that identifies the specific entity
 recognizer to be used by the StartEntitiesDetectionJob. This
 ARN is optional and is only used for a custom entity recognition job.
 
 Constraints:
 Length:  - 256
 Pattern:
 arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity
 -recognizer/[a-zA-Z0-9](-*[a-zA-Z0-9])*
         The Amazon Resource Name (ARN) that identifies the specific
         entity recognizer to be used by the
         StartEntitiesDetectionJob. This ARN is optional and
         is only used for a custom entity recognition job.
         
public void setEntityRecognizerArn(java.lang.String entityRecognizerArn)
 The Amazon Resource Name (ARN) that identifies the specific entity
 recognizer to be used by the StartEntitiesDetectionJob. This
 ARN is optional and is only used for a custom entity recognition job.
 
 Constraints:
 Length:  - 256
 Pattern:
 arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity
 -recognizer/[a-zA-Z0-9](-*[a-zA-Z0-9])*
entityRecognizerArn - 
            The Amazon Resource Name (ARN) that identifies the specific
            entity recognizer to be used by the
            StartEntitiesDetectionJob. This ARN is optional
            and is only used for a custom entity recognition job.
            
public StartEntitiesDetectionJobRequest withEntityRecognizerArn(java.lang.String entityRecognizerArn)
 The Amazon Resource Name (ARN) that identifies the specific entity
 recognizer to be used by the StartEntitiesDetectionJob. This
 ARN is optional and is only used for a custom entity recognition job.
 
Returns a reference to this object so that method calls can be chained together.
 Constraints:
 Length:  - 256
 Pattern:
 arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity
 -recognizer/[a-zA-Z0-9](-*[a-zA-Z0-9])*
entityRecognizerArn - 
            The Amazon Resource Name (ARN) that identifies the specific
            entity recognizer to be used by the
            StartEntitiesDetectionJob. This ARN is optional
            and is only used for a custom entity recognition job.
            
public java.lang.String getLanguageCode()
The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.
 Constraints:
 Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.
LanguageCodepublic void setLanguageCode(java.lang.String languageCode)
The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.
 Constraints:
 Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
languageCode - The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.
LanguageCodepublic StartEntitiesDetectionJobRequest withLanguageCode(java.lang.String languageCode)
The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.
Returns a reference to this object so that method calls can be chained together.
 Constraints:
 Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
languageCode - The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.
LanguageCodepublic void setLanguageCode(LanguageCode languageCode)
The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.
 Constraints:
 Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
languageCode - The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.
LanguageCodepublic StartEntitiesDetectionJobRequest withLanguageCode(LanguageCode languageCode)
The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.
Returns a reference to this object so that method calls can be chained together.
 Constraints:
 Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
languageCode - The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.
LanguageCodepublic java.lang.String getClientRequestToken()
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
 Constraints:
 Length: 1 - 64
 Pattern: ^[a-zA-Z0-9-]+$
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
public void setClientRequestToken(java.lang.String clientRequestToken)
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
 Constraints:
 Length: 1 - 64
 Pattern: ^[a-zA-Z0-9-]+$
clientRequestToken - A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
public StartEntitiesDetectionJobRequest withClientRequestToken(java.lang.String clientRequestToken)
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
Returns a reference to this object so that method calls can be chained together.
 Constraints:
 Length: 1 - 64
 Pattern: ^[a-zA-Z0-9-]+$
clientRequestToken - A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
public java.lang.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"
 
 Constraints:
 Length:  - 2048
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"
         
public void setVolumeKmsKeyId(java.lang.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"
 
 Constraints:
 Length:  - 2048
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"
            
public StartEntitiesDetectionJobRequest withVolumeKmsKeyId(java.lang.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"
 
Returns a reference to this object so that method calls can be chained together.
 Constraints:
 Length:  - 2048
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"
            
public VpcConfig getVpcConfig()
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. For more information, see Amazon VPC.
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. For more information, see Amazon VPC.
public void setVpcConfig(VpcConfig vpcConfig)
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. 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 entity detection job. For more information, see Amazon VPC.
public StartEntitiesDetectionJobRequest withVpcConfig(VpcConfig vpcConfig)
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. For more information, see Amazon VPC.
Returns a reference to this object so that method calls can be chained together.
vpcConfig - Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. For more information, see Amazon VPC.
public java.lang.String toString()
toString in class java.lang.ObjectObject.toString()public int hashCode()
hashCode in class java.lang.Objectpublic boolean equals(java.lang.Object obj)
equals in class java.lang.ObjectCopyright © 2018 Amazon Web Services, Inc. All Rights Reserved.