software.amazon.awssdk.services.comprehend.model

Class StartDocumentClassificationJobResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.comprehend.model.ComprehendResponse

software.amazon.awssdk.services.comprehend.model.StartDocumentClassificationJobResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartDocumentClassificationJobResponse.Builder,StartDocumentClassificationJobResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class StartDocumentClassificationJobResponse
extends ComprehendResponse
implements ToCopyableBuilder<StartDocumentClassificationJobResponse.Builder,StartDocumentClassificationJobResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartDocumentClassificationJobResponse.Builder

Method Summary

Modifier and Type	Method and Description
static StartDocumentClassificationJobResponse.Builder	builder()
String	documentClassifierArn() The ARN of the custom classification model.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	jobArn() The Amazon Resource Name (ARN) of the document classification job.
String	jobId() The identifier generated for the job.
JobStatus	jobStatus() The status of the job:
String	jobStatusAsString() The status of the job:
List<SdkField<?>>	sdkFields()
static Class<? extends StartDocumentClassificationJobResponse.Builder>	serializableBuilderClass()
StartDocumentClassificationJobResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.comprehend.model.ComprehendResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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 generated for the job. To get the status of the job, use this identifier with the DescribeDocumentClassificationJob operation.

Returns:

The identifier generated for the job. To get the status of the job, use this identifier with the DescribeDocumentClassificationJob operation.

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

jobStatus

public final JobStatus jobStatus()

The status of the job:

• SUBMITTED - The job has been received and queued for processing.

• IN_PROGRESS - Amazon Comprehend is processing the job.

• COMPLETED - The job was successfully completed and the output is available.

• FAILED - The job did not complete. For details, use the DescribeDocumentClassificationJob operation.

• STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.

• STOPPED - The job was successfully stopped without completing.

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 status of the job:

• SUBMITTED - The job has been received and queued for processing.

• IN_PROGRESS - Amazon Comprehend is processing the job.

• COMPLETED - The job was successfully completed and the output is available.

• FAILED - The job did not complete. For details, use the DescribeDocumentClassificationJob operation.

• STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.

• STOPPED - The job was successfully stopped without completing.

See Also:

JobStatus

jobStatusAsString

public final String jobStatusAsString()

The status of the job:

• SUBMITTED - The job has been received and queued for processing.

• IN_PROGRESS - Amazon Comprehend is processing the job.

• COMPLETED - The job was successfully completed and the output is available.

• FAILED - The job did not complete. For details, use the DescribeDocumentClassificationJob operation.

• STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.

• STOPPED - The job was successfully stopped without completing.

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 status of the job:

• SUBMITTED - The job has been received and queued for processing.

• IN_PROGRESS - Amazon Comprehend is processing the job.

• COMPLETED - The job was successfully completed and the output is available.

• FAILED - The job did not complete. For details, use the DescribeDocumentClassificationJob operation.

• STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.

• STOPPED - The job was successfully stopped without completing.

See Also:

JobStatus

documentClassifierArn

public final String documentClassifierArn()

The ARN of the custom classification model.

Returns:

The ARN of the custom classification model.

toBuilder

public StartDocumentClassificationJobResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartDocumentClassificationJobResponse.Builder,StartDocumentClassificationJobResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static StartDocumentClassificationJobResponse.Builder builder()

serializableBuilderClass

public static Class<? extends StartDocumentClassificationJobResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo