DocumentClassificationJobProperties (AWS SDK for Android

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

All Implemented Interfaces:

java.io.Serializable
```
public class DocumentClassificationJobProperties
extends java.lang.Object
implements java.io.Serializable
```
Provides information about a document classification job.

See Also:

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
`boolean`	`equals(java.lang.Object obj)`
`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`	`getDocumentClassifierArn()` The Amazon Resource Name (ARN) that identifies the document classifier.
`java.util.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.
`java.lang.String`	`getJobId()` The identifier assigned to the document classification job.
`java.lang.String`	`getJobName()` The name that you assigned to the document classification job.
`java.lang.String`	`getJobStatus()` The current status of the document classification job.
`java.lang.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.
`java.util.Date`	`getSubmitTime()` The time that the document classification job was submitted for processing.
`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 a private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job.
`int`	`hashCode()`
`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`	`setDocumentClassifierArn(java.lang.String documentClassifierArn)` The Amazon Resource Name (ARN) that identifies the document classifier.
`void`	`setEndTime(java.util.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(java.lang.String jobId)` The identifier assigned to the document classification job.
`void`	`setJobName(java.lang.String jobName)` The name that you assigned to the document classification job.
`void`	`setJobStatus(JobStatus jobStatus)` The current status of the document classification job.
`void`	`setJobStatus(java.lang.String jobStatus)` The current status of the document classification job.
`void`	`setMessage(java.lang.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(java.util.Date submitTime)` The time that the document classification job was submitted for processing.
`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 a private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DocumentClassificationJobProperties`	`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.
`DocumentClassificationJobProperties`	`withDocumentClassifierArn(java.lang.String documentClassifierArn)` The Amazon Resource Name (ARN) that identifies the document classifier.
`DocumentClassificationJobProperties`	`withEndTime(java.util.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(java.lang.String jobId)` The identifier assigned to the document classification job.
`DocumentClassificationJobProperties`	`withJobName(java.lang.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(java.lang.String jobStatus)` The current status of the document classification job.
`DocumentClassificationJobProperties`	`withMessage(java.lang.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(java.util.Date submitTime)` The time that the document classification job was submitted for processing.
`DocumentClassificationJobProperties`	`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.
`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
  - getJobId
```
public java.lang.String getJobId()
```
    The identifier assigned to the document classification job.
    
    Constraints:
    Length: 1 - 32
    Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
    
    Returns:
    
    The identifier assigned to the document classification job.
  - setJobId
```
public void setJobId(java.lang.String jobId)
```
    The identifier assigned to the document classification job.
    
    Constraints:
    Length: 1 - 32
    Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
    
    Parameters:
    
    jobId -
    The identifier assigned to the document classification job.
  - withJobId
```
public DocumentClassificationJobProperties withJobId(java.lang.String jobId)
```
    The identifier assigned to the document classification job.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 32
    Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
    
    Parameters:
    
    jobId -
    The identifier assigned to the document classification job.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getJobName
```
public java.lang.String getJobName()
```
    The name that you assigned to the document classification job.
    
    Constraints:
    Length: 1 - 256
    Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
    
    Returns:
    
    The name that you assigned to the document classification job.
  - setJobName
```
public void setJobName(java.lang.String jobName)
```
    The name that you assigned to the document classification job.
    
    Constraints:
    Length: 1 - 256
    Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
    
    Parameters:
    
    jobName -
    The name that you assigned to the document classification job.
  - withJobName
```
public DocumentClassificationJobProperties withJobName(java.lang.String jobName)
```
    The name that you assigned to the document classification 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}_.:/=+\-%@]*)$
    
    Parameters:
    
    jobName -
    The name that you assigned to the document classification job.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getJobStatus
```
public java.lang.String getJobStatus()
```
    The current status of the document classification job. If the status is FAILED, the Message field shows the reason for the failure.
    
    Constraints:
    Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
    
    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
  - setJobStatus
```
public void setJobStatus(java.lang.String jobStatus)
```
    The current status of the document classification job. If the status is FAILED, the Message field shows the reason for the failure.
    
    Constraints:
    Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
    
    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
  - withJobStatus
```
public DocumentClassificationJobProperties withJobStatus(java.lang.String jobStatus)
```
    The current status of the document classification job. If the status is FAILED, the Message field shows the reason for the failure.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - setJobStatus
```
public void setJobStatus(JobStatus jobStatus)
```
    The current status of the document classification job. If the status is FAILED, the Message field shows the reason for the failure.
    
    Constraints:
    Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
    
    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
  - 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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - getMessage
