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

Interface ListFileTransferResultsResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<ListFileTransferResultsResponse.Builder,ListFileTransferResultsResponse>, SdkBuilder<ListFileTransferResultsResponse.Builder,ListFileTransferResultsResponse>, SdkPojo, SdkResponse.Builder, TransferResponse.Builder

Enclosing class:

ListFileTransferResultsResponse

public static interface ListFileTransferResultsResponse.Builder
extends TransferResponse.Builder, SdkPojo, CopyableBuilder<ListFileTransferResultsResponse.Builder,ListFileTransferResultsResponse>

Method Summary

Modifier and Type	Method	Description
ListFileTransferResultsResponse.Builder	fileTransferResults(Collection<ConnectorFileTransferResult> fileTransferResults)	Returns the details for the files transferred in the transfer identified by the TransferId and ConnectorId specified.
ListFileTransferResultsResponse.Builder	fileTransferResults(Consumer<ConnectorFileTransferResult.Builder>... fileTransferResults)	Returns the details for the files transferred in the transfer identified by the TransferId and ConnectorId specified.
ListFileTransferResultsResponse.Builder	fileTransferResults(ConnectorFileTransferResult... fileTransferResults)	Returns the details for the files transferred in the transfer identified by the TransferId and ConnectorId specified.
ListFileTransferResultsResponse.Builder	nextToken(String nextToken)	Returns a token that you can use to call ListFileTransferResults again and receive additional results, if there are any (against the same TransferId.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.services.transfer.model.TransferResponse.Builder

build, responseMetadata, responseMetadata

Method Detail

fileTransferResults

ListFileTransferResultsResponse.Builder fileTransferResults(Collection<ConnectorFileTransferResult> fileTransferResults)

Returns the details for the files transferred in the transfer identified by the TransferId and ConnectorId specified.

• FilePath: the filename and path to where the file was sent to or retrieved from.

• StatusCode: current status for the transfer. The status returned is one of the following values: QUEUED, IN_PROGRESS, COMPLETED, or FAILED

• FailureCode: for transfers that fail, this parameter contains a code indicating the reason. For example, RETRIEVE_FILE_NOT_FOUND

• FailureMessage: for transfers that fail, this parameter describes the reason for the failure.

Parameters:

fileTransferResults - Returns the details for the files transferred in the transfer identified by the TransferId and ConnectorId specified.

• FilePath: the filename and path to where the file was sent to or retrieved from.

• StatusCode: current status for the transfer. The status returned is one of the following values:QUEUED, IN_PROGRESS, COMPLETED, or FAILED

• FailureCode: for transfers that fail, this parameter contains a code indicating the reason. For example, RETRIEVE_FILE_NOT_FOUND

• FailureMessage: for transfers that fail, this parameter describes the reason for the failure.

Returns:

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

fileTransferResults

ListFileTransferResultsResponse.Builder fileTransferResults(ConnectorFileTransferResult... fileTransferResults)

Returns the details for the files transferred in the transfer identified by the TransferId and ConnectorId specified.

• FilePath: the filename and path to where the file was sent to or retrieved from.

• StatusCode: current status for the transfer. The status returned is one of the following values: QUEUED, IN_PROGRESS, COMPLETED, or FAILED

• FailureCode: for transfers that fail, this parameter contains a code indicating the reason. For example, RETRIEVE_FILE_NOT_FOUND

• FailureMessage: for transfers that fail, this parameter describes the reason for the failure.

Parameters:

fileTransferResults - Returns the details for the files transferred in the transfer identified by the TransferId and ConnectorId specified.

• FilePath: the filename and path to where the file was sent to or retrieved from.

• StatusCode: current status for the transfer. The status returned is one of the following values:QUEUED, IN_PROGRESS, COMPLETED, or FAILED

• FailureCode: for transfers that fail, this parameter contains a code indicating the reason. For example, RETRIEVE_FILE_NOT_FOUND

• FailureMessage: for transfers that fail, this parameter describes the reason for the failure.

Returns:

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

fileTransferResults

ListFileTransferResultsResponse.Builder fileTransferResults(Consumer<ConnectorFileTransferResult.Builder>... fileTransferResults)

Returns the details for the files transferred in the transfer identified by the TransferId and ConnectorId specified.

• FilePath: the filename and path to where the file was sent to or retrieved from.

• StatusCode: current status for the transfer. The status returned is one of the following values: QUEUED, IN_PROGRESS, COMPLETED, or FAILED

• FailureCode: for transfers that fail, this parameter contains a code indicating the reason. For example, RETRIEVE_FILE_NOT_FOUND

• FailureMessage: for transfers that fail, this parameter describes the reason for the failure.

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

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

Parameters:

fileTransferResults - a consumer that will call methods on ConnectorFileTransferResult.Builder

Returns:

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

See Also:

#fileTransferResults(java.util.Collection)

nextToken

ListFileTransferResultsResponse.Builder nextToken(String nextToken)

Returns a token that you can use to call ListFileTransferResults again and receive additional results, if there are any (against the same TransferId.

Parameters:

nextToken - Returns a token that you can use to call ListFileTransferResults again and receive additional results, if there are any (against the same TransferId.

Returns:

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