Package software.amazon.awssdk.services.datasync.model

Interface StartTaskExecutionRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<StartTaskExecutionRequest.Builder,StartTaskExecutionRequest>, DataSyncRequest.Builder, SdkBuilder<StartTaskExecutionRequest.Builder,StartTaskExecutionRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
StartTaskExecutionRequest
public static interface StartTaskExecutionRequest.Builder extends DataSyncRequest.Builder, SdkPojo, CopyableBuilder<StartTaskExecutionRequest.Builder,StartTaskExecutionRequest>

  • Method Details

    • taskArn

      StartTaskExecutionRequest.Builder taskArn(String taskArn)

      Specifies the Amazon Resource Name (ARN) of the task that you want to start.

      Parameters:
      taskArn - Specifies the Amazon Resource Name (ARN) of the task that you want to start.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideOptions

      StartTaskExecutionRequest.Builder overrideOptions(Options overrideOptions)
      Sets the value of the OverrideOptions property for this object.
      Parameters:
      overrideOptions - The new value for the OverrideOptions property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideOptions

      default StartTaskExecutionRequest.Builder overrideOptions(Consumer<Options.Builder> overrideOptions)
      Sets the value of the OverrideOptions property for this object. This is a convenience method that creates an instance of the Options.Builder avoiding the need to create one manually via Options.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to overrideOptions(Options).

      Parameters:
      overrideOptions - a consumer that will call methods on Options.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • includes

      StartTaskExecutionRequest.Builder includes(Collection<FilterRule> includes)

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

    • includes

      StartTaskExecutionRequest.Builder includes(FilterRule... includes)

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

    • includes

      StartTaskExecutionRequest.Builder includes(Consumer<FilterRule.Builder>... includes)

      Specifies a list of filter rules that determines which files to include when running a task. The pattern should contain a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for example, "/folder1|/folder2".

      This is a convenience method that creates an instance of the FilterRule.Builder avoiding the need to create one manually via FilterRule.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to includes(List<FilterRule>).

      Parameters:
      includes - a consumer that will call methods on FilterRule.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • excludes

      StartTaskExecutionRequest.Builder excludes(Collection<FilterRule> excludes)

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

    • excludes

      StartTaskExecutionRequest.Builder excludes(FilterRule... excludes)

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

    • excludes

      StartTaskExecutionRequest.Builder excludes(Consumer<FilterRule.Builder>... excludes)

      Specifies a list of filter rules that determines which files to exclude from a task. The list contains a single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for example, "/folder1|/folder2".

      This is a convenience method that creates an instance of the FilterRule.Builder avoiding the need to create one manually via FilterRule.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to excludes(List<FilterRule>).

      Parameters:
      excludes - a consumer that will call methods on FilterRule.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • manifestConfig

      StartTaskExecutionRequest.Builder manifestConfig(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.

      To remove a manifest configuration, specify this parameter with an empty value.

      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.

      To remove a manifest configuration, specify this parameter with an empty value.

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

    • manifestConfig

      default StartTaskExecutionRequest.Builder manifestConfig(Consumer<ManifestConfig.Builder> 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.

      To remove a manifest configuration, specify this parameter with an empty value.

      This is a convenience method that creates an instance of the ManifestConfig.Builder avoiding the need to create one manually via ManifestConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to manifestConfig(ManifestConfig).

      Parameters:
      manifestConfig - a consumer that will call methods on ManifestConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • taskReportConfig

      StartTaskExecutionRequest.Builder taskReportConfig(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.

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

    • taskReportConfig

      default StartTaskExecutionRequest.Builder taskReportConfig(Consumer<TaskReportConfig.Builder> 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.

      To remove a task report configuration, specify this parameter as empty.

      This is a convenience method that creates an instance of the TaskReportConfig.Builder avoiding the need to create one manually via TaskReportConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to taskReportConfig(TaskReportConfig).

      Parameters:
      taskReportConfig - a consumer that will call methods on TaskReportConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      StartTaskExecutionRequest.Builder tags(Collection<TagListEntry> tags)

      Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task execution.

      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 the Amazon Resource Name (ARN) representing the task execution.

      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.

    • tags

      StartTaskExecutionRequest.Builder tags(TagListEntry... tags)

      Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task execution.

      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 the Amazon Resource Name (ARN) representing the task execution.

      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.

    • tags

      StartTaskExecutionRequest.Builder tags(Consumer<TagListEntry.Builder>... tags)

      Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task execution.

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

      This is a convenience method that creates an instance of the TagListEntry.Builder avoiding the need to create one manually via TagListEntry.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<TagListEntry>).

      Parameters:
      tags - a consumer that will call methods on TagListEntry.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      StartTaskExecutionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StartTaskExecutionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.