/*
* 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.AmazonWebServiceRequest;
/**
*
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEventsDetectionJob" target="_top">AWS
* API Documentation</a>
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class StartEventsDetectionJobRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
* <p>
* Specifies the format and location of the input data for the job.
* </p>
*/
private InputDataConfig inputDataConfig;
/**
* <p>
* Specifies where to send the output files.
* </p>
*/
private OutputDataConfig outputDataConfig;
/**
* <p>
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
* </p>
*/
private String dataAccessRoleArn;
/**
* <p>
* The identifier of the events detection job.
* </p>
*/
private String jobName;
/**
* <p>
* The language code of the input documents.
* </p>
*/
private String languageCode;
/**
* <p>
* An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
* </p>
*/
private String clientRequestToken;
/**
* <p>
* The types of events to detect in the input documents.
* </p>
*/
private java.util.List<String> targetEventTypes;
/**
* <p>
* Tags to associate with the events detection job. A tag is a key-value pair that adds metadata to a resource used
* by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use
* by the sales department.
* </p>
*/
private java.util.List<Tag> tags;
/**
* <p>
* Specifies the format and location of the input data for the job.
* </p>
*
* @param inputDataConfig
* Specifies the format and location of the input data for the job.
*/
public void setInputDataConfig(InputDataConfig inputDataConfig) {
this.inputDataConfig = inputDataConfig;
}
/**
* <p>
* Specifies the format and location of the input data for the job.
* </p>
*
* @return Specifies the format and location of the input data for the job.
*/
public InputDataConfig getInputDataConfig() {
return this.inputDataConfig;
}
/**
* <p>
* Specifies the format and location of the input data for the job.
* </p>
*
* @param inputDataConfig
* Specifies the format and location of the input data for the job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartEventsDetectionJobRequest withInputDataConfig(InputDataConfig inputDataConfig) {
setInputDataConfig(inputDataConfig);
return this;
}
/**
* <p>
* Specifies where to send the output files.
* </p>
*
* @param outputDataConfig
* Specifies where to send the output files.
*/
public void setOutputDataConfig(OutputDataConfig outputDataConfig) {
this.outputDataConfig = outputDataConfig;
}
/**
* <p>
* Specifies where to send the output files.
* </p>
*
* @return Specifies where to send the output files.
*/
public OutputDataConfig getOutputDataConfig() {
return this.outputDataConfig;
}
/**
* <p>
* Specifies where to send the output files.
* </p>
*
* @param outputDataConfig
* Specifies where to send the output files.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartEventsDetectionJobRequest withOutputDataConfig(OutputDataConfig outputDataConfig) {
setOutputDataConfig(outputDataConfig);
return this;
}
/**
* <p>
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
* </p>
*
* @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;
}
/**
* <p>
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
* </p>
*
* @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;
}
/**
* <p>
* The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
* </p>
*
* @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 StartEventsDetectionJobRequest withDataAccessRoleArn(String dataAccessRoleArn) {
setDataAccessRoleArn(dataAccessRoleArn);
return this;
}
/**
* <p>
* The identifier of the events detection job.
* </p>
*
* @param jobName
* The identifier of the events detection job.
*/
public void setJobName(String jobName) {
this.jobName = jobName;
}
/**
* <p>
* The identifier of the events detection job.
* </p>
*
* @return The identifier of the events detection job.
*/
public String getJobName() {
return this.jobName;
}
/**
* <p>
* The identifier of the events detection job.
* </p>
*
* @param jobName
* The identifier of the events detection job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartEventsDetectionJobRequest withJobName(String jobName) {
setJobName(jobName);
return this;
}
/**
* <p>
* The language code of the input documents.
* </p>
*
* @param languageCode
* The language code of the input documents.
* @see LanguageCode
*/
public void setLanguageCode(String languageCode) {
this.languageCode = languageCode;
}
/**
* <p>
* The language code of the input documents.
* </p>
*
* @return The language code of the input documents.
* @see LanguageCode
*/
public String getLanguageCode() {
return this.languageCode;
}
/**
* <p>
* The language code of the input documents.
* </p>
*
* @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 StartEventsDetectionJobRequest withLanguageCode(String languageCode) {
setLanguageCode(languageCode);
return this;
}
/**
* <p>
* The language code of the input documents.
* </p>
*
* @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 StartEventsDetectionJobRequest withLanguageCode(LanguageCode languageCode) {
this.languageCode = languageCode.toString();
return this;
}
/**
* <p>
* An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
* </p>
*
* @param clientRequestToken
* An unique identifier for the request. If you don't set the client request token, Amazon Comprehend
* generates one.
*/
public void setClientRequestToken(String clientRequestToken) {
this.clientRequestToken = clientRequestToken;
}
/**
* <p>
* An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
* </p>
*
* @return An unique identifier for the request. If you don't set the client request token, Amazon Comprehend
* generates one.
*/
public String getClientRequestToken() {
return this.clientRequestToken;
}
/**
* <p>
* An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
* </p>
*
* @param clientRequestToken
* An unique identifier for the request. If you don't set the client request token, Amazon Comprehend
* generates one.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartEventsDetectionJobRequest withClientRequestToken(String clientRequestToken) {
setClientRequestToken(clientRequestToken);
return this;
}
/**
* <p>
* The types of events to detect in the input documents.
* </p>
*
* @return The types of events to detect in the input documents.
*/
public java.util.List<String> getTargetEventTypes() {
return targetEventTypes;
}
/**
* <p>
* The types of events to detect in the input documents.
* </p>
*
* @param targetEventTypes
* The types of events to detect in the input documents.
*/
public void setTargetEventTypes(java.util.Collection<String> targetEventTypes) {
if (targetEventTypes == null) {
this.targetEventTypes = null;
return;
}
this.targetEventTypes = new java.util.ArrayList<String>(targetEventTypes);
}
/**
* <p>
* The types of events to detect in the input documents.
* </p>
* <p>
* <b>NOTE:</b> 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.
* </p>
*
* @param targetEventTypes
* The types of events to detect in the input documents.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartEventsDetectionJobRequest withTargetEventTypes(String... targetEventTypes) {
if (this.targetEventTypes == null) {
setTargetEventTypes(new java.util.ArrayList<String>(targetEventTypes.length));
}
for (String ele : targetEventTypes) {
this.targetEventTypes.add(ele);
}
return this;
}
/**
* <p>
* The types of events to detect in the input documents.
* </p>
*
* @param targetEventTypes
* The types of events to detect in the input documents.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartEventsDetectionJobRequest withTargetEventTypes(java.util.Collection<String> targetEventTypes) {
setTargetEventTypes(targetEventTypes);
return this;
}
/**
* <p>
* Tags to associate with the events detection job. A tag is a key-value pair that adds metadata to a resource used
* by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use
* by the sales department.
* </p>
*
* @return Tags to associate with the events detection job. A tag is a key-value pair that adds metadata to a
* resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a
* resource to indicate its use by the sales department.
*/
public java.util.List<Tag> getTags() {
return tags;
}
/**
* <p>
* Tags to associate with the events detection job. A tag is a key-value pair that adds metadata to a resource used
* by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use
* by the sales department.
* </p>
*
* @param tags
* Tags to associate with the events detection job. A tag is a key-value pair that adds metadata to a
* resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a
* resource to indicate its use by the sales department.
*/
public void setTags(java.util.Collection<Tag> tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList<Tag>(tags);
}
/**
* <p>
* Tags to associate with the events detection job. A tag is a key-value pair that adds metadata to a resource used
* by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use
* by the sales department.
* </p>
* <p>
* <b>NOTE:</b> This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
* </p>
*
* @param tags
* Tags to associate with the events detection job. A tag is a key-value pair that adds metadata to a
* resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a
* resource to indicate its use by the sales department.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartEventsDetectionJobRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new java.util.ArrayList<Tag>(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
* <p>
* Tags to associate with the events detection job. A tag is a key-value pair that adds metadata to a resource used
* by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use
* by the sales department.
* </p>
*
* @param tags
* Tags to associate with the events detection job. A tag is a key-value pair that adds metadata to a
* resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a
* resource to indicate its use by the sales department.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartEventsDetectionJobRequest withTags(java.util.Collection<Tag> tags) {
setTags(tags);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getInputDataConfig() != null)
sb.append("InputDataConfig: ").append(getInputDataConfig()).append(",");
if (getOutputDataConfig() != null)
sb.append("OutputDataConfig: ").append(getOutputDataConfig()).append(",");
if (getDataAccessRoleArn() != null)
sb.append("DataAccessRoleArn: ").append(getDataAccessRoleArn()).append(",");
if (getJobName() != null)
sb.append("JobName: ").append(getJobName()).append(",");
if (getLanguageCode() != null)
sb.append("LanguageCode: ").append(getLanguageCode()).append(",");
if (getClientRequestToken() != null)
sb.append("ClientRequestToken: ").append(getClientRequestToken()).append(",");
if (getTargetEventTypes() != null)
sb.append("TargetEventTypes: ").append(getTargetEventTypes()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof StartEventsDetectionJobRequest == false)
return false;
StartEventsDetectionJobRequest other = (StartEventsDetectionJobRequest) obj;
if (other.getInputDataConfig() == null ^ this.getInputDataConfig() == null)
return false;
if (other.getInputDataConfig() != null && other.getInputDataConfig().equals(this.getInputDataConfig()) == false)
return false;
if (other.getOutputDataConfig() == null ^ this.getOutputDataConfig() == null)
return false;
if (other.getOutputDataConfig() != null && other.getOutputDataConfig().equals(this.getOutputDataConfig()) == false)
return false;
if (other.getDataAccessRoleArn() == null ^ this.getDataAccessRoleArn() == null)
return false;
if (other.getDataAccessRoleArn() != null && other.getDataAccessRoleArn().equals(this.getDataAccessRoleArn()) == false)
return false;
if (other.getJobName() == null ^ this.getJobName() == null)
return false;
if (other.getJobName() != null && other.getJobName().equals(this.getJobName()) == false)
return false;
if (other.getLanguageCode() == null ^ this.getLanguageCode() == null)
return false;
if (other.getLanguageCode() != null && other.getLanguageCode().equals(this.getLanguageCode()) == false)
return false;
if (other.getClientRequestToken() == null ^ this.getClientRequestToken() == null)
return false;
if (other.getClientRequestToken() != null && other.getClientRequestToken().equals(this.getClientRequestToken()) == false)
return false;
if (other.getTargetEventTypes() == null ^ this.getTargetEventTypes() == null)
return false;
if (other.getTargetEventTypes() != null && other.getTargetEventTypes().equals(this.getTargetEventTypes()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getInputDataConfig() == null) ? 0 : getInputDataConfig().hashCode());
hashCode = prime * hashCode + ((getOutputDataConfig() == null) ? 0 : getOutputDataConfig().hashCode());
hashCode = prime * hashCode + ((getDataAccessRoleArn() == null) ? 0 : getDataAccessRoleArn().hashCode());
hashCode = prime * hashCode + ((getJobName() == null) ? 0 : getJobName().hashCode());
hashCode = prime * hashCode + ((getLanguageCode() == null) ? 0 : getLanguageCode().hashCode());
hashCode = prime * hashCode + ((getClientRequestToken() == null) ? 0 : getClientRequestToken().hashCode());
hashCode = prime * hashCode + ((getTargetEventTypes() == null) ? 0 : getTargetEventTypes().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public StartEventsDetectionJobRequest clone() {
return (StartEventsDetectionJobRequest) super.clone();
}
}