/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include #include namespace Aws { namespace DataSync { namespace Model { /** *

CreateTaskRequest

See Also:

AWS * API Reference

*/ class AWS_DATASYNC_API CreateTaskRequest : public DataSyncRequest { public: CreateTaskRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "CreateTask"; } Aws::String SerializePayload() const override; Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

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

*/ inline const Aws::String& GetSourceLocationArn() const{ return m_sourceLocationArn; } /** *

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

*/ inline bool SourceLocationArnHasBeenSet() const { return m_sourceLocationArnHasBeenSet; } /** *

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

*/ inline void SetSourceLocationArn(const Aws::String& value) { m_sourceLocationArnHasBeenSet = true; m_sourceLocationArn = value; } /** *

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

*/ inline void SetSourceLocationArn(Aws::String&& value) { m_sourceLocationArnHasBeenSet = true; m_sourceLocationArn = std::move(value); } /** *

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

*/ inline void SetSourceLocationArn(const char* value) { m_sourceLocationArnHasBeenSet = true; m_sourceLocationArn.assign(value); } /** *

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

*/ inline CreateTaskRequest& WithSourceLocationArn(const Aws::String& value) { SetSourceLocationArn(value); return *this;} /** *

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

*/ inline CreateTaskRequest& WithSourceLocationArn(Aws::String&& value) { SetSourceLocationArn(std::move(value)); return *this;} /** *

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

*/ inline CreateTaskRequest& WithSourceLocationArn(const char* value) { SetSourceLocationArn(value); return *this;} /** *

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

*/ inline const Aws::String& GetDestinationLocationArn() const{ return m_destinationLocationArn; } /** *

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

*/ inline bool DestinationLocationArnHasBeenSet() const { return m_destinationLocationArnHasBeenSet; } /** *

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

*/ inline void SetDestinationLocationArn(const Aws::String& value) { m_destinationLocationArnHasBeenSet = true; m_destinationLocationArn = value; } /** *

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

*/ inline void SetDestinationLocationArn(Aws::String&& value) { m_destinationLocationArnHasBeenSet = true; m_destinationLocationArn = std::move(value); } /** *

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

*/ inline void SetDestinationLocationArn(const char* value) { m_destinationLocationArnHasBeenSet = true; m_destinationLocationArn.assign(value); } /** *

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

*/ inline CreateTaskRequest& WithDestinationLocationArn(const Aws::String& value) { SetDestinationLocationArn(value); return *this;} /** *

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

*/ inline CreateTaskRequest& WithDestinationLocationArn(Aws::String&& value) { SetDestinationLocationArn(std::move(value)); return *this;} /** *

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

*/ inline CreateTaskRequest& WithDestinationLocationArn(const char* value) { SetDestinationLocationArn(value); return *this;} /** *

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

*/ inline const Aws::String& GetCloudWatchLogGroupArn() const{ return m_cloudWatchLogGroupArn; } /** *

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

*/ inline bool CloudWatchLogGroupArnHasBeenSet() const { return m_cloudWatchLogGroupArnHasBeenSet; } /** *

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

*/ inline void SetCloudWatchLogGroupArn(const Aws::String& value) { m_cloudWatchLogGroupArnHasBeenSet = true; m_cloudWatchLogGroupArn = value; } /** *

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

*/ inline void SetCloudWatchLogGroupArn(Aws::String&& value) { m_cloudWatchLogGroupArnHasBeenSet = true; m_cloudWatchLogGroupArn = std::move(value); } /** *

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

*/ inline void SetCloudWatchLogGroupArn(const char* value) { m_cloudWatchLogGroupArnHasBeenSet = true; m_cloudWatchLogGroupArn.assign(value); } /** *

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

*/ inline CreateTaskRequest& WithCloudWatchLogGroupArn(const Aws::String& value) { SetCloudWatchLogGroupArn(value); return *this;} /** *

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

*/ inline CreateTaskRequest& WithCloudWatchLogGroupArn(Aws::String&& value) { SetCloudWatchLogGroupArn(std::move(value)); return *this;} /** *

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

*/ inline CreateTaskRequest& WithCloudWatchLogGroupArn(const char* value) { SetCloudWatchLogGroupArn(value); return *this;} /** *

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

*/ inline const Aws::String& GetName() const{ return m_name; } /** *

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

*/ inline bool NameHasBeenSet() const { return m_nameHasBeenSet; } /** *

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

*/ inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; } /** *

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

*/ inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); } /** *

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

*/ inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); } /** *

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

*/ inline CreateTaskRequest& WithName(const Aws::String& value) { SetName(value); return *this;} /** *

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

*/ inline CreateTaskRequest& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;} /** *

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

*/ inline CreateTaskRequest& WithName(const char* value) { SetName(value); return *this;} /** *

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

*/ inline const Options& GetOptions() const{ return m_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 operation.

*/ inline bool OptionsHasBeenSet() const { return m_optionsHasBeenSet; } /** *

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

*/ inline void SetOptions(const Options& value) { m_optionsHasBeenSet = true; m_options = value; } /** *

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

*/ inline void SetOptions(Options&& value) { m_optionsHasBeenSet = true; m_options = std::move(value); } /** *

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

*/ inline CreateTaskRequest& WithOptions(const Options& value) { SetOptions(value); return *this;} /** *

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

*/ inline CreateTaskRequest& WithOptions(Options&& value) { SetOptions(std::move(value)); return *this;} /** *

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"

*/ inline const Aws::Vector& GetExcludes() const{ return m_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"

*/ inline bool ExcludesHasBeenSet() const { return m_excludesHasBeenSet; } /** *

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"

*/ inline void SetExcludes(const Aws::Vector& value) { m_excludesHasBeenSet = true; m_excludes = value; } /** *

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"

*/ inline void SetExcludes(Aws::Vector&& value) { m_excludesHasBeenSet = true; m_excludes = std::move(value); } /** *

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"

*/ inline CreateTaskRequest& WithExcludes(const Aws::Vector& value) { SetExcludes(value); return *this;} /** *

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"

*/ inline CreateTaskRequest& WithExcludes(Aws::Vector&& value) { SetExcludes(std::move(value)); return *this;} /** *

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"

*/ inline CreateTaskRequest& AddExcludes(const FilterRule& value) { m_excludesHasBeenSet = true; m_excludes.push_back(value); return *this; } /** *

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"

*/ inline CreateTaskRequest& AddExcludes(FilterRule&& value) { m_excludesHasBeenSet = true; m_excludes.push_back(std::move(value)); return *this; } /** *

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

*/ inline const TaskSchedule& GetSchedule() const{ return m_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 task-scheduling.

*/ inline bool ScheduleHasBeenSet() const { return m_scheduleHasBeenSet; } /** *

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

*/ inline void SetSchedule(const TaskSchedule& value) { m_scheduleHasBeenSet = true; m_schedule = value; } /** *

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

*/ inline void SetSchedule(TaskSchedule&& value) { m_scheduleHasBeenSet = true; m_schedule = std::move(value); } /** *

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

*/ inline CreateTaskRequest& WithSchedule(const TaskSchedule& value) { SetSchedule(value); return *this;} /** *

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

*/ inline CreateTaskRequest& WithSchedule(TaskSchedule&& value) { SetSchedule(std::move(value)); return *this;} /** *

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

*/ inline const Aws::Vector& GetTags() const{ return m_tags; } /** *

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

*/ inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; } /** *

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

*/ inline void SetTags(const Aws::Vector& value) { m_tagsHasBeenSet = true; m_tags = value; } /** *

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

*/ inline void SetTags(Aws::Vector&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); } /** *

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

*/ inline CreateTaskRequest& WithTags(const Aws::Vector& value) { SetTags(value); return *this;} /** *

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

*/ inline CreateTaskRequest& WithTags(Aws::Vector&& value) { SetTags(std::move(value)); return *this;} /** *

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

*/ inline CreateTaskRequest& AddTags(const TagListEntry& value) { m_tagsHasBeenSet = true; m_tags.push_back(value); return *this; } /** *

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

*/ inline CreateTaskRequest& AddTags(TagListEntry&& value) { m_tagsHasBeenSet = true; m_tags.push_back(std::move(value)); return *this; } private: Aws::String m_sourceLocationArn; bool m_sourceLocationArnHasBeenSet; Aws::String m_destinationLocationArn; bool m_destinationLocationArnHasBeenSet; Aws::String m_cloudWatchLogGroupArn; bool m_cloudWatchLogGroupArnHasBeenSet; Aws::String m_name; bool m_nameHasBeenSet; Options m_options; bool m_optionsHasBeenSet; Aws::Vector m_excludes; bool m_excludesHasBeenSet; TaskSchedule m_schedule; bool m_scheduleHasBeenSet; Aws::Vector m_tags; bool m_tagsHasBeenSet; }; } // namespace Model } // namespace DataSync } // namespace Aws