```
public java.lang.String getMessage()
```
    A description of the status of the job.
    
    Returns:
    
    A description of the status of the job.
  - setMessage
```
public void setMessage(java.lang.String message)
```
    A description of the status of the job.
    
    Parameters:
    
    message -
    A description of the status of the job.
  - withMessage
```
public DocumentClassificationJobProperties withMessage(java.lang.String message)
```
    A description of the status of the job.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    message -
    A description of the status of the job.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSubmitTime
```
public java.util.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.
  - setSubmitTime
```
public void setSubmitTime(java.util.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.
  - withSubmitTime
```
public DocumentClassificationJobProperties withSubmitTime(java.util.Date submitTime)
```
    The time that the document classification job was submitted for processing.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    submitTime -
    The time that the document classification job was submitted for processing.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEndTime
```
public java.util.Date getEndTime()
```
    The time that the document classification job completed.
    
    Returns:
    
    The time that the document classification job completed.
  - setEndTime
```
public void setEndTime(java.util.Date endTime)
```
    The time that the document classification job completed.
    
    Parameters:
    
    endTime -
    The time that the document classification job completed.
  - withEndTime
```
public DocumentClassificationJobProperties withEndTime(java.util.Date endTime)
```
    The time that the document classification job completed.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    endTime -
    The time that the document classification job completed.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getDocumentClassifierArn
```
public java.lang.String getDocumentClassifierArn()
```
    The Amazon Resource Name (ARN) that identifies the document classifier.
    
    Constraints:
    Length: - 256
    Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document -classifier/[a-zA-Z0-9](-*[a-zA-Z0-9])*
    
    Returns:
    
    The Amazon Resource Name (ARN) that identifies the document classifier.
  - setDocumentClassifierArn
```
public void setDocumentClassifierArn(java.lang.String documentClassifierArn)
```
    The Amazon Resource Name (ARN) that identifies the document classifier.
    
    Constraints:
    Length: - 256
    Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document -classifier/[a-zA-Z0-9](-*[a-zA-Z0-9])*
    
    Parameters:
    
    documentClassifierArn -
    The Amazon Resource Name (ARN) that identifies the document classifier.
  - withDocumentClassifierArn
```
public DocumentClassificationJobProperties withDocumentClassifierArn(java.lang.String documentClassifierArn)
```
    The Amazon Resource Name (ARN) that identifies the document classifier.
    
    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}:document -classifier/[a-zA-Z0-9](-*[a-zA-Z0-9])*
    
    Parameters:
    
    documentClassifierArn -
    The Amazon Resource Name (ARN) that identifies the document classifier.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
  - withInputDataConfig
```
public DocumentClassificationJobProperties withInputDataConfig(InputDataConfig inputDataConfig)
```
    The input data configuration that you supplied when you created the document classification job.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    inputDataConfig -
    The input data configuration that you supplied when you created the document classification job.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
  - withOutputDataConfig
```
public DocumentClassificationJobProperties withOutputDataConfig(OutputDataConfig outputDataConfig)
```
    The output data configuration that you supplied when you created the document classification job.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    outputDataConfig -
    The output data configuration that you supplied when you created the document classification job.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getDataAccessRoleArn
```
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.
    
    Constraints:
    Length: 20 - 2048
    Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
    
    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.
  - setDataAccessRoleArn
```
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.
    
    Constraints:
    Length: 20 - 2048
    Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
    
    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.
  - withDataAccessRoleArn
```
public DocumentClassificationJobProperties 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.
    
    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/.+
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getVolumeKmsKeyId
```
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
    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"
  - setVolumeKmsKeyId
```
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
    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"
  - withVolumeKmsKeyId
```
public DocumentClassificationJobProperties 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
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
  - 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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class DocumentClassificationJobProperties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocumentClassificationJobProperties

Method Detail

getJobId

setJobId

withJobId

getJobName

setJobName

withJobName

getJobStatus

setJobStatus

withJobStatus

setJobStatus

withJobStatus

getMessage

setMessage

withMessage

getSubmitTime

setSubmitTime

withSubmitTime

getEndTime

setEndTime

withEndTime

getDocumentClassifierArn

setDocumentClassifierArn

withDocumentClassifierArn

getInputDataConfig

setInputDataConfig

withInputDataConfig

getOutputDataConfig

setOutputDataConfig

withOutputDataConfig

getDataAccessRoleArn

setDataAccessRoleArn

withDataAccessRoleArn

getVolumeKmsKeyId

setVolumeKmsKeyId

withVolumeKmsKeyId

getVpcConfig

setVpcConfig

withVpcConfig

toString

hashCode

equals