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:

  • Method Details

    • 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:

    • 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:

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ConnectorFileTransferResult.Builder,ConnectorFileTransferResult>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.