com.amazonaws.services.datasync.model

Class CreateTaskRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.datasync.model.CreateTaskRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

CreateTaskRequest

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateTaskRequest()

Method Summary

Modifier and Type	Method and Description
CreateTaskRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getCloudWatchLogGroupArn() The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.
String	getDestinationLocationArn() The Amazon Resource Name (ARN) of an Amazon Web Services storage resource's location.
List<FilterRule>	getExcludes() A list of filter rules that determines which files to exclude from a task.
List<FilterRule>	getIncludes() A list of filter rules that determines which files to include when running a task.
String	getName() The name of a task.
Options	getOptions() The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution.
TaskSchedule	getSchedule() Specifies a schedule used to periodically transfer files from a source to a destination location.
String	getSourceLocationArn() The Amazon Resource Name (ARN) of the source location for the task.
List<TagListEntry>	getTags() The key-value pair that represents the tag that you want to add to the resource.
int	hashCode()
void	setCloudWatchLogGroupArn(String cloudWatchLogGroupArn) The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.
void	setDestinationLocationArn(String destinationLocationArn) The Amazon Resource Name (ARN) of an Amazon Web Services storage resource's location.
void	setExcludes(Collection<FilterRule> excludes) A list of filter rules that determines which files to exclude from a task.
void	setIncludes(Collection<FilterRule> includes) A list of filter rules that determines which files to include when running a task.
void	setName(String name) The name of a task.
void	setOptions(Options options) The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution.
void	setSchedule(TaskSchedule schedule) Specifies a schedule used to periodically transfer files from a source to a destination location.
void	setSourceLocationArn(String sourceLocationArn) The Amazon Resource Name (ARN) of the source location for the task.
void	setTags(Collection<TagListEntry> tags) The key-value pair that represents the tag that you want to add to the resource.
String	toString() Returns a string representation of this object.
CreateTaskRequest	withCloudWatchLogGroupArn(String cloudWatchLogGroupArn) The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.
CreateTaskRequest	withDestinationLocationArn(String destinationLocationArn) The Amazon Resource Name (ARN) of an Amazon Web Services storage resource's location.
CreateTaskRequest	withExcludes(Collection<FilterRule> excludes) A list of filter rules that determines which files to exclude from a task.
CreateTaskRequest	withExcludes(FilterRule... excludes) A list of filter rules that determines which files to exclude from a task.
CreateTaskRequest	withIncludes(Collection<FilterRule> includes) A list of filter rules that determines which files to include when running a task.
CreateTaskRequest	withIncludes(FilterRule... includes) A list of filter rules that determines which files to include when running a task.
CreateTaskRequest	withName(String name) The name of a task.
CreateTaskRequest	withOptions(Options options) The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution.
CreateTaskRequest	withSchedule(TaskSchedule schedule) Specifies a schedule used to periodically transfer files from a source to a destination location.
CreateTaskRequest	withSourceLocationArn(String sourceLocationArn) The Amazon Resource Name (ARN) of the source location for the task.
CreateTaskRequest	withTags(Collection<TagListEntry> tags) The key-value pair that represents the tag that you want to add to the resource.
CreateTaskRequest	withTags(TagListEntry... tags) The key-value pair that represents the tag that you want to add to the resource.

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

CreateTaskRequest

public CreateTaskRequest()

Method Detail

setSourceLocationArn

public void setSourceLocationArn(String sourceLocationArn)

The Amazon Resource Name (ARN) of the source location for the task.

Parameters:

sourceLocationArn - The Amazon Resource Name (ARN) of the source location for the task.

getSourceLocationArn

public String getSourceLocationArn()

The Amazon Resource Name (ARN) of the source location for the task.

Returns:

The Amazon Resource Name (ARN) of the source location for the task.

withSourceLocationArn

public CreateTaskRequest withSourceLocationArn(String sourceLocationArn)

The Amazon Resource Name (ARN) of the source location for the task.

Parameters:

sourceLocationArn - The Amazon Resource Name (ARN) of the source location for the task.

Returns:

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

setDestinationLocationArn

public void setDestinationLocationArn(String destinationLocationArn)

The Amazon Resource Name (ARN) of an Amazon Web Services storage resource's location.

Parameters:

destinationLocationArn - The Amazon Resource Name (ARN) of an Amazon Web Services storage resource's location.

getDestinationLocationArn

public String getDestinationLocationArn()

The Amazon Resource Name (ARN) of an Amazon Web Services storage resource's location.

Returns:

The Amazon Resource Name (ARN) of an Amazon Web Services storage resource's location.

withDestinationLocationArn

public CreateTaskRequest withDestinationLocationArn(String destinationLocationArn)

The Amazon Resource Name (ARN) of an Amazon Web Services storage resource's location.

Parameters:

destinationLocationArn - The Amazon Resource Name (ARN) of an Amazon Web Services storage resource's location.

Returns:

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

setCloudWatchLogGroupArn

public void setCloudWatchLogGroupArn(String cloudWatchLogGroupArn)

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.

Parameters:

cloudWatchLogGroupArn - The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.

getCloudWatchLogGroupArn

public String getCloudWatchLogGroupArn()

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.

Returns:

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.

withCloudWatchLogGroupArn

public CreateTaskRequest withCloudWatchLogGroupArn(String cloudWatchLogGroupArn)

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.

Parameters:

cloudWatchLogGroupArn - The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.

Returns:

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

setName

public void setName(String name)

The name of a task. This value is a text reference that is used to identify the task in the console.

Parameters:

name - The name of a task. This value is a text reference that is used to identify the task in the console.

getName

public String getName()

The name of a task. This value is a text reference that is used to identify the task in the console.

Returns:

The name of a task. This value is a text reference that is used to identify the task in the console.

withName

public CreateTaskRequest withName(String name)

The name of a task. This value is a text reference that is used to identify the task in the console.

Parameters:

name - The name of a task. This value is a text reference that is used to identify the task in the console.

Returns:

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

setOptions

public void setOptions(Options options)

The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution. You can configure these options to preserve metadata such as user ID (UID) and group ID (GID), file permissions, data integrity verification, and so on.

For each individual task execution, you can override these options by specifying the OverrideOptions before starting the task execution. For more information, see the StartTaskExecution operation.

Parameters:

options - The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution. You can configure these options to preserve metadata such as user ID (UID) and group ID (GID), file permissions, data integrity verification, and so on.

For each individual task execution, you can override these options by specifying the OverrideOptions before starting the task execution. For more information, see the StartTaskExecution operation.

getOptions

public Options getOptions()

The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution. You can configure these options to preserve metadata such as user ID (UID) and group ID (GID), file permissions, data integrity verification, and so on.

For each individual task execution, you can override these options by specifying the OverrideOptions before starting the task execution. For more information, see the StartTaskExecution operation.

Returns:

The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution. You can configure these options to preserve metadata such as user ID (UID) and group ID (GID), file permissions, data integrity verification, and so on.

For each individual task execution, you can override these options by specifying the OverrideOptions before starting the task execution. For more information, see the StartTaskExecution operation.

withOptions

public CreateTaskRequest withOptions(Options options)

The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution. You can configure these options to preserve metadata such as user ID (UID) and group ID (GID), file permissions, data integrity verification, and so on.

For each individual task execution, you can override these options by specifying the OverrideOptions before starting the task execution. For more information, see the StartTaskExecution operation.

Parameters:

options - The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution. You can configure these options to preserve metadata such as user ID (UID) and group ID (GID), file permissions, data integrity verification, and so on.

For each individual task execution, you can override these options by specifying the OverrideOptions before starting the task execution. For more information, see the StartTaskExecution operation.

Returns:

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

getExcludes

public List<FilterRule> getExcludes()

A list of filter rules that determines which files to exclude from a task. The list should contain 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:

A list of filter rules that determines which files to exclude from a task. The list should contain 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)

A list of filter rules that determines which files to exclude from a task. The list should contain 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 - A list of filter rules that determines which files to exclude from a task. The list should contain 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 CreateTaskRequest withExcludes(FilterRule... excludes)

A list of filter rules that determines which files to exclude from a task. The list should contain 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 - A list of filter rules that determines which files to exclude from a task. The list should contain 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 CreateTaskRequest withExcludes(Collection<FilterRule> excludes)

A list of filter rules that determines which files to exclude from a task. The list should contain 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 - A list of filter rules that determines which files to exclude from a task. The list should contain 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.

setSchedule

public void setSchedule(TaskSchedule schedule)

Specifies a schedule used to periodically transfer files from a source to a destination location. The schedule should be specified in UTC time. For more information, see Scheduling your task.

Parameters:

schedule - Specifies a schedule used to periodically transfer files from a source to a destination location. The schedule should be specified in UTC time. For more information, see Scheduling your task.

getSchedule

public TaskSchedule getSchedule()

Specifies a schedule used to periodically transfer files from a source to a destination location. The schedule should be specified in UTC time. For more information, see Scheduling your task.

Returns:

Specifies a schedule used to periodically transfer files from a source to a destination location. The schedule should be specified in UTC time. For more information, see Scheduling your task.

withSchedule

public CreateTaskRequest withSchedule(TaskSchedule schedule)

Specifies a schedule used to periodically transfer files from a source to a destination location. The schedule should be specified in UTC time. For more information, see Scheduling your task.

Parameters:

schedule - Specifies a schedule used to periodically transfer files from a source to a destination location. The schedule should be specified in UTC time. For more information, see Scheduling your task.

Returns:

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

getTags

public List<TagListEntry> getTags()

The key-value pair that represents the tag that you want to add to the resource. The value can be an empty string.

Returns:

The key-value pair that represents the tag that you want to add to the resource. The value can be an empty string.

setTags

public void setTags(Collection<TagListEntry> tags)

The key-value pair that represents the tag that you want to add to the resource. The value can be an empty string.

Parameters:

tags - The key-value pair that represents the tag that you want to add to the resource. The value can be an empty string.

withTags

public CreateTaskRequest withTags(TagListEntry... tags)

The key-value pair that represents the tag that you want to add to the resource. The value can be an empty string.

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 - The key-value pair that represents the tag that you want to add to the resource. The value can be an empty string.

Returns:

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

withTags

public CreateTaskRequest withTags(Collection<TagListEntry> tags)

The key-value pair that represents the tag that you want to add to the resource. The value can be an empty string.

Parameters:

tags - The key-value pair that represents the tag that you want to add to the resource. The value can be an empty string.

Returns:

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

getIncludes

public List<FilterRule> getIncludes()

A list of filter rules that determines which files to include when running a task. The pattern contains 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:

A list of filter rules that determines which files to include when running a task. The pattern contains 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)

A list of filter rules that determines which files to include when running a task. The pattern contains 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 - A list of filter rules that determines which files to include when running a task. The pattern contains 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 CreateTaskRequest withIncludes(FilterRule... includes)

A list of filter rules that determines which files to include when running a task. The pattern contains 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 - A list of filter rules that determines which files to include when running a task. The pattern contains 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 CreateTaskRequest withIncludes(Collection<FilterRule> includes)

A list of filter rules that determines which files to include when running a task. The pattern contains 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 - A list of filter rules that determines which files to include when running a task. The pattern contains 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.

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 CreateTaskRequest 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()