DocumentClassificationJobProperties (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.comprehend.model.DocumentClassificationJobProperties

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Provides information about a document classification job.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DocumentClassificationJobProperties()

Constructors
Constructor and Description
`DocumentClassificationJobProperties()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DocumentClassificationJobProperties`	`clone()`
`boolean`	`equals(Object obj)`
`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.
`String`	`getDocumentClassifierArn()` The Amazon Resource Name (ARN) that identifies the document classifier.
`Date`	`getEndTime()` The time that the document classification job completed.
`InputDataConfig`	`getInputDataConfig()` The input data configuration that you supplied when you created the document classification job.
`String`	`getJobId()` The identifier assigned to the document classification job.
`String`	`getJobName()` The name that you assigned to the document classification job.
`String`	`getJobStatus()` The current status of the document classification job.
`String`	`getMessage()` A description of the status of the job.
`OutputDataConfig`	`getOutputDataConfig()` The output data configuration that you supplied when you created the document classification job.
`Date`	`getSubmitTime()` The time that the document classification job was submitted for processing.
`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 a private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDataAccessRoleArn(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`	`setDocumentClassifierArn(String documentClassifierArn)` The Amazon Resource Name (ARN) that identifies the document classifier.
`void`	`setEndTime(Date endTime)` The time that the document classification job completed.
`void`	`setInputDataConfig(InputDataConfig inputDataConfig)` The input data configuration that you supplied when you created the document classification job.
`void`	`setJobId(String jobId)` The identifier assigned to the document classification job.
`void`	`setJobName(String jobName)` The name that you assigned to the document classification job.
`void`	`setJobStatus(String jobStatus)` The current status of the document classification job.
`void`	`setMessage(String message)` A description of the status of the job.
`void`	`setOutputDataConfig(OutputDataConfig outputDataConfig)` The output data configuration that you supplied when you created the document classification job.
`void`	`setSubmitTime(Date submitTime)` The time that the document classification job was submitted for processing.
`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 a private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job.
`String`	`toString()` Returns a string representation of this object.
`DocumentClassificationJobProperties`	`withDataAccessRoleArn(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.
`DocumentClassificationJobProperties`	`withDocumentClassifierArn(String documentClassifierArn)` The Amazon Resource Name (ARN) that identifies the document classifier.
`DocumentClassificationJobProperties`	`withEndTime(Date endTime)` The time that the document classification job completed.
`DocumentClassificationJobProperties`	`withInputDataConfig(InputDataConfig inputDataConfig)` The input data configuration that you supplied when you created the document classification job.
`DocumentClassificationJobProperties`	`withJobId(String jobId)` The identifier assigned to the document classification job.
`DocumentClassificationJobProperties`	`withJobName(String jobName)` The name that you assigned to the document classification job.
`DocumentClassificationJobProperties`	`withJobStatus(JobStatus jobStatus)` The current status of the document classification job.
`DocumentClassificationJobProperties`	`withJobStatus(String jobStatus)` The current status of the document classification job.
`DocumentClassificationJobProperties`	`withMessage(String message)` A description of the status of the job.
`DocumentClassificationJobProperties`	`withOutputDataConfig(OutputDataConfig outputDataConfig)` The output data configuration that you supplied when you created the document classification job.
`DocumentClassificationJobProperties`	`withSubmitTime(Date submitTime)` The time that the document classification job was submitted for processing.
`DocumentClassificationJobProperties`	`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.
`DocumentClassificationJobProperties`	`withVpcConfig(VpcConfig vpcConfig)` Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DocumentClassificationJobProperties
```
public DocumentClassificationJobProperties()
```
- Method Detail
  - setJobId
```
public void setJobId(String jobId)
```
    The identifier assigned to the document classification job.
    
    Parameters:
    
    jobId - The identifier assigned to the document classification job.
  - getJobId
```
public String getJobId()
```
    The identifier assigned to the document classification job.
    
    Returns:
    
    The identifier assigned to the document classification job.
  - withJobId
```
public DocumentClassificationJobProperties withJobId(String 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.
  - setJobName
```
public void setJobName(String jobName)
```
    The name that you assigned to the document classification job.
    
    Parameters:
    
    jobName - The name that you assigned to the document classification job.
  - getJobName
```
public String getJobName()
```
    The name that you assigned to the document classification job.
    
    Returns:
    
    The name that you assigned to the document classification job.
  - withJobName
```
public DocumentClassificationJobProperties withJobName(String 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.
  - setJobStatus
```
public void setJobStatus(String jobStatus)
```
    The current status of the document classification job. If the status is FAILED, the Message field shows the reason for the failure.
    
    Parameters:
    
    jobStatus - The current status of the document classification job. If the status is FAILED, the Message field shows the reason for the failure.
    
    See Also:
    
    JobStatus
  - getJobStatus
```
public String getJobStatus()
```
    The current status of the document classification job. If the status is FAILED, the Message field shows the reason for the failure.
    
    Returns:
    
    The current status of the document classification job. If the status is FAILED, the Message field shows the reason for the failure.
    
    See Also:
    
    JobStatus
  - withJobStatus
```
public DocumentClassificationJobProperties withJobStatus(String jobStatus)
```
    The current status of the document classification job. If the status is FAILED, the Message field shows the reason for the failure.
    
    Parameters:
    
    jobStatus - The current status of the document classification job. If the status is FAILED, the Message 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
  - withJobStatus
```
public DocumentClassificationJobProperties withJobStatus(JobStatus jobStatus)
```
    The current status of the document classification job. If the status is FAILED, the Message field shows the reason for the failure.
    
    Parameters:
    
    jobStatus - The current status of the document classification job. If the status is FAILED, the Message 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
  - setMessage
```
public void setMessage(String message)
```
    A description of the status of the job.
    
    Parameters:
    
    message - A description of the status of the job.
  - getMessage
```
public String getMessage()
```
    A description of the status of the job.
    
    Returns:
    
    A description of the status of the job.
  - withMessage
```
public DocumentClassificationJobProperties withMessage(String 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.
  - setSubmitTime
```
public void setSubmitTime(Date 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.
  - getSubmitTime
```
public Date getSubmitTime()
```
    The time that the document classification job was submitted for processing.
    
    Returns:
    
    The time that the document classification job was submitted for processing.
  - withSubmitTime
```
public DocumentClassificationJobProperties withSubmitTime(Date 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.
  - setEndTime
```
public void setEndTime(Date endTime)
```
    The time that the document classification job completed.
    
    Parameters:
    
    endTime - The time that the document classification job completed.
  - getEndTime
```
public Date getEndTime()
```
    The time that the document classification job completed.
    
    Returns:
    
    The time that the document classification job completed.
  - withEndTime
```
public DocumentClassificationJobProperties withEndTime(Date 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.
  - setDocumentClassifierArn
```
public void setDocumentClassifierArn(String documentClassifierArn)
```
    The Amazon Resource Name (ARN) that identifies the document classifier.
    
    Parameters:
    
    documentClassifierArn - The Amazon Resource Name (ARN) that identifies the document classifier.
  - getDocumentClassifierArn
```
public String getDocumentClassifierArn()
```
    The Amazon Resource Name (ARN) that identifies the document classifier.
    
    Returns:
    
    The Amazon Resource Name (ARN) that identifies the document classifier.
  - withDocumentClassifierArn
```
public DocumentClassificationJobProperties withDocumentClassifierArn(String 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.
  - setInputDataConfig
```
public void setInputDataConfig(InputDataConfig 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.
  - getInputDataConfig
```
public InputDataConfig getInputDataConfig()
```
    The input data configuration that you supplied when you created the document classification job.
    
    Returns:
    
    The input data configuration that you supplied when you created the document classification job.
  - withInputDataConfig
```
public DocumentClassificationJobProperties withInputDataConfig(InputDataConfig 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.
  - setOutputDataConfig
```
public void setOutputDataConfig(OutputDataConfig 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.
  - getOutputDataConfig
```
public OutputDataConfig getOutputDataConfig()
```
    The output data configuration that you supplied when you created the document classification job.
    
    Returns:
    
    The output data configuration that you supplied when you created the document classification job.
  - withOutputDataConfig
```
public DocumentClassificationJobProperties withOutputDataConfig(OutputDataConfig 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.
  - setDataAccessRoleArn
```
public void setDataAccessRoleArn(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.
    
    Parameters:
    
    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.
  - getDataAccessRoleArn
```
public 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.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
  - withDataAccessRoleArn
```
public DocumentClassificationJobProperties withDataAccessRoleArn(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 DocumentClassificationJobProperties 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 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.
  - getVpcConfig
```
public VpcConfig getVpcConfig()
```
    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:
    
    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.
  - withVpcConfig
```
public DocumentClassificationJobProperties withVpcConfig(VpcConfig 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.
  - 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 DocumentClassificationJobProperties clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class DocumentClassificationJobProperties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocumentClassificationJobProperties

Method Detail

setJobId

getJobId

withJobId

setJobName

getJobName

withJobName

setJobStatus

getJobStatus

withJobStatus

withJobStatus

setMessage

getMessage

withMessage

setSubmitTime

getSubmitTime

withSubmitTime

setEndTime

getEndTime

withEndTime

setDocumentClassifierArn

getDocumentClassifierArn

withDocumentClassifierArn

setInputDataConfig

getInputDataConfig

withInputDataConfig

setOutputDataConfig

getOutputDataConfig

withOutputDataConfig

setDataAccessRoleArn

getDataAccessRoleArn

withDataAccessRoleArn

setVolumeKmsKeyId

getVolumeKmsKeyId

withVolumeKmsKeyId

setVpcConfig

getVpcConfig

withVpcConfig

toString

equals

hashCode

clone

marshall