Package software.amazon.awssdk.services.comprehend.model

Interface StartEntitiesDetectionJobResponse.Builder

All Superinterfaces:

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

Enclosing class:

StartEntitiesDetectionJobResponse

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

Method Summary

Modifier and Type	Method	Description
StartEntitiesDetectionJobResponse.Builder	entityRecognizerArn(String entityRecognizerArn)	The ARN of the custom entity recognition model.
StartEntitiesDetectionJobResponse.Builder	jobArn(String jobArn)	The Amazon Resource Name (ARN) of the entities detection job.
StartEntitiesDetectionJobResponse.Builder	jobId(String jobId)	The identifier generated for the job.
StartEntitiesDetectionJobResponse.Builder	jobStatus(String jobStatus)	The status of the job.
StartEntitiesDetectionJobResponse.Builder	jobStatus(JobStatus 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.utils.builder.CopyableBuilder

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFields

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

sdkHttpResponse, sdkHttpResponse

Method Detail

jobId

StartEntitiesDetectionJobResponse.Builder jobId(String jobId)

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

Parameters:

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

Returns:

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

jobArn

StartEntitiesDetectionJobResponse.Builder jobArn(String jobArn)

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

The following is an example job ARN:

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

Parameters:

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

The following is an example job ARN:

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

Returns:

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

jobStatus

StartEntitiesDetectionJobResponse.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.

• 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 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.

• 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

StartEntitiesDetectionJobResponse.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.

• 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 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.

• 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

entityRecognizerArn

StartEntitiesDetectionJobResponse.Builder entityRecognizerArn(String entityRecognizerArn)

The ARN of the custom entity recognition model.

Parameters:

entityRecognizerArn - The ARN of the custom entity recognition model.

Returns:

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