All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

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

  All Methods

  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 () Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.
  String	getDestinationLocationArn () Specifies the ARN of your transfer's destination location.
  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 () Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.
  TaskSchedule	getSchedule () Specifies a schedule for when you want your task to run.
  String	getSourceLocationArn () Specifies the ARN of your transfer's source location.
  List<TagListEntry>	getTags () Specifies the tags that you want to apply to your task.
  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	setDestinationLocationArn (String destinationLocationArn) Specifies the ARN of your transfer's destination location.
  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) Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.
  void	setSchedule (TaskSchedule schedule) Specifies a schedule for when you want your task to run.
  void	setSourceLocationArn (String sourceLocationArn) Specifies the ARN of your transfer's source location.
  void	setTags (Collection<TagListEntry> tags) Specifies the tags that you want to apply to your task.
  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.
  CreateTaskRequest	withCloudWatchLogGroupArn (String cloudWatchLogGroupArn) Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.
  CreateTaskRequest	withDestinationLocationArn (String destinationLocationArn) Specifies the ARN of your transfer's destination location.
  CreateTaskRequest	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.
  CreateTaskRequest	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.
  CreateTaskRequest	withIncludes (Collection<FilterRule> includes) Specifies include filters define the files, objects, and folders in your source location that you want DataSync to transfer.
  CreateTaskRequest	withIncludes (FilterRule... includes) Specifies include filters define the files, objects, and folders in your source location that you want DataSync to transfer.
  CreateTaskRequest	withManifestConfig (ManifestConfig manifestConfig) Configures a manifest, which is a list of files or objects that you want DataSync to transfer.
  CreateTaskRequest	withName (String name) Specifies the name of your task.
  CreateTaskRequest	withOptions (Options options) Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.
  CreateTaskRequest	withSchedule (TaskSchedule schedule) Specifies a schedule for when you want your task to run.
  CreateTaskRequest	withSourceLocationArn (String sourceLocationArn) Specifies the ARN of your transfer's source location.
  CreateTaskRequest	withTags (Collection<TagListEntry> tags) Specifies the tags that you want to apply to your task.
  CreateTaskRequest	withTags (TagListEntry... tags) Specifies the tags that you want to apply to your task.
  CreateTaskRequest	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

  • CreateTaskRequest

    public CreateTaskRequest()

• Method Detail

  • setSourceLocationArn

    public void setSourceLocationArn(String sourceLocationArn)

    Specifies the ARN of your transfer's source location.

    Parameters:

    sourceLocationArn - Specifies the ARN of your transfer's source location.

  • getSourceLocationArn

    public String getSourceLocationArn()

    Specifies the ARN of your transfer's source location.

    Returns:

    Specifies the ARN of your transfer's source location.

  • withSourceLocationArn

    public CreateTaskRequest withSourceLocationArn(String sourceLocationArn)

    Specifies the ARN of your transfer's source location.

    Parameters:

    sourceLocationArn - Specifies the ARN of your transfer's source location.

    Returns:

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

  • setDestinationLocationArn

    public void setDestinationLocationArn(String destinationLocationArn)

    Specifies the ARN of your transfer's destination location.

    Parameters:

    destinationLocationArn - Specifies the ARN of your transfer's destination location.

  • getDestinationLocationArn

    public String getDestinationLocationArn()

    Specifies the ARN of your transfer's destination location.

    Returns:

    Specifies the ARN of your transfer's destination location.

  • withDestinationLocationArn

    public CreateTaskRequest withDestinationLocationArn(String destinationLocationArn)

    Specifies the ARN of your transfer's destination location.

    Parameters:

    destinationLocationArn - Specifies the ARN of your transfer's destination location.

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

  • 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 CreateTaskRequest 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.

  • setOptions

    public void setOptions(Options options)

    Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.

    Parameters:

    options - Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.

  • getOptions

    public Options getOptions()

    Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.

    Returns:

    Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.

  • withOptions

    public CreateTaskRequest withOptions(Options options)

    Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.

    Parameters:

    options - Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other 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 CreateTaskRequest 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 CreateTaskRequest 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 CreateTaskRequest 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.

  • getTags

    public List<TagListEntry> getTags()

    Specifies the tags that you want to apply to your task.

    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 your task.

    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 your task.

    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 your task.

    Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.

  • withTags

    public CreateTaskRequest withTags(TagListEntry... tags)

    Specifies the tags that you want to apply to your task.

    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 your task.

    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 CreateTaskRequest withTags(Collection<TagListEntry> tags)

    Specifies the tags that you want to apply to your task.

    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 your task.

    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.

  • 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 CreateTaskRequest 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 CreateTaskRequest 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 role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.

    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.

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

    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.

  • withManifestConfig

    public CreateTaskRequest 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.

    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.

    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.

    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.

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

    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.

  • withTaskReportConfig

    public CreateTaskRequest 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.

    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.

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