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

Interface WorkflowDetails.Builder

    • Method Detail

      • onUpload

        WorkflowDetails.Builder onUpload​(Collection<WorkflowDetail> onUpload)

        A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.

        To remove an associated workflow from a server, you can provide an empty OnUpload object, as in the following example.

        aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'

        OnUpload can contain a maximum of one WorkflowDetail object.

        Parameters:
        onUpload - A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.

        To remove an associated workflow from a server, you can provide an empty OnUpload object, as in the following example.

        aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'

        OnUpload can contain a maximum of one WorkflowDetail object.

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

      • onUpload

        WorkflowDetails.Builder onUpload​(WorkflowDetail... onUpload)

        A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.

        To remove an associated workflow from a server, you can provide an empty OnUpload object, as in the following example.

        aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'

        OnUpload can contain a maximum of one WorkflowDetail object.

        Parameters:
        onUpload - A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.

        To remove an associated workflow from a server, you can provide an empty OnUpload object, as in the following example.

        aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'

        OnUpload can contain a maximum of one WorkflowDetail object.

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

      • onUpload

        WorkflowDetails.Builder onUpload​(Consumer<WorkflowDetail.Builder>... onUpload)

        A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.

        To remove an associated workflow from a server, you can provide an empty OnUpload object, as in the following example.

        aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'

        OnUpload can contain a maximum of one WorkflowDetail object.

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

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

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

      • onPartialUpload

        WorkflowDetails.Builder onPartialUpload​(Collection<WorkflowDetail> onPartialUpload)

        A trigger that starts a workflow if a file is only partially uploaded. You can attach a workflow to a server that executes whenever there is a partial upload.

        A partial upload occurs when a file is open when the session disconnects.

        OnPartialUpload can contain a maximum of one WorkflowDetail object.

        Parameters:
        onPartialUpload - A trigger that starts a workflow if a file is only partially uploaded. You can attach a workflow to a server that executes whenever there is a partial upload.

        A partial upload occurs when a file is open when the session disconnects.

        OnPartialUpload can contain a maximum of one WorkflowDetail object.

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

      • onPartialUpload

        WorkflowDetails.Builder onPartialUpload​(WorkflowDetail... onPartialUpload)

        A trigger that starts a workflow if a file is only partially uploaded. You can attach a workflow to a server that executes whenever there is a partial upload.

        A partial upload occurs when a file is open when the session disconnects.

        OnPartialUpload can contain a maximum of one WorkflowDetail object.

        Parameters:
        onPartialUpload - A trigger that starts a workflow if a file is only partially uploaded. You can attach a workflow to a server that executes whenever there is a partial upload.

        A partial upload occurs when a file is open when the session disconnects.

        OnPartialUpload can contain a maximum of one WorkflowDetail object.

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

      • onPartialUpload

        WorkflowDetails.Builder onPartialUpload​(Consumer<WorkflowDetail.Builder>... onPartialUpload)

        A trigger that starts a workflow if a file is only partially uploaded. You can attach a workflow to a server that executes whenever there is a partial upload.

        A partial upload occurs when a file is open when the session disconnects.

        OnPartialUpload can contain a maximum of one WorkflowDetail object.

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

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

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