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 AWS storage resource's location.
List<FilterRule>	getExcludes()
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.
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 AWS storage resource's location.
void	setExcludes(Collection<FilterRule> excludes)
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	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 AWS storage resource's location.
CreateTaskRequest	withExcludes(Collection<FilterRule> excludes)
CreateTaskRequest	withExcludes(FilterRule... excludes)
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	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 AWS storage resource's location.

Parameters:

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

getDestinationLocationArn

public String getDestinationLocationArn()

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

Returns:

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

withDestinationLocationArn

public CreateTaskRequest withDestinationLocationArn(String destinationLocationArn)

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

Parameters:

destinationLocationArn - The Amazon Resource Name (ARN) of an AWS 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.

For more information on these groups, see "https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html" (Working with Log Groups and Log Streams) in the Amazon CloudWatch User Guide.

For more information about how to useCloudWatchLogs with DataSync, see "https://docs.aws.amazon.com/datasync/latest/userguide/monitor-datasync.html" (Monitoring Your 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.

For more information on these groups, see "https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html" (Working with Log Groups and Log Streams) in the Amazon CloudWatch User Guide.

For more information about how to useCloudWatchLogs with DataSync, see "https://docs.aws.amazon.com/datasync/latest/userguide/monitor-datasync.html" (Monitoring Your 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.

For more information on these groups, see "https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html" (Working with Log Groups and Log Streams) in the Amazon CloudWatch User Guide.

For more information about how to useCloudWatchLogs with DataSync, see "https://docs.aws.amazon.com/datasync/latest/userguide/monitor-datasync.html" (Monitoring Your Task)

Returns:

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

For more information on these groups, see "https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html" (Working with Log Groups and Log Streams) in the Amazon CloudWatch User Guide.

For more information about how to useCloudWatchLogs with DataSync, see "https://docs.aws.amazon.com/datasync/latest/userguide/monitor-datasync.html" (Monitoring Your 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.

For more information on these groups, see "https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html" (Working with Log Groups and Log Streams) in the Amazon CloudWatch User Guide.

For more information about how to useCloudWatchLogs with DataSync, see "https://docs.aws.amazon.com/datasync/latest/userguide/monitor-datasync.html" (Monitoring Your 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.

For more information on these groups, see "https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html" (Working with Log Groups and Log Streams) in the Amazon CloudWatch User Guide.

For more information about how to useCloudWatchLogs with DataSync, see "https://docs.aws.amazon.com/datasync/latest/userguide/monitor-datasync.html" (Monitoring Your 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 a the task execution. For more information, see the 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 a the task execution. For more information, see the 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 a the task execution. For more information, see the 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 a the task execution. For more information, see the 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 a the task execution. For more information, see the 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 a the task execution. For more information, see the operation.

Returns:

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

getExcludes

public List<FilterRule> getExcludes()

A filter that determines which files to exclude from a task based on the specified pattern. Transfers all files in the task’s subdirectory, except files that match the filter that is set.

Returns:

A filter that determines which files to exclude from a task based on the specified pattern. Transfers all files in the task’s subdirectory, except files that match the filter that is set.

setExcludes

public void setExcludes(Collection<FilterRule> excludes)

A filter that determines which files to exclude from a task based on the specified pattern. Transfers all files in the task’s subdirectory, except files that match the filter that is set.

Parameters:

excludes -

A filter that determines which files to exclude from a task based on the specified pattern. Transfers all files in the task’s subdirectory, except files that match the filter that is set.

withExcludes

public CreateTaskRequest withExcludes(FilterRule... excludes)

A filter that determines which files to exclude from a task based on the specified pattern. Transfers all files in the task’s subdirectory, except files that match the filter that is set.

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 filter that determines which files to exclude from a task based on the specified pattern. Transfers all files in the task’s subdirectory, except files that match the filter that is set.

Returns:

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

withExcludes

public CreateTaskRequest withExcludes(Collection<FilterRule> excludes)

A filter that determines which files to exclude from a task based on the specified pattern. Transfers all files in the task’s subdirectory, except files that match the filter that is set.

Parameters:

excludes -

A filter that determines which files to exclude from a task based on the specified pattern. Transfers all files in the task’s subdirectory, except files that match the filter that is set.

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.

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