com.amazonaws.services.datasync.model.StartTaskExecutionRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-datasync 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.datasync.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* StartTaskExecutionRequest
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class StartTaskExecutionRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* Specifies the Amazon Resource Name (ARN) of the task that you want to start.
*
*/
private String taskArn;
private Options overrideOptions;
/**
*
* Specifies a list of filter rules that determines which files to include when running a task. The pattern should
* contain a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that
* is, a pipe), for example, "/folder1|/folder2".
*
*/
private java.util.List includes;
/**
*
* Specifies a list of filter rules that determines which files to exclude from a task. The list contains a single
* filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for
* example, "/folder1|/folder2".
*
*/
private java.util.List excludes;
/**
*
* Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more
* information and configuration examples, see Specifying what
* DataSync transfers by using a manifest.
*
*
* When using this parameter, your caller identity (the role that you're using DataSync with) must have the
* iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.
*
*
* To remove a manifest configuration, specify this parameter with an empty value.
*
*/
private ManifestConfig manifestConfig;
/**
*
* Specifies how you want to configure a task report, which provides detailed information about your DataSync
* transfer. For more information, see Monitoring your DataSync transfers
* with task reports.
*
*
* When using this parameter, your caller identity (the role that you're using DataSync with) must have the
* iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.
*
*
* To remove a task report configuration, specify this parameter as empty.
*
*/
private TaskReportConfig taskReportConfig;
/**
*
* Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task execution.
*
*
* Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.
*
*/
private java.util.List tags;
/**
*
* Specifies the Amazon Resource Name (ARN) of the task that you want to start.
*
*
* @param taskArn
* Specifies the Amazon Resource Name (ARN) of the task that you want to start.
*/
public void setTaskArn(String taskArn) {
this.taskArn = taskArn;
}
/**
*
* Specifies the Amazon Resource Name (ARN) of the task that you want to start.
*
*
* @return Specifies the Amazon Resource Name (ARN) of the task that you want to start.
*/
public String getTaskArn() {
return this.taskArn;
}
/**
*
* Specifies the Amazon Resource Name (ARN) of the task that you want to start.
*
*
* @param taskArn
* Specifies the Amazon Resource Name (ARN) of the task that you want to start.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartTaskExecutionRequest withTaskArn(String taskArn) {
setTaskArn(taskArn);
return this;
}
/**
* @param overrideOptions
*/
public void setOverrideOptions(Options overrideOptions) {
this.overrideOptions = overrideOptions;
}
/**
* @return
*/
public Options getOverrideOptions() {
return this.overrideOptions;
}
/**
* @param overrideOptions
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartTaskExecutionRequest withOverrideOptions(Options overrideOptions) {
setOverrideOptions(overrideOptions);
return this;
}
/**
*
* Specifies a list of filter rules that determines which files to include when running a task. The pattern should
* contain a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that
* is, a pipe), for example, "/folder1|/folder2".
*
*
* @return Specifies a list of filter rules that determines which files to include when running a task. The pattern
* should contain a single filter string that consists of the patterns to include. The patterns are
* delimited by "|" (that is, a pipe), for example, "/folder1|/folder2".
*/
public java.util.List getIncludes() {
return includes;
}
/**
*
* Specifies a list of filter rules that determines which files to include when running a task. The pattern should
* contain a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that
* is, a pipe), for example, "/folder1|/folder2".
*
*
* @param includes
* Specifies a list of filter rules that determines which files to include when running a task. The pattern
* should contain a single filter string that consists of the patterns to include. The patterns are delimited
* by "|" (that is, a pipe), for example, "/folder1|/folder2".
*/
public void setIncludes(java.util.Collection includes) {
if (includes == null) {
this.includes = null;
return;
}
this.includes = new java.util.ArrayList(includes);
}
/**
*
* Specifies a list of filter rules that determines which files to include when running a task. The pattern should
* contain a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that
* is, a pipe), for example, "/folder1|/folder2".
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setIncludes(java.util.Collection)} or {@link #withIncludes(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param includes
* Specifies a list of filter rules that determines which files to include when running a task. The pattern
* should contain a single filter string that consists of the patterns to include. The patterns are delimited
* by "|" (that is, a pipe), for example, "/folder1|/folder2".
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartTaskExecutionRequest withIncludes(FilterRule... includes) {
if (this.includes == null) {
setIncludes(new java.util.ArrayList(includes.length));
}
for (FilterRule ele : includes) {
this.includes.add(ele);
}
return this;
}
/**
*
* Specifies a list of filter rules that determines which files to include when running a task. The pattern should
* contain a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that
* is, a pipe), for example, "/folder1|/folder2".
*
*
* @param includes
* Specifies a list of filter rules that determines which files to include when running a task. The pattern
* should contain a single filter string that consists of the patterns to include. The patterns are delimited
* by "|" (that is, a pipe), for example, "/folder1|/folder2".
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartTaskExecutionRequest withIncludes(java.util.Collection includes) {
setIncludes(includes);
return this;
}
/**
*
* Specifies a list of filter rules that determines which files to exclude from a task. The list contains a single
* filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for
* example, "/folder1|/folder2".
*
*
* @return Specifies a list of filter rules that determines which files to exclude from a task. The list contains a
* single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that
* is, a pipe), for example, "/folder1|/folder2".
*/
public java.util.List getExcludes() {
return excludes;
}
/**
*
* Specifies a list of filter rules that determines which files to exclude from a task. The list contains a single
* filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for
* example, "/folder1|/folder2".
*
*
* @param excludes
* Specifies a list of filter rules that determines which files to exclude from a task. The list contains a
* single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is,
* a pipe), for example, "/folder1|/folder2".
*/
public void setExcludes(java.util.Collection excludes) {
if (excludes == null) {
this.excludes = null;
return;
}
this.excludes = new java.util.ArrayList(excludes);
}
/**
*
* Specifies a list of filter rules that determines which files to exclude from a task. The list contains a single
* filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for
* example, "/folder1|/folder2".
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setExcludes(java.util.Collection)} or {@link #withExcludes(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param excludes
* Specifies a list of filter rules that determines which files to exclude from a task. The list contains a
* single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is,
* a pipe), for example, "/folder1|/folder2".
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartTaskExecutionRequest withExcludes(FilterRule... excludes) {
if (this.excludes == null) {
setExcludes(new java.util.ArrayList(excludes.length));
}
for (FilterRule ele : excludes) {
this.excludes.add(ele);
}
return this;
}
/**
*
* Specifies a list of filter rules that determines which files to exclude from a task. The list contains a single
* filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for
* example, "/folder1|/folder2".
*
*
* @param excludes
* Specifies a list of filter rules that determines which files to exclude from a task. The list contains a
* single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is,
* a pipe), for example, "/folder1|/folder2".
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartTaskExecutionRequest withExcludes(java.util.Collection excludes) {
setExcludes(excludes);
return this;
}
/**
*
* Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more
* information and configuration examples, see Specifying what
* DataSync transfers by using a manifest.
*
*
* When using this parameter, your caller identity (the role that you're using DataSync with) must have the
* iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.
*
*
* To remove a manifest configuration, specify this parameter with an empty value.
*
*
* @param manifestConfig
* Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more
* information and configuration examples, see Specifying
* what DataSync transfers by using a manifest.
*
* When using this parameter, your caller identity (the role that you're using DataSync with) must have the
* iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.
*
*
* To remove a manifest configuration, specify this parameter with an empty value.
*/
public void setManifestConfig(ManifestConfig manifestConfig) {
this.manifestConfig = manifestConfig;
}
/**
*
* Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more
* information and configuration examples, see Specifying what
* DataSync transfers by using a manifest.
*
*
* When using this parameter, your caller identity (the role that you're using DataSync with) must have the
* iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.
*
*
* To remove a manifest configuration, specify this parameter with an empty value.
*
*
* @return Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more
* information and configuration examples, see Specifying
* what DataSync transfers by using a manifest.
*
* When using this parameter, your caller identity (the role that you're using DataSync with) must have the
* iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.
*
*
* To remove a manifest configuration, specify this parameter with an empty value.
*/
public ManifestConfig getManifestConfig() {
return this.manifestConfig;
}
/**
*
* Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more
* information and configuration examples, see Specifying what
* DataSync transfers by using a manifest.
*
*
* When using this parameter, your caller identity (the role that you're using DataSync with) must have the
* iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.
*
*
* To remove a manifest configuration, specify this parameter with an empty value.
*
*
* @param manifestConfig
* Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more
* information and configuration examples, see Specifying
* what DataSync transfers by using a manifest.
*
* When using this parameter, your caller identity (the role that you're using DataSync with) must have the
* iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.
*
*
* To remove a manifest configuration, specify this parameter with an empty value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartTaskExecutionRequest withManifestConfig(ManifestConfig manifestConfig) {
setManifestConfig(manifestConfig);
return this;
}
/**
*
* Specifies how you want to configure a task report, which provides detailed information about your DataSync
* transfer. For more information, see Monitoring your DataSync transfers
* with task reports.
*
*
* When using this parameter, your caller identity (the role that you're using DataSync with) must have the
* iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.
*
*
* To remove a task report configuration, specify this parameter as empty.
*
*
* @param taskReportConfig
* Specifies how you want to configure a task report, which provides detailed information about your DataSync
* transfer. For more information, see Monitoring your DataSync
* transfers with task reports.
*
* When using this parameter, your caller identity (the role that you're using DataSync with) must have the
* iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.
*
*
* To remove a task report configuration, specify this parameter as empty.
*/
public void setTaskReportConfig(TaskReportConfig taskReportConfig) {
this.taskReportConfig = taskReportConfig;
}
/**
*
* Specifies how you want to configure a task report, which provides detailed information about your DataSync
* transfer. For more information, see Monitoring your DataSync transfers
* with task reports.
*
*
* When using this parameter, your caller identity (the role that you're using DataSync with) must have the
* iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.
*
*
* To remove a task report configuration, specify this parameter as empty.
*
*
* @return Specifies how you want to configure a task report, which provides detailed information about your
* DataSync transfer. For more information, see Monitoring your DataSync
* transfers with task reports.
*
* When using this parameter, your caller identity (the role that you're using DataSync with) must have the
* iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.
*
*
* To remove a task report configuration, specify this parameter as empty.
*/
public TaskReportConfig getTaskReportConfig() {
return this.taskReportConfig;
}
/**
*
* Specifies how you want to configure a task report, which provides detailed information about your DataSync
* transfer. For more information, see Monitoring your DataSync transfers
* with task reports.
*
*
* When using this parameter, your caller identity (the role that you're using DataSync with) must have the
* iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.
*
*
* To remove a task report configuration, specify this parameter as empty.
*
*
* @param taskReportConfig
* Specifies how you want to configure a task report, which provides detailed information about your DataSync
* transfer. For more information, see Monitoring your DataSync
* transfers with task reports.
*
* When using this parameter, your caller identity (the role that you're using DataSync with) must have the
* iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.
*
*
* To remove a task report configuration, specify this parameter as empty.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartTaskExecutionRequest withTaskReportConfig(TaskReportConfig taskReportConfig) {
setTaskReportConfig(taskReportConfig);
return this;
}
/**
*
* Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task execution.
*
*
* Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.
*
*
* @return Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task
* execution.
*
* Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.
*/
public java.util.List getTags() {
return tags;
}
/**
*
* Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task execution.
*
*
* Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.
*
*
* @param tags
* Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task
* execution.
*
* Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(tags);
}
/**
*
* Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task execution.
*
*
* Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.
*
*
* 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
* Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task
* execution.
*
* Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartTaskExecutionRequest withTags(TagListEntry... tags) {
if (this.tags == null) {
setTags(new java.util.ArrayList(tags.length));
}
for (TagListEntry ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task execution.
*
*
* Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.
*
*
* @param tags
* Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task
* execution.
*
* Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartTaskExecutionRequest 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 (getTaskArn() != null)
sb.append("TaskArn: ").append(getTaskArn()).append(",");
if (getOverrideOptions() != null)
sb.append("OverrideOptions: ").append(getOverrideOptions()).append(",");
if (getIncludes() != null)
sb.append("Includes: ").append(getIncludes()).append(",");
if (getExcludes() != null)
sb.append("Excludes: ").append(getExcludes()).append(",");
if (getManifestConfig() != null)
sb.append("ManifestConfig: ").append(getManifestConfig()).append(",");
if (getTaskReportConfig() != null)
sb.append("TaskReportConfig: ").append(getTaskReportConfig()).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 StartTaskExecutionRequest == false)
return false;
StartTaskExecutionRequest other = (StartTaskExecutionRequest) obj;
if (other.getTaskArn() == null ^ this.getTaskArn() == null)
return false;
if (other.getTaskArn() != null && other.getTaskArn().equals(this.getTaskArn()) == false)
return false;
if (other.getOverrideOptions() == null ^ this.getOverrideOptions() == null)
return false;
if (other.getOverrideOptions() != null && other.getOverrideOptions().equals(this.getOverrideOptions()) == false)
return false;
if (other.getIncludes() == null ^ this.getIncludes() == null)
return false;
if (other.getIncludes() != null && other.getIncludes().equals(this.getIncludes()) == false)
return false;
if (other.getExcludes() == null ^ this.getExcludes() == null)
return false;
if (other.getExcludes() != null && other.getExcludes().equals(this.getExcludes()) == false)
return false;
if (other.getManifestConfig() == null ^ this.getManifestConfig() == null)
return false;
if (other.getManifestConfig() != null && other.getManifestConfig().equals(this.getManifestConfig()) == false)
return false;
if (other.getTaskReportConfig() == null ^ this.getTaskReportConfig() == null)
return false;
if (other.getTaskReportConfig() != null && other.getTaskReportConfig().equals(this.getTaskReportConfig()) == 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 + ((getTaskArn() == null) ? 0 : getTaskArn().hashCode());
hashCode = prime * hashCode + ((getOverrideOptions() == null) ? 0 : getOverrideOptions().hashCode());
hashCode = prime * hashCode + ((getIncludes() == null) ? 0 : getIncludes().hashCode());
hashCode = prime * hashCode + ((getExcludes() == null) ? 0 : getExcludes().hashCode());
hashCode = prime * hashCode + ((getManifestConfig() == null) ? 0 : getManifestConfig().hashCode());
hashCode = prime * hashCode + ((getTaskReportConfig() == null) ? 0 : getTaskReportConfig().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public StartTaskExecutionRequest clone() {
return (StartTaskExecutionRequest) super.clone();
}
}