Interface DocumentClassificationJobProperties.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<DocumentClassificationJobProperties.Builder,
,DocumentClassificationJobProperties> SdkBuilder<DocumentClassificationJobProperties.Builder,
,DocumentClassificationJobProperties> SdkPojo
- Enclosing class:
DocumentClassificationJobProperties
-
Method Summary
Modifier and TypeMethodDescriptiondataAccessRoleArn
(String dataAccessRoleArn) The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.documentClassifierArn
(String documentClassifierArn) The Amazon Resource Name (ARN) that identifies the document classifier.The time that the document classification job completed.flywheelArn
(String flywheelArn) The Amazon Resource Number (ARN) of the flywheelinputDataConfig
(Consumer<InputDataConfig.Builder> inputDataConfig) The input data configuration that you supplied when you created the document classification job.inputDataConfig
(InputDataConfig inputDataConfig) The input data configuration that you supplied when you created the document classification job.The Amazon Resource Name (ARN) of the document classification job.The identifier assigned to the document classification job.The name that you assigned to the document classification job.The current status of the document classification job.The current status of the document classification job.A description of the status of the job.outputDataConfig
(Consumer<OutputDataConfig.Builder> outputDataConfig) The output data configuration that you supplied when you created the document classification job.outputDataConfig
(OutputDataConfig outputDataConfig) The output data configuration that you supplied when you created the document classification job.submitTime
(Instant submitTime) The time that the document classification job was submitted for processing.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.vpcConfig
(Consumer<VpcConfig.Builder> vpcConfig) Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job.Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
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
-
jobId
The identifier assigned to the document classification job.
- Parameters:
jobId
- The identifier assigned to the document classification job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
jobArn
The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
- Parameters:
jobArn
- The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
jobName
The name that you assigned to the document classification job.
- Parameters:
jobName
- The name that you assigned to the document classification job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
jobStatus
The current status of the document classification job. If the status is
FAILED
, theMessage
field shows the reason for the failure.- Parameters:
jobStatus
- The current status of the document classification job. If the status isFAILED
, theMessage
field shows the reason for the failure.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
jobStatus
The current status of the document classification job. If the status is
FAILED
, theMessage
field shows the reason for the failure.- Parameters:
jobStatus
- The current status of the document classification job. If the status isFAILED
, theMessage
field shows the reason for the failure.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
message
A description of the status of the job.
- Parameters:
message
- A description of the status of the job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
submitTime
The time that the document classification job was submitted for processing.
- Parameters:
submitTime
- The time that the document classification job was submitted for processing.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
endTime
The time that the document classification job completed.
- Parameters:
endTime
- The time that the document classification job completed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
documentClassifierArn
The Amazon Resource Name (ARN) that identifies the document classifier.
- Parameters:
documentClassifierArn
- The Amazon Resource Name (ARN) that identifies the document classifier.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
inputDataConfig
The input data configuration that you supplied when you created the document classification job.
- Parameters:
inputDataConfig
- The input data configuration that you supplied when you created the document classification job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
inputDataConfig
default DocumentClassificationJobProperties.Builder inputDataConfig(Consumer<InputDataConfig.Builder> inputDataConfig) The input data configuration that you supplied when you created the document classification job.
This is a convenience method that creates an instance of theInputDataConfig.Builder
avoiding the need to create one manually viaInputDataConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toinputDataConfig(InputDataConfig)
.- Parameters:
inputDataConfig
- a consumer that will call methods onInputDataConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
outputDataConfig
The output data configuration that you supplied when you created the document classification job.
- Parameters:
outputDataConfig
- The output data configuration that you supplied when you created the document classification job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
outputDataConfig
default DocumentClassificationJobProperties.Builder outputDataConfig(Consumer<OutputDataConfig.Builder> outputDataConfig) The output data configuration that you supplied when you created the document classification job.
This is a convenience method that creates an instance of theOutputDataConfig.Builder
avoiding the need to create one manually viaOutputDataConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tooutputDataConfig(OutputDataConfig)
.- Parameters:
outputDataConfig
- a consumer that will call methods onOutputDataConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
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
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.
- Parameters:
vpcConfig
- Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vpcConfig
default DocumentClassificationJobProperties.Builder vpcConfig(Consumer<VpcConfig.Builder> vpcConfig) Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.
This is a convenience method that creates an instance of theVpcConfig.Builder
avoiding the need to create one manually viaVpcConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovpcConfig(VpcConfig)
.- Parameters:
vpcConfig
- a consumer that will call methods onVpcConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
flywheelArn
The Amazon Resource Number (ARN) of the flywheel
- Parameters:
flywheelArn
- The Amazon Resource Number (ARN) of the flywheel- Returns:
- Returns a reference to this object so that method calls can be chained together.
-