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

Interface StartTaskExecutionRequest.Builder

    • Method Detail

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

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

        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:
        #includes(java.util.Collection)

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

        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:
        #excludes(java.util.Collection)

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

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

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

        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:
        #tags(java.util.Collection)