com.amazonaws.services.datasync.model

Class UpdateTaskRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.datasync.model.UpdateTaskRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

UpdateTaskResponse

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateTaskRequest()

Method Summary

Modifier and Type	Method and Description
UpdateTaskRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getCloudWatchLogGroupArn() Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.
List<FilterRule>	getExcludes() Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer.
List<FilterRule>	getIncludes() Specifies include filters define the files, objects, and folders in your source location that you want DataSync to transfer.
ManifestConfig	getManifestConfig() Configures a manifest, which is a list of files or objects that you want DataSync to transfer.
String	getName() Specifies the name of your task.
Options	getOptions()
TaskSchedule	getSchedule() Specifies a schedule for when you want your task to run.
String	getTaskArn() Specifies the ARN of the task that you want to update.
TaskReportConfig	getTaskReportConfig() Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer.
int	hashCode()
void	setCloudWatchLogGroupArn(String cloudWatchLogGroupArn) Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.
void	setExcludes(Collection<FilterRule> excludes) Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer.
void	setIncludes(Collection<FilterRule> includes) Specifies include filters define the files, objects, and folders in your source location that you want DataSync to transfer.
void	setManifestConfig(ManifestConfig manifestConfig) Configures a manifest, which is a list of files or objects that you want DataSync to transfer.
void	setName(String name) Specifies the name of your task.
void	setOptions(Options options)
void	setSchedule(TaskSchedule schedule) Specifies a schedule for when you want your task to run.
void	setTaskArn(String taskArn) Specifies the ARN of the task that you want to update.
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.
UpdateTaskRequest	withCloudWatchLogGroupArn(String cloudWatchLogGroupArn) Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.
UpdateTaskRequest	withExcludes(Collection<FilterRule> excludes) Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer.
UpdateTaskRequest	withExcludes(FilterRule... excludes) Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer.
UpdateTaskRequest	withIncludes(Collection<FilterRule> includes) Specifies include filters define the files, objects, and folders in your source location that you want DataSync to transfer.
UpdateTaskRequest	withIncludes(FilterRule... includes) Specifies include filters define the files, objects, and folders in your source location that you want DataSync to transfer.
UpdateTaskRequest	withManifestConfig(ManifestConfig manifestConfig) Configures a manifest, which is a list of files or objects that you want DataSync to transfer.
UpdateTaskRequest	withName(String name) Specifies the name of your task.
UpdateTaskRequest	withOptions(Options options)
UpdateTaskRequest	withSchedule(TaskSchedule schedule) Specifies a schedule for when you want your task to run.
UpdateTaskRequest	withTaskArn(String taskArn) Specifies the ARN of the task that you want to update.
UpdateTaskRequest	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

UpdateTaskRequest

public UpdateTaskRequest()

Method Detail

setTaskArn

public void setTaskArn(String taskArn)

Specifies the ARN of the task that you want to update.

Parameters:

taskArn - Specifies the ARN of the task that you want to update.

getTaskArn

public String getTaskArn()

Specifies the ARN of the task that you want to update.

Returns:

Specifies the ARN of the task that you want to update.

withTaskArn

public UpdateTaskRequest withTaskArn(String taskArn)

Specifies the ARN of the task that you want to update.

Parameters:

taskArn - Specifies the ARN of the task that you want to update.

Returns:

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

setOptions

public void setOptions(Options options)

Parameters:

options -

getOptions

public Options getOptions()

Returns:

withOptions

public UpdateTaskRequest withOptions(Options options)

Parameters:

options -

Returns:

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

getExcludes

public List<FilterRule> getExcludes()

Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

Returns:

Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

setExcludes

public void setExcludes(Collection<FilterRule> excludes)

Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

Parameters:

excludes - Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

withExcludes

public UpdateTaskRequest withExcludes(FilterRule... excludes)

Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

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 exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

Returns:

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

withExcludes

public UpdateTaskRequest withExcludes(Collection<FilterRule> excludes)

Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

Parameters:

excludes - Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

Returns:

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

setSchedule

public void setSchedule(TaskSchedule schedule)

Specifies a schedule for when you want your task to run. For more information, see Scheduling your task.

Parameters:

schedule - Specifies a schedule for when you want your task to run. For more information, see Scheduling your task.

getSchedule

public TaskSchedule getSchedule()

Specifies a schedule for when you want your task to run. For more information, see Scheduling your task.

Returns:

Specifies a schedule for when you want your task to run. For more information, see Scheduling your task.

withSchedule

public UpdateTaskRequest withSchedule(TaskSchedule schedule)

Specifies a schedule for when you want your task to run. For more information, see Scheduling your task.

Parameters:

schedule - Specifies a schedule for when you want your task to run. For more information, see Scheduling your task.

Returns:

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

setName

public void setName(String name)

Specifies the name of your task.

Parameters:

name - Specifies the name of your task.

getName

public String getName()

Specifies the name of your task.

Returns:

Specifies the name of your task.

withName

public UpdateTaskRequest withName(String name)

Specifies the name of your task.

Parameters:

name - Specifies the name of your task.

Returns:

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

setCloudWatchLogGroupArn

public void setCloudWatchLogGroupArn(String cloudWatchLogGroupArn)

Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.

Parameters:

cloudWatchLogGroupArn - Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.

getCloudWatchLogGroupArn

public String getCloudWatchLogGroupArn()

Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.

Returns:

Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.

withCloudWatchLogGroupArn

public UpdateTaskRequest withCloudWatchLogGroupArn(String cloudWatchLogGroupArn)

Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.

Parameters:

cloudWatchLogGroupArn - Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.

Returns:

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

getIncludes

public List<FilterRule> getIncludes()

Specifies include filters define the files, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

Returns:

Specifies include filters define the files, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

setIncludes

public void setIncludes(Collection<FilterRule> includes)

Specifies include filters define the files, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

Parameters:

includes - Specifies include filters define the files, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

withIncludes

public UpdateTaskRequest withIncludes(FilterRule... includes)

Specifies include filters define the files, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

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 include filters define the files, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

Returns:

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

withIncludes

public UpdateTaskRequest withIncludes(Collection<FilterRule> includes)

Specifies include filters define the files, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

Parameters:

includes - Specifies include filters define the files, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

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 IAM 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 as empty.

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 IAM 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 as empty.

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 IAM 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 as empty.

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 IAM 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 as empty.

withManifestConfig

public UpdateTaskRequest 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 IAM 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 as empty.

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 IAM 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 as empty.

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 IAM 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 IAM 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 IAM 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 IAM 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 UpdateTaskRequest 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 IAM 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 IAM 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.

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