Package software.amazon.awssdk.services.transfer.model

Interface DescribedWorkflow.Builder

    • Method Detail

      • arn

        DescribedWorkflow.Builder arn​(String arn)

        Specifies the unique Amazon Resource Name (ARN) for the workflow.

        Parameters:
        arn - Specifies the unique Amazon Resource Name (ARN) for the workflow.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        DescribedWorkflow.Builder description​(String description)

        Specifies the text description for the workflow.

        Parameters:
        description - Specifies the text description for the workflow.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • steps

        DescribedWorkflow.Builder steps​(Collection<WorkflowStep> steps)

        Specifies the details for the steps that are in the specified workflow.

        Parameters:
        steps - Specifies the details for the steps that are in the specified workflow.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • steps

        DescribedWorkflow.Builder steps​(WorkflowStep... steps)

        Specifies the details for the steps that are in the specified workflow.

        Parameters:
        steps - Specifies the details for the steps that are in the specified workflow.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • onExceptionSteps

        DescribedWorkflow.Builder onExceptionSteps​(Collection<WorkflowStep> onExceptionSteps)

        Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

        Parameters:
        onExceptionSteps - Specifies the steps (actions) to take if errors are encountered during execution of the workflow.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • onExceptionSteps

        DescribedWorkflow.Builder onExceptionSteps​(WorkflowStep... onExceptionSteps)

        Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

        Parameters:
        onExceptionSteps - Specifies the steps (actions) to take if errors are encountered during execution of the workflow.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • onExceptionSteps

        DescribedWorkflow.Builder onExceptionSteps​(Consumer<WorkflowStep.Builder>... onExceptionSteps)

        Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #onExceptionSteps(List).

        Parameters:
        onExceptionSteps - a consumer that will call methods on WorkflowStep.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #onExceptionSteps(java.util.Collection)

      • workflowId

        DescribedWorkflow.Builder workflowId​(String workflowId)

        A unique identifier for the workflow.

        Parameters:
        workflowId - A unique identifier for the workflow.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        DescribedWorkflow.Builder tags​(Collection<Tag> tags)

        Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.

        Parameters:
        tags - Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        DescribedWorkflow.Builder tags​(Tag... tags)

        Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.

        Parameters:
        tags - Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        DescribedWorkflow.Builder tags​(Consumer<Tag.Builder>... tags)

        Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.

        This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.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 Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)