software.amazon.awssdk.services.comprehend.model

Interface StartDocumentClassificationJobResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, ComprehendResponse.Builder, CopyableBuilder<StartDocumentClassificationJobResponse.Builder,StartDocumentClassificationJobResponse>, SdkBuilder<StartDocumentClassificationJobResponse.Builder,StartDocumentClassificationJobResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

StartDocumentClassificationJobResponse

public static interface StartDocumentClassificationJobResponse.Builder
extends ComprehendResponse.Builder, SdkPojo, CopyableBuilder<StartDocumentClassificationJobResponse.Builder,StartDocumentClassificationJobResponse>

Method Summary

Modifier and Type	Method and Description
StartDocumentClassificationJobResponse.Builder	documentClassifierArn(String documentClassifierArn) The ARN of the custom classification model.
StartDocumentClassificationJobResponse.Builder	jobArn(String jobArn) The Amazon Resource Name (ARN) of the document classification job.
StartDocumentClassificationJobResponse.Builder	jobId(String jobId) The identifier generated for the job.
StartDocumentClassificationJobResponse.Builder	jobStatus(JobStatus jobStatus) The status of the job:
StartDocumentClassificationJobResponse.Builder	jobStatus(String jobStatus) The status of the job:

Methods inherited from interface software.amazon.awssdk.services.comprehend.model.ComprehendResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

jobId

StartDocumentClassificationJobResponse.Builder jobId(String jobId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

jobArn

StartDocumentClassificationJobResponse.Builder jobArn(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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

jobStatus

StartDocumentClassificationJobResponse.Builder jobStatus(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

JobStatus, JobStatus

jobStatus

StartDocumentClassificationJobResponse.Builder jobStatus(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

JobStatus, JobStatus

documentClassifierArn

StartDocumentClassificationJobResponse.Builder documentClassifierArn(String documentClassifierArn)

The ARN of the custom classification model.

Parameters:

documentClassifierArn - The ARN of the custom classification model.

Returns:

Returns a reference to this object so that method calls can be chained together.