Interface StartEntitiesDetectionJobResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, ComprehendResponse.Builder, CopyableBuilder<StartEntitiesDetectionJobResponse.Builder,StartEntitiesDetectionJobResponse>, SdkBuilder<StartEntitiesDetectionJobResponse.Builder,StartEntitiesDetectionJobResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
StartEntitiesDetectionJobResponse

  • Method Details

    • 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

      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

      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

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