/* * 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; /** *
* Provides information about an events detection job. *
*/ public class EventsDetectionJobProperties implements Serializable { /** ** The identifier assigned to the events detection job. *
*
* Constraints:
* Length: 1 - 32
* Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
*/
private String jobId;
/**
*
* The Amazon Resource Name (ARN) of the events 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>:events-detection-job/<job-id>
*
* The following is an example job ARN: *
*
* arn:aws:comprehend:us-west-2:111122223333:events-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 name you assigned the events detection job. *
*
* Constraints:
* Length: 1 - 256
* Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
*/
private String jobName;
/**
*
* The current status of the events detection job. *
*
* Constraints:
* Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED,
* STOP_REQUESTED, STOPPED
*/
private String jobStatus;
/**
*
* A description of the status of the events detection job. *
*/ private String message; /** ** The time that the events detection job was submitted for processing. *
*/ private java.util.Date submitTime; /** ** The time that the events detection job completed. *
*/ private java.util.Date endTime; /** ** The input data configuration that you supplied when you created the * events detection job. *
*/ private InputDataConfig inputDataConfig; /** ** The output data configuration that you supplied when you created the * events detection job. *
*/ private OutputDataConfig outputDataConfig; /** ** The language code of the input documents. *
*
* Constraints:
* Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
*/
private String languageCode;
/**
*
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon * Comprehend read access to your input data. *
*
* Constraints:
* Length: 20 - 2048
* Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
*/
private String dataAccessRoleArn;
/**
*
* The types of events that are detected by the job. *
*/ private java.util.List* The identifier assigned to the events detection job. *
*
* Constraints:
* Length: 1 - 32
* Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
*
* @return
* The identifier assigned to the events detection job. *
*/ public String getJobId() { return jobId; } /** ** The identifier assigned to the events detection job. *
*
* Constraints:
* Length: 1 - 32
* Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
*
* @param jobId
* The identifier assigned to the events detection job. *
*/ public void setJobId(String jobId) { this.jobId = jobId; } /** ** The identifier assigned to the events detection job. *
** 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 assigned to the events detection job. *
* @return A reference to this updated object so that method calls can be * chained together. */ public EventsDetectionJobProperties withJobId(String jobId) { this.jobId = jobId; return this; } /** ** The Amazon Resource Name (ARN) of the events 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>:events-detection-job/<job-id>
*
* The following is an example job ARN: *
*
* arn:aws:comprehend:us-west-2:111122223333:events-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 events 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>:events-detection-job/<job-id>
*
* The following is an example job ARN: *
*
* arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
*
* The Amazon Resource Name (ARN) of the events 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>:events-detection-job/<job-id>
*
* The following is an example job ARN: *
*
* arn:aws:comprehend:us-west-2:111122223333:events-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 events 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>:events-detection-job/<job-id>
*
* The following is an example job ARN: *
*
* arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
*
* The Amazon Resource Name (ARN) of the events 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>:events-detection-job/<job-id>
*
* The following is an example job ARN: *
*
* arn:aws:comprehend:us-west-2:111122223333:events-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 events 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>:events-detection-job/<job-id>
*
* The following is an example job ARN: *
*
* arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
*
* The name you assigned the events detection job. *
*
* Constraints:
* Length: 1 - 256
* Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
*
* @return
* The name you assigned the events detection job. *
*/ public String getJobName() { return jobName; } /** ** The name you assigned the events detection job. *
*
* Constraints:
* Length: 1 - 256
* Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
*
* @param jobName
* The name you assigned the events detection job. *
*/ public void setJobName(String jobName) { this.jobName = jobName; } /** ** The name you assigned the events detection job. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: 1 - 256
* Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
*
* @param jobName
* The name you assigned the events detection job. *
* @return A reference to this updated object so that method calls can be * chained together. */ public EventsDetectionJobProperties withJobName(String jobName) { this.jobName = jobName; return this; } /** ** The current status of the events detection job. *
*
* Constraints:
* Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED,
* STOP_REQUESTED, STOPPED
*
* @return
* The current status of the events detection job. *
* @see JobStatus */ public String getJobStatus() { return jobStatus; } /** ** The current status of the events detection job. *
*
* Constraints:
* Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED,
* STOP_REQUESTED, STOPPED
*
* @param jobStatus
* The current status of the events detection job. *
* @see JobStatus */ public void setJobStatus(String jobStatus) { this.jobStatus = jobStatus; } /** ** The current status of the events detection job. *
** 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 current status of the events detection job. *
* @return A reference to this updated object so that method calls can be * chained together. * @see JobStatus */ public EventsDetectionJobProperties withJobStatus(String jobStatus) { this.jobStatus = jobStatus; return this; } /** ** The current status of the events detection job. *
*
* Constraints:
* Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED,
* STOP_REQUESTED, STOPPED
*
* @param jobStatus
* The current status of the events detection job. *
* @see JobStatus */ public void setJobStatus(JobStatus jobStatus) { this.jobStatus = jobStatus.toString(); } /** ** The current status of the events detection job. *
** 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 current status of the events detection job. *
* @return A reference to this updated object so that method calls can be * chained together. * @see JobStatus */ public EventsDetectionJobProperties withJobStatus(JobStatus jobStatus) { this.jobStatus = jobStatus.toString(); return this; } /** ** A description of the status of the events detection job. *
* * @return* A description of the status of the events detection job. *
*/ public String getMessage() { return message; } /** ** A description of the status of the events detection job. *
* * @param message* A description of the status of the events detection job. *
*/ public void setMessage(String message) { this.message = message; } /** ** A description of the status of the events detection job. *
** Returns a reference to this object so that method calls can be chained * together. * * @param message
* A description of the status of the events detection job. *
* @return A reference to this updated object so that method calls can be * chained together. */ public EventsDetectionJobProperties withMessage(String message) { this.message = message; return this; } /** ** The time that the events detection job was submitted for processing. *
* * @return* The time that the events detection job was submitted for * processing. *
*/ public java.util.Date getSubmitTime() { return submitTime; } /** ** The time that the events detection job was submitted for processing. *
* * @param submitTime* The time that the events detection job was submitted for * processing. *
*/ public void setSubmitTime(java.util.Date submitTime) { this.submitTime = submitTime; } /** ** The time that the events detection job was submitted for processing. *
** Returns a reference to this object so that method calls can be chained * together. * * @param submitTime
* The time that the events detection job was submitted for * processing. *
* @return A reference to this updated object so that method calls can be * chained together. */ public EventsDetectionJobProperties withSubmitTime(java.util.Date submitTime) { this.submitTime = submitTime; return this; } /** ** The time that the events detection job completed. *
* * @return* The time that the events detection job completed. *
*/ public java.util.Date getEndTime() { return endTime; } /** ** The time that the events detection job completed. *
* * @param endTime* The time that the events detection job completed. *
*/ public void setEndTime(java.util.Date endTime) { this.endTime = endTime; } /** ** The time that the events detection job completed. *
** Returns a reference to this object so that method calls can be chained * together. * * @param endTime
* The time that the events detection job completed. *
* @return A reference to this updated object so that method calls can be * chained together. */ public EventsDetectionJobProperties withEndTime(java.util.Date endTime) { this.endTime = endTime; return this; } /** ** The input data configuration that you supplied when you created the * events detection job. *
* * @return* The input data configuration that you supplied when you created * the events detection job. *
*/ public InputDataConfig getInputDataConfig() { return inputDataConfig; } /** ** The input data configuration that you supplied when you created the * events detection job. *
* * @param inputDataConfig* The input data configuration that you supplied when you * created the events detection job. *
*/ public void setInputDataConfig(InputDataConfig inputDataConfig) { this.inputDataConfig = inputDataConfig; } /** ** The input data configuration that you supplied when you created the * events detection job. *
** Returns a reference to this object so that method calls can be chained * together. * * @param inputDataConfig
* The input data configuration that you supplied when you * created the events detection job. *
* @return A reference to this updated object so that method calls can be * chained together. */ public EventsDetectionJobProperties withInputDataConfig(InputDataConfig inputDataConfig) { this.inputDataConfig = inputDataConfig; return this; } /** ** The output data configuration that you supplied when you created the * events detection job. *
* * @return* The output data configuration that you supplied when you created * the events detection job. *
*/ public OutputDataConfig getOutputDataConfig() { return outputDataConfig; } /** ** The output data configuration that you supplied when you created the * events detection job. *
* * @param outputDataConfig* The output data configuration that you supplied when you * created the events detection job. *
*/ public void setOutputDataConfig(OutputDataConfig outputDataConfig) { this.outputDataConfig = outputDataConfig; } /** ** The output data configuration that you supplied when you created the * events detection job. *
** Returns a reference to this object so that method calls can be chained * together. * * @param outputDataConfig
* The output data configuration that you supplied when you * created the events detection job. *
* @return A reference to this updated object so that method calls can be * chained together. */ public EventsDetectionJobProperties withOutputDataConfig(OutputDataConfig outputDataConfig) { this.outputDataConfig = outputDataConfig; return this; } /** ** The language code of the input documents. *
*
* Constraints:
* Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
*
* @return
* The language code of the input documents. *
* @see LanguageCode */ public String getLanguageCode() { return languageCode; } /** ** The language code of the input documents. *
*
* Constraints:
* Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
*
* @param languageCode
* The language code of the input documents. *
* @see LanguageCode */ public void setLanguageCode(String languageCode) { this.languageCode = languageCode; } /** ** The language code of the input documents. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
*
* @param languageCode
* The language code of the input documents. *
* @return A reference to this updated object so that method calls can be * chained together. * @see LanguageCode */ public EventsDetectionJobProperties withLanguageCode(String languageCode) { this.languageCode = languageCode; return this; } /** ** The language code of the input documents. *
*
* Constraints:
* Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
*
* @param languageCode
* The language code of the input documents. *
* @see LanguageCode */ public void setLanguageCode(LanguageCode languageCode) { this.languageCode = languageCode.toString(); } /** ** The language code of the input documents. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
*
* @param languageCode
* The language code of the input documents. *
* @return A reference to this updated object so that method calls can be * chained together. * @see LanguageCode */ public EventsDetectionJobProperties withLanguageCode(LanguageCode languageCode) { this.languageCode = languageCode.toString(); return this; } /** ** The Amazon Resource Name (ARN) of the IAM role that grants Amazon * Comprehend read access to your input data. *
*
* Constraints:
* Length: 20 - 2048
* Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
*
* @return
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon * Comprehend read access to your input data. *
*/ public String getDataAccessRoleArn() { return dataAccessRoleArn; } /** ** The Amazon Resource Name (ARN) of the IAM role that grants Amazon * Comprehend read access to your input data. *
*
* Constraints:
* Length: 20 - 2048
* Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
*
* @param dataAccessRoleArn
* The Amazon Resource Name (ARN) of the IAM role that grants * Amazon Comprehend read access to your input data. *
*/ public void setDataAccessRoleArn(String dataAccessRoleArn) { this.dataAccessRoleArn = dataAccessRoleArn; } /** ** The Amazon Resource Name (ARN) of the IAM role that grants Amazon * Comprehend read access to your input data. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: 20 - 2048
* Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
*
* @param dataAccessRoleArn
* The Amazon Resource Name (ARN) of the IAM role that grants * Amazon Comprehend read access to your input data. *
* @return A reference to this updated object so that method calls can be * chained together. */ public EventsDetectionJobProperties withDataAccessRoleArn(String dataAccessRoleArn) { this.dataAccessRoleArn = dataAccessRoleArn; return this; } /** ** The types of events that are detected by the job. *
* * @return* The types of events that are detected by the job. *
*/ public java.util.List* The types of events that are detected by the job. *
* * @param targetEventTypes* The types of events that are detected by the job. *
*/ public void setTargetEventTypes(java.util.Collection* The types of events that are detected by the job. *
** Returns a reference to this object so that method calls can be chained * together. * * @param targetEventTypes
* The types of events that are detected by the job. *
* @return A reference to this updated object so that method calls can be * chained together. */ public EventsDetectionJobProperties withTargetEventTypes(String... targetEventTypes) { if (getTargetEventTypes() == null) { this.targetEventTypes = new java.util.ArrayList* The types of events that are detected by the job. *
** Returns a reference to this object so that method calls can be chained * together. * * @param targetEventTypes
* The types of events that are detected by the job. *
* @return A reference to this updated object so that method calls can be * chained together. */ public EventsDetectionJobProperties withTargetEventTypes( java.util.Collection