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 interfaceConnectorFileTransferResult.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ConnectorFileTransferResult.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringfailureCode()For transfers that fail, this parameter contains a code indicating the reason.StringfailureMessage()For transfers that fail, this parameter describes the reason for the failure.StringfilePath()The filename and path to where the file was sent to or retrieved from.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends ConnectorFileTransferResult.Builder>serializableBuilderClass()TransferTableStatusstatusCode()The current status for the transfer.StringstatusCodeAsString()The current status for the transfer.ConnectorFileTransferResult.BuildertoBuilder()StringtoString()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,
statusCodewill returnTransferTableStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusCodeAsString().- 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,
statusCodewill returnTransferTableStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusCodeAsString().- 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:
toBuilderin interfaceToCopyableBuilder<ConnectorFileTransferResult.Builder,ConnectorFileTransferResult>
-
builder
public static ConnectorFileTransferResult.Builder builder()
-
serializableBuilderClass
public static Class<? extends ConnectorFileTransferResult.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-