java.lang.Object
- software.amazon.awssdk.services.comprehend.model.DocumentClassificationJobProperties

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<DocumentClassificationJobProperties.Builder,DocumentClassificationJobProperties>

@Generated("software.amazon.awssdk:codegen")
public final class DocumentClassificationJobProperties
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DocumentClassificationJobProperties.Builder,DocumentClassificationJobProperties>

Provides information about a document classification job.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DocumentClassificationJobProperties.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DocumentClassificationJobProperties.Builder`	`builder()`
`String`	`dataAccessRoleArn()`	The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
`String`	`documentClassifierArn()`	The Amazon Resource Name (ARN) that identifies the document classifier.
`Instant`	`endTime()`	The time that the document classification job completed.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`flywheelArn()`	The Amazon Resource Number (ARN) of the flywheel
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`InputDataConfig`	`inputDataConfig()`	The input data configuration that you supplied when you created the document classification job.
`String`	`jobArn()`	The Amazon Resource Name (ARN) of the document classification job.
`String`	`jobId()`	The identifier assigned to the document classification job.
`String`	`jobName()`	The name that you assigned to the document classification job.
`JobStatus`	`jobStatus()`	The current status of the document classification job.
`String`	`jobStatusAsString()`	The current status of the document classification job.
`String`	`message()`	A description of the status of the job.
`OutputDataConfig`	`outputDataConfig()`	The output data configuration that you supplied when you created the document classification job.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DocumentClassificationJobProperties.Builder>`	`serializableBuilderClass()`
`Instant`	`submitTime()`	The time that the document classification job was submitted for processing.
`DocumentClassificationJobProperties.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`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`	`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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - jobId
```
public final String jobId()
```
    The identifier assigned to the document classification job.
    
    Returns:
    
    The identifier assigned to the document classification job.
  - jobArn
```
public final String 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:
    
    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
  - jobName
```
public final String jobName()
```
    The name that you assigned to the document classification job.
    
    Returns:
    
    The name that you assigned to the document classification job.
  - jobStatus
```
public final JobStatus jobStatus()
```
    The current status of the document classification job. If the status is FAILED, the Message field shows the reason for the failure.
    
    If the service returns an enum value that is not available in the current SDK version, jobStatus will return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobStatusAsString().
    
    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
  - jobStatusAsString
```
public final String jobStatusAsString()
```
    The current status of the document classification job. If the status is FAILED, the Message field shows the reason for the failure.
    
    If the service returns an enum value that is not available in the current SDK version, jobStatus will return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobStatusAsString().
    
    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
  - message
```
public final String message()
```
    A description of the status of the job.
    
    Returns:
    
    A description of the status of the job.
  - submitTime
```
public final Instant submitTime()
```
    The time that the document classification job was submitted for processing.
    
    Returns:
    
    The time that the document classification job was submitted for processing.
  - endTime
```
public final Instant endTime()
```
    The time that the document classification job completed.
    
    Returns:
    
    The time that the document classification job completed.
  - documentClassifierArn
```
public final String documentClassifierArn()
```
    The Amazon Resource Name (ARN) that identifies the document classifier.
    
    Returns:
    
    The Amazon Resource Name (ARN) that identifies the document classifier.
  - inputDataConfig
```
public final InputDataConfig inputDataConfig()
```
    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.
  - outputDataConfig
```
public final OutputDataConfig outputDataConfig()
```
    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.
  - dataAccessRoleArn
```
public final String dataAccessRoleArn()
```
    The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
  - volumeKmsKeyId
```
public final 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. 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 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"
  - vpcConfig
```
public final 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:
    
    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.
  - flywheelArn
```
public final String flywheelArn()
```
    The Amazon Resource Number (ARN) of the flywheel
    
    Returns:
    
    The Amazon Resource Number (ARN) of the flywheel
  - toBuilder
```
public DocumentClassificationJobProperties.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DocumentClassificationJobProperties.Builder,DocumentClassificationJobProperties>
  - builder
```
public static DocumentClassificationJobProperties.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DocumentClassificationJobProperties.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DocumentClassificationJobProperties

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

jobId

jobArn

jobName

jobStatus

jobStatusAsString

message

submitTime

endTime

documentClassifierArn

inputDataConfig

outputDataConfig

dataAccessRoleArn

volumeKmsKeyId

vpcConfig

flywheelArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields