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

Class ConnectorFileTransferResult

java.lang.Object

software.amazon.awssdk.services.transfer.model.ConnectorFileTransferResult

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ConnectorFileTransferResult.Builder,ConnectorFileTransferResult>

@Generated("software.amazon.awssdk:codegen")
public final class ConnectorFileTransferResult
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ConnectorFileTransferResult.Builder,ConnectorFileTransferResult>

A structure that contains the details for files transferred using an SFTP connector, during a single transfer.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ConnectorFileTransferResult.Builder

Method Summary

Modifier and Type	Method	Description
static ConnectorFileTransferResult.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failureCode()	For transfers that fail, this parameter contains a code indicating the reason.
String	failureMessage()	For transfers that fail, this parameter describes the reason for the failure.
String	filePath()	The filename and path to where the file was sent to or retrieved from.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ConnectorFileTransferResult.Builder>	serializableBuilderClass()
TransferTableStatus	statusCode()	The current status for the transfer.
String	statusCodeAsString()	The current status for the transfer.
ConnectorFileTransferResult.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

filePath

public final String filePath()

The filename and path to where the file was sent to or retrieved from.

Returns:

The filename and path to where the file was sent to or retrieved from.

statusCode

public final TransferTableStatus statusCode()

The current status for the transfer.

If the service returns an enum value that is not available in the current SDK version, statusCode will return TransferTableStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusCodeAsString().

Returns:

The current status for the transfer.

See Also:

TransferTableStatus

statusCodeAsString

public final String statusCodeAsString()

The current status for the transfer.

If the service returns an enum value that is not available in the current SDK version, statusCode will return TransferTableStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusCodeAsString().

Returns:

The current status for the transfer.

See Also:

TransferTableStatus

failureCode

public final String failureCode()

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

Returns:

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

failureMessage

public final String failureMessage()

For transfers that fail, this parameter describes the reason for the failure.

Returns:

For transfers that fail, this parameter describes the reason for the failure.

toBuilder

public ConnectorFileTransferResult.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ConnectorFileTransferResult.Builder,ConnectorFileTransferResult>

builder

public static ConnectorFileTransferResult.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

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