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

Class ListFileTransferResultsResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.transfer.model.TransferResponse

software.amazon.awssdk.services.transfer.model.ListFileTransferResultsResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListFileTransferResultsResponse.Builder,ListFileTransferResultsResponse>

@Generated("software.amazon.awssdk:codegen")
public final class ListFileTransferResultsResponse
extends TransferResponse
implements ToCopyableBuilder<ListFileTransferResultsResponse.Builder,ListFileTransferResultsResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListFileTransferResultsResponse.Builder

Method Summary

Modifier and Type	Method	Description
static ListFileTransferResultsResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<ConnectorFileTransferResult>	fileTransferResults()	Returns the details for the files transferred in the transfer identified by the TransferId and ConnectorId specified.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFileTransferResults()	For responses, this returns true if the service returned a value for the FileTransferResults property.
int	hashCode()
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.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ListFileTransferResultsResponse.Builder>	serializableBuilderClass()
ListFileTransferResultsResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.transfer.model.TransferResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

hasFileTransferResults

public final boolean hasFileTransferResults()

For responses, this returns true if the service returned a value for the FileTransferResults property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

fileTransferResults

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFileTransferResults() method.

Returns:

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.

nextToken

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

Returns:

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

toBuilder

public ListFileTransferResultsResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListFileTransferResultsResponse.Builder,ListFileTransferResultsResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static ListFileTransferResultsResponse.Builder builder()

serializableBuilderClass

public static Class<? extends ListFileTransferResultsResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo