Interface StartTopicsDetectionJobResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, ComprehendResponse.Builder, CopyableBuilder<StartTopicsDetectionJobResponse.Builder,StartTopicsDetectionJobResponse>, SdkBuilder<StartTopicsDetectionJobResponse.Builder,StartTopicsDetectionJobResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
StartTopicsDetectionJobResponse
public static interface StartTopicsDetectionJobResponse.Builder extends ComprehendResponse.Builder, SdkPojo, CopyableBuilder<StartTopicsDetectionJobResponse.Builder,StartTopicsDetectionJobResponse>

  • Method Details

    • jobId

      StartTopicsDetectionJobResponse.Builder jobId(String jobId)

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

      Parameters:
      jobId - The identifier generated for the job. To get the status of the job, use this identifier with the DescribeTopicDetectionJob operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobArn

      StartTopicsDetectionJobResponse.Builder jobArn(String jobArn)

      The Amazon Resource Name (ARN) of the topics 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>:topics-detection-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 topics 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>:topics-detection-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

      StartTopicsDetectionJobResponse.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 DescribeTopicDetectionJob 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 DescribeTopicDetectionJob operation.

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

    • jobStatus

      StartTopicsDetectionJobResponse.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 DescribeTopicDetectionJob 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 DescribeTopicDetectionJob operation.

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