com.amazonaws.services.personalize.model.CreateDatasetExportJobRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-personalize Show documentation
/*
* Copyright 2019-2024 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.personalize.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateDatasetExportJobRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name for the dataset export job.
*
*/
private String jobName;
/**
*
* The Amazon Resource Name (ARN) of the dataset that contains the data to export.
*
*/
private String datasetArn;
/**
*
* The data to export, based on how you imported the data. You can choose to export only BULK data that
* you imported using a dataset import job, only PUT data that you imported incrementally (using the
* console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is
* PUT.
*
*/
private String ingestionMode;
/**
*
* The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3
* bucket.
*
*/
private String roleArn;
/**
*
* The path to the Amazon S3 bucket where the job's output is stored.
*
*/
private DatasetExportJobOutput jobOutput;
/**
*
* A list of tags to apply to
* the dataset export job.
*
*/
private java.util.List tags;
/**
*
* The name for the dataset export job.
*
*
* @param jobName
* The name for the dataset export job.
*/
public void setJobName(String jobName) {
this.jobName = jobName;
}
/**
*
* The name for the dataset export job.
*
*
* @return The name for the dataset export job.
*/
public String getJobName() {
return this.jobName;
}
/**
*
* The name for the dataset export job.
*
*
* @param jobName
* The name for the dataset export job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateDatasetExportJobRequest withJobName(String jobName) {
setJobName(jobName);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the dataset that contains the data to export.
*
*
* @param datasetArn
* The Amazon Resource Name (ARN) of the dataset that contains the data to export.
*/
public void setDatasetArn(String datasetArn) {
this.datasetArn = datasetArn;
}
/**
*
* The Amazon Resource Name (ARN) of the dataset that contains the data to export.
*
*
* @return The Amazon Resource Name (ARN) of the dataset that contains the data to export.
*/
public String getDatasetArn() {
return this.datasetArn;
}
/**
*
* The Amazon Resource Name (ARN) of the dataset that contains the data to export.
*
*
* @param datasetArn
* The Amazon Resource Name (ARN) of the dataset that contains the data to export.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateDatasetExportJobRequest withDatasetArn(String datasetArn) {
setDatasetArn(datasetArn);
return this;
}
/**
*
* The data to export, based on how you imported the data. You can choose to export only BULK data that
* you imported using a dataset import job, only PUT data that you imported incrementally (using the
* console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is
* PUT.
*
*
* @param ingestionMode
* The data to export, based on how you imported the data. You can choose to export only BULK
* data that you imported using a dataset import job, only PUT data that you imported
* incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for
* both types. The default value is PUT.
* @see IngestionMode
*/
public void setIngestionMode(String ingestionMode) {
this.ingestionMode = ingestionMode;
}
/**
*
* The data to export, based on how you imported the data. You can choose to export only BULK data that
* you imported using a dataset import job, only PUT data that you imported incrementally (using the
* console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is
* PUT.
*
*
* @return The data to export, based on how you imported the data. You can choose to export only BULK
* data that you imported using a dataset import job, only PUT data that you imported
* incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for
* both types. The default value is PUT.
* @see IngestionMode
*/
public String getIngestionMode() {
return this.ingestionMode;
}
/**
*
* The data to export, based on how you imported the data. You can choose to export only BULK data that
* you imported using a dataset import job, only PUT data that you imported incrementally (using the
* console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is
* PUT.
*
*
* @param ingestionMode
* The data to export, based on how you imported the data. You can choose to export only BULK
* data that you imported using a dataset import job, only PUT data that you imported
* incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for
* both types. The default value is PUT.
* @return Returns a reference to this object so that method calls can be chained together.
* @see IngestionMode
*/
public CreateDatasetExportJobRequest withIngestionMode(String ingestionMode) {
setIngestionMode(ingestionMode);
return this;
}
/**
*
* The data to export, based on how you imported the data. You can choose to export only BULK data that
* you imported using a dataset import job, only PUT data that you imported incrementally (using the
* console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is
* PUT.
*
*
* @param ingestionMode
* The data to export, based on how you imported the data. You can choose to export only BULK
* data that you imported using a dataset import job, only PUT data that you imported
* incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for
* both types. The default value is PUT.
* @return Returns a reference to this object so that method calls can be chained together.
* @see IngestionMode
*/
public CreateDatasetExportJobRequest withIngestionMode(IngestionMode ingestionMode) {
this.ingestionMode = ingestionMode.toString();
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3
* bucket.
*
*
* @param roleArn
* The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output
* Amazon S3 bucket.
*/
public void setRoleArn(String roleArn) {
this.roleArn = roleArn;
}
/**
*
* The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3
* bucket.
*
*
* @return The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output
* Amazon S3 bucket.
*/
public String getRoleArn() {
return this.roleArn;
}
/**
*
* The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3
* bucket.
*
*
* @param roleArn
* The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output
* Amazon S3 bucket.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateDatasetExportJobRequest withRoleArn(String roleArn) {
setRoleArn(roleArn);
return this;
}
/**
*
* The path to the Amazon S3 bucket where the job's output is stored.
*
*
* @param jobOutput
* The path to the Amazon S3 bucket where the job's output is stored.
*/
public void setJobOutput(DatasetExportJobOutput jobOutput) {
this.jobOutput = jobOutput;
}
/**
*
* The path to the Amazon S3 bucket where the job's output is stored.
*
*
* @return The path to the Amazon S3 bucket where the job's output is stored.
*/
public DatasetExportJobOutput getJobOutput() {
return this.jobOutput;
}
/**
*
* The path to the Amazon S3 bucket where the job's output is stored.
*
*
* @param jobOutput
* The path to the Amazon S3 bucket where the job's output is stored.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateDatasetExportJobRequest withJobOutput(DatasetExportJobOutput jobOutput) {
setJobOutput(jobOutput);
return this;
}
/**
*
* A list of tags to apply to
* the dataset export job.
*
*
* @return A list of tags to
* apply to the dataset export job.
*/
public java.util.List getTags() {
return tags;
}
/**
*
* A list of tags to apply to
* the dataset export job.
*
*
* @param tags
* A list of tags to
* apply to the dataset export job.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(tags);
}
/**
*
* A list of tags to apply to
* the dataset export job.
*
*
* NOTE: 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.
*
*
* @param tags
* A list of tags to
* apply to the dataset export job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateDatasetExportJobRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new java.util.ArrayList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* A list of tags to apply to
* the dataset export job.
*
*
* @param tags
* A list of tags to
* apply to the dataset export job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateDatasetExportJobRequest withTags(java.util.Collection 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 (getJobName() != null)
sb.append("JobName: ").append(getJobName()).append(",");
if (getDatasetArn() != null)
sb.append("DatasetArn: ").append(getDatasetArn()).append(",");
if (getIngestionMode() != null)
sb.append("IngestionMode: ").append(getIngestionMode()).append(",");
if (getRoleArn() != null)
sb.append("RoleArn: ").append(getRoleArn()).append(",");
if (getJobOutput() != null)
sb.append("JobOutput: ").append(getJobOutput()).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 CreateDatasetExportJobRequest == false)
return false;
CreateDatasetExportJobRequest other = (CreateDatasetExportJobRequest) obj;
if (other.getJobName() == null ^ this.getJobName() == null)
return false;
if (other.getJobName() != null && other.getJobName().equals(this.getJobName()) == false)
return false;
if (other.getDatasetArn() == null ^ this.getDatasetArn() == null)
return false;
if (other.getDatasetArn() != null && other.getDatasetArn().equals(this.getDatasetArn()) == false)
return false;
if (other.getIngestionMode() == null ^ this.getIngestionMode() == null)
return false;
if (other.getIngestionMode() != null && other.getIngestionMode().equals(this.getIngestionMode()) == false)
return false;
if (other.getRoleArn() == null ^ this.getRoleArn() == null)
return false;
if (other.getRoleArn() != null && other.getRoleArn().equals(this.getRoleArn()) == false)
return false;
if (other.getJobOutput() == null ^ this.getJobOutput() == null)
return false;
if (other.getJobOutput() != null && other.getJobOutput().equals(this.getJobOutput()) == 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 + ((getJobName() == null) ? 0 : getJobName().hashCode());
hashCode = prime * hashCode + ((getDatasetArn() == null) ? 0 : getDatasetArn().hashCode());
hashCode = prime * hashCode + ((getIngestionMode() == null) ? 0 : getIngestionMode().hashCode());
hashCode = prime * hashCode + ((getRoleArn() == null) ? 0 : getRoleArn().hashCode());
hashCode = prime * hashCode + ((getJobOutput() == null) ? 0 : getJobOutput().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public CreateDatasetExportJobRequest clone() {
return (CreateDatasetExportJobRequest) super.clone();
}
}