/* * Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.comprehend.model; import java.io.Serializable; public class StartKeyPhrasesDetectionJobResult implements Serializable { /** *
* The identifier generated for the job. To get the status of a job, use * this identifier with the operation. *
*
* Constraints:
* Length: 1 - 32
* Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
*/
private String jobId;
/**
*
* 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
*
* Constraints:
* Length: - 256
* Pattern:
* arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-
* Z0-9-]{1,64}
* /[a-zA-Z0-9](-*[a-zA-Z0-9])*((/dataset/[a-zA-Z0-9](-*[a-zA-Z0-
* 9])*)|(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*))?
*/
private String jobArn;
/**
*
* 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. *
*
* Constraints:
* Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED,
* STOP_REQUESTED, STOPPED
*/
private String jobStatus;
/**
*
* The identifier generated for the job. To get the status of a job, use * this identifier with the operation. *
*
* Constraints:
* Length: 1 - 32
* Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
*
* @return
* The identifier generated for the job. To get the status of a job, * use this identifier with the operation. *
*/ public String getJobId() { return jobId; } /** ** The identifier generated for the job. To get the status of a job, use * this identifier with the operation. *
*
* Constraints:
* Length: 1 - 32
* Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
*
* @param jobId
* The identifier generated for the job. To get the status of a * job, use this identifier with the operation. *
*/ public void setJobId(String jobId) { this.jobId = jobId; } /** ** The identifier generated for the job. To get the status of a job, use * this identifier with the operation. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: 1 - 32
* Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
*
* @param jobId
* The identifier generated for the job. To get the status of a * job, use this identifier with the operation. *
* @return A reference to this updated object so that method calls can be * chained together. */ public StartKeyPhrasesDetectionJobResult withJobId(String jobId) { this.jobId = jobId; return this; } /** ** 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
*
* Constraints:
* Length: - 256
* Pattern:
* arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-
* Z0-9-]{1,64}
* /[a-zA-Z0-9](-*[a-zA-Z0-9])*((/dataset/[a-zA-Z0-9](-*[a-zA-Z0-
* 9])*)|(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*))?
*
* @return
* 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
*
* 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
*
* Constraints:
* Length: - 256
* Pattern:
* arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-
* Z0-9-]{1,64}
* /[a-zA-Z0-9](-*[a-zA-Z0-9])*((/dataset/[a-zA-Z0-9](-*[a-zA-Z0-
* 9])*)|(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*))?
*
* @param 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
*
* 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 a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: - 256
* Pattern:
* arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-
* Z0-9-]{1,64}
* /[a-zA-Z0-9](-*[a-zA-Z0-9])*((/dataset/[a-zA-Z0-9](-*[a-zA-Z0-
* 9])*)|(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*))?
*
* @param 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
*
* 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. *
*
* Constraints:
* Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED,
* STOP_REQUESTED, STOPPED
*
* @return
* 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. *
** 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. *
*
* Constraints:
* Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED,
* STOP_REQUESTED, STOPPED
*
* @param 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. *
** 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 a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED,
* STOP_REQUESTED, STOPPED
*
* @param 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. *
** 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. *
*
* Constraints:
* Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED,
* STOP_REQUESTED, STOPPED
*
* @param 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. *
** 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 a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED,
* STOP_REQUESTED, STOPPED
*
* @param 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. *
*