com.amazonaws.services.datasync.model

Class StartTaskExecutionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.datasync.model.StartTaskExecutionRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartTaskExecutionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

StartTaskExecutionRequest

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
StartTaskExecutionRequest()

Method Summary

Modifier and Type	Method and Description
StartTaskExecutionRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<FilterRule>	getExcludes() Specifies a list of filter rules that determines which files to exclude from a task.
List<FilterRule>	getIncludes() Specifies a list of filter rules that determines which files to include when running a task.
ManifestConfig	getManifestConfig() Configures a manifest, which is a list of files or objects that you want DataSync to transfer.
Options	getOverrideOptions()
List<TagListEntry>	getTags() Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task execution.
String	getTaskArn() Specifies the Amazon Resource Name (ARN) of the task that you want to start.
TaskReportConfig	getTaskReportConfig() Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer.
int	hashCode()
void	setExcludes(Collection<FilterRule> excludes) Specifies a list of filter rules that determines which files to exclude from a task.
void	setIncludes(Collection<FilterRule> includes) Specifies a list of filter rules that determines which files to include when running a task.
void	setManifestConfig(ManifestConfig manifestConfig) Configures a manifest, which is a list of files or objects that you want DataSync to transfer.
void	setOverrideOptions(Options overrideOptions)
void	setTags(Collection<TagListEntry> tags) Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task execution.
void	setTaskArn(String taskArn) Specifies the Amazon Resource Name (ARN) of the task that you want to start.
void	setTaskReportConfig(TaskReportConfig taskReportConfig) Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer.
String	toString() Returns a string representation of this object.
StartTaskExecutionRequest	withExcludes(Collection<FilterRule> excludes) Specifies a list of filter rules that determines which files to exclude from a task.
StartTaskExecutionRequest	withExcludes(FilterRule... excludes) Specifies a list of filter rules that determines which files to exclude from a task.
StartTaskExecutionRequest	withIncludes(Collection<FilterRule> includes) Specifies a list of filter rules that determines which files to include when running a task.
StartTaskExecutionRequest	withIncludes(FilterRule... includes) Specifies a list of filter rules that determines which files to include when running a task.
StartTaskExecutionRequest	withManifestConfig(ManifestConfig manifestConfig) Configures a manifest, which is a list of files or objects that you want DataSync to transfer.
StartTaskExecutionRequest	withOverrideOptions(Options overrideOptions)
StartTaskExecutionRequest	withTags(Collection<TagListEntry> tags) Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task execution.
StartTaskExecutionRequest	withTags(TagListEntry... tags) Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task execution.
StartTaskExecutionRequest	withTaskArn(String taskArn) Specifies the Amazon Resource Name (ARN) of the task that you want to start.
StartTaskExecutionRequest	withTaskReportConfig(TaskReportConfig taskReportConfig) Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartTaskExecutionRequest

public StartTaskExecutionRequest()

Method Detail

setTaskArn

public void setTaskArn(String taskArn)

Specifies the Amazon Resource Name (ARN) of the task that you want to start.

Parameters:

taskArn - Specifies the Amazon Resource Name (ARN) of the task that you want to start.

getTaskArn

public String getTaskArn()

Specifies the Amazon Resource Name (ARN) of the task that you want to start.

Returns:

Specifies the Amazon Resource Name (ARN) of the task that you want to start.

withTaskArn

public StartTaskExecutionRequest withTaskArn(String taskArn)

Specifies the Amazon Resource Name (ARN) of the task that you want to start.

Parameters:

taskArn - Specifies the Amazon Resource Name (ARN) of the task that you want to start.

Returns:

Returns a reference to this object so that method calls can be chained together.

setOverrideOptions

public void setOverrideOptions(Options overrideOptions)

Parameters:

overrideOptions -

getOverrideOptions

public Options getOverrideOptions()

Returns:

withOverrideOptions

public StartTaskExecutionRequest withOverrideOptions(Options overrideOptions)

Parameters:

overrideOptions -

Returns:

Returns a reference to this object so that method calls can be chained together.

getIncludes

public List<FilterRule> getIncludes()

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".

Returns:

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".

setIncludes

public void setIncludes(Collection<FilterRule> 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".

Parameters:

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".

withIncludes

public StartTaskExecutionRequest withIncludes(FilterRule... 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 setIncludes(java.util.Collection) or withIncludes(java.util.Collection) if you want to override the existing values.

Parameters:

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".

Returns:

Returns a reference to this object so that method calls can be chained together.

withIncludes

public StartTaskExecutionRequest withIncludes(Collection<FilterRule> 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".

Parameters:

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".

Returns:

Returns a reference to this object so that method calls can be chained together.

getExcludes

public List<FilterRule> getExcludes()

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".

Returns:

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".

setExcludes

public void setExcludes(Collection<FilterRule> 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".

Parameters:

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".

withExcludes

public StartTaskExecutionRequest withExcludes(FilterRule... 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 setExcludes(java.util.Collection) or withExcludes(java.util.Collection) if you want to override the existing values.

Parameters:

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".

Returns:

Returns a reference to this object so that method calls can be chained together.

withExcludes

public StartTaskExecutionRequest withExcludes(Collection<FilterRule> 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".

Parameters:

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".

Returns:

Returns a reference to this object so that method calls can be chained together.

setManifestConfig

public void setManifestConfig(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.

Parameters:

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.

getManifestConfig

public ManifestConfig getManifestConfig()

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.

Returns:

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.

withManifestConfig

public StartTaskExecutionRequest withManifestConfig(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setTaskReportConfig

public void setTaskReportConfig(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.

Parameters:

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.

getTaskReportConfig

public TaskReportConfig getTaskReportConfig()

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.

Returns:

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.

withTaskReportConfig

public StartTaskExecutionRequest withTaskReportConfig(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public List<TagListEntry> getTags()

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.

Returns:

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.

setTags

public void setTags(Collection<TagListEntry> 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.

Parameters:

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.

withTags

public StartTaskExecutionRequest withTags(TagListEntry... 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 setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public StartTaskExecutionRequest withTags(Collection<TagListEntry> 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public StartTaskExecutionRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()