DocumentClassificationJobProperties (AWS SDK for Java

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

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

@Generated(value="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 and Description

static interface DocumentClassificationJobProperties.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DocumentClassificationJobProperties.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DocumentClassificationJobProperties.Builder`	`builder()`
`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.
`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)`
`<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`	`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()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

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

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

- Method Detail
  - jobId
```
public String jobId()
```
    The identifier assigned to the document classification job.
    
    Returns:
    
    The identifier assigned to the document classification job.
  - jobName
```
public 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 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 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 String message()
```
    A description of the status of the job.
    
    Returns:
    
    A description of the status of the job.
  - submitTime
```
public 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 Instant endTime()
```
    The time that the document classification job completed.
    
    Returns:
    
    The time that the document classification job completed.
  - documentClassifierArn
```
public 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 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 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 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:
    
    The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
  - toBuilder
```
public DocumentClassificationJobProperties.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DocumentClassificationJobProperties.Builder,DocumentClassificationJobProperties>
    
    Returns:
    
    a builder for type T
  - builder
```
public static DocumentClassificationJobProperties.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DocumentClassificationJobProperties.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

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

jobName

jobStatus

jobStatusAsString

message

submitTime

endTime

documentClassifierArn

inputDataConfig

outputDataConfig

dataAccessRoleArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields