/* * Copyright 2018-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; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* Provides information about an events detection job. *
* * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class EventsDetectionJobProperties implements Serializable, Cloneable, StructuredPojo { /** ** The identifier assigned to the events detection job. *
*/ 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
*
* The name you assigned the events detection job. *
*/ private String jobName; /** ** The current status of the events detection job. *
*/ 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. *
*/ private String languageCode; /** ** The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. *
*/ 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. *
* * @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. *
* * @return The identifier assigned to the events detection job. */ public String getJobId() { return this.jobId; } /** ** The identifier assigned to the events detection job. *
* * @param jobId * The identifier assigned to the events detection job. * @return Returns a reference to this object so that method calls can be chained together. */ public EventsDetectionJobProperties withJobId(String jobId) { setJobId(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
*
* 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
*/
public void setJobArn(String jobArn) {
this.jobArn = 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
*
* 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
*/
public String getJobArn() {
return this.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
*
* 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
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EventsDetectionJobProperties withJobArn(String jobArn) {
setJobArn(jobArn);
return this;
}
/**
*
* The name you assigned the events detection job. *
* * @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. *
* * @return The name you assigned the events detection job. */ public String getJobName() { return this.jobName; } /** ** The name you assigned the events detection job. *
* * @param jobName * The name you assigned the events detection job. * @return Returns a reference to this object so that method calls can be chained together. */ public EventsDetectionJobProperties withJobName(String jobName) { setJobName(jobName); return this; } /** ** The current status of the events detection job. *
* * @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. *
* * @return The current status of the events detection job. * @see JobStatus */ public String getJobStatus() { return this.jobStatus; } /** ** The current status of the events detection job. *
* * @param jobStatus * The current status of the events detection job. * @return Returns a reference to this object so that method calls can be chained together. * @see JobStatus */ public EventsDetectionJobProperties withJobStatus(String jobStatus) { setJobStatus(jobStatus); return this; } /** ** The current status of the events detection job. *
* * @param jobStatus * The current status of the events detection job. * @return Returns a reference to this 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. *
* * @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. *
* * @return A description of the status of the events detection job. */ public String getMessage() { return this.message; } /** ** A description of the status of the events detection job. *
* * @param message * A description of the status of the events detection job. * @return Returns a reference to this object so that method calls can be chained together. */ public EventsDetectionJobProperties withMessage(String message) { setMessage(message); return this; } /** ** 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. *
* * @return The time that the events detection job was submitted for processing. */ public java.util.Date getSubmitTime() { return this.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. * @return Returns a reference to this object so that method calls can be chained together. */ public EventsDetectionJobProperties withSubmitTime(java.util.Date submitTime) { setSubmitTime(submitTime); return this; } /** ** 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. *
* * @return The time that the events detection job completed. */ public java.util.Date getEndTime() { return this.endTime; } /** ** The time that the events detection job completed. *
* * @param endTime * The time that the events detection job completed. * @return Returns a reference to this object so that method calls can be chained together. */ public EventsDetectionJobProperties withEndTime(java.util.Date endTime) { setEndTime(endTime); return this; } /** ** 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. *
* * @return The input data configuration that you supplied when you created the events detection job. */ public InputDataConfig getInputDataConfig() { return this.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. * @return Returns a reference to this object so that method calls can be chained together. */ public EventsDetectionJobProperties withInputDataConfig(InputDataConfig inputDataConfig) { setInputDataConfig(inputDataConfig); return this; } /** ** 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. *
* * @return The output data configuration that you supplied when you created the events detection job. */ public OutputDataConfig getOutputDataConfig() { return this.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. * @return Returns a reference to this object so that method calls can be chained together. */ public EventsDetectionJobProperties withOutputDataConfig(OutputDataConfig outputDataConfig) { setOutputDataConfig(outputDataConfig); return this; } /** ** The language code of the input documents. *
* * @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. *
* * @return The language code of the input documents. * @see LanguageCode */ public String getLanguageCode() { return this.languageCode; } /** ** The language code of the input documents. *
* * @param languageCode * The language code of the input documents. * @return Returns a reference to this object so that method calls can be chained together. * @see LanguageCode */ public EventsDetectionJobProperties withLanguageCode(String languageCode) { setLanguageCode(languageCode); return this; } /** ** The language code of the input documents. *
* * @param languageCode * The language code of the input documents. * @return Returns a reference to this 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. *
* * @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. *
* * @return The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input * data. */ public String getDataAccessRoleArn() { return this.dataAccessRoleArn; } /** ** The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. *
* * @param dataAccessRoleArn * The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input * data. * @return Returns a reference to this object so that method calls can be chained together. */ public EventsDetectionJobProperties withDataAccessRoleArn(String dataAccessRoleArn) { setDataAccessRoleArn(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. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setTargetEventTypes(java.util.Collection)} or {@link #withTargetEventTypes(java.util.Collection)} if you * want to override the existing values. *
* * @param targetEventTypes * The types of events that are detected by the job. * @return Returns a reference to this object so that method calls can be chained together. */ public EventsDetectionJobProperties withTargetEventTypes(String... targetEventTypes) { if (this.targetEventTypes == null) { setTargetEventTypes(new java.util.ArrayList* The types of events that are detected by the job. *
* * @param targetEventTypes * The types of events that are detected by the job. * @return Returns a reference to this object so that method calls can be chained together. */ public EventsDetectionJobProperties withTargetEventTypes(java.util.Collection