software.amazon.awssdk.services.comprehend.model

Interface StartKeyPhrasesDetectionJobResponse.Builder

All Superinterfaces:

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

Enclosing class:

StartKeyPhrasesDetectionJobResponse

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

Method Summary

Modifier and Type	Method and Description
StartKeyPhrasesDetectionJobResponse.Builder	jobArn(String jobArn) The Amazon Resource Name (ARN) of the key phrase detection job.
StartKeyPhrasesDetectionJobResponse.Builder	jobId(String jobId) The identifier generated for the job.
StartKeyPhrasesDetectionJobResponse.Builder	jobStatus(JobStatus jobStatus) The status of the job.
StartKeyPhrasesDetectionJobResponse.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

StartKeyPhrasesDetectionJobResponse.Builder jobId(String jobId)

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

Parameters:

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

Returns:

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

jobArn

StartKeyPhrasesDetectionJobResponse.Builder jobArn(String jobArn)

The Amazon Resource Name (ARN) of the key phrase detection 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>:key-phrases-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab

Parameters:

jobArn - The Amazon Resource Name (ARN) of the key phrase detection 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>:key-phrases-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab

Returns:

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

jobStatus

StartKeyPhrasesDetectionJobResponse.Builder jobStatus(String jobStatus)

The status of the job.

• SUBMITTED - The job has been received and is 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. To get details, use the operation.

Parameters:

jobStatus - The status of the job.

• SUBMITTED - The job has been received and is 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. To get details, use the operation.

Returns:

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

See Also:

JobStatus, JobStatus

jobStatus

StartKeyPhrasesDetectionJobResponse.Builder jobStatus(JobStatus jobStatus)

The status of the job.

• SUBMITTED - The job has been received and is 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. To get details, use the operation.

Parameters:

jobStatus - The status of the job.

• SUBMITTED - The job has been received and is 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. To get details, use the operation.

Returns:

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

See Also:

JobStatus, JobStatus