Class StartFileTransferRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.transfer.model.TransferRequest
software.amazon.awssdk.services.transfer.model.StartFileTransferRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartFileTransferRequest.Builder,StartFileTransferRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartFileTransferRequest extends TransferRequest implements ToCopyableBuilder<StartFileTransferRequest.Builder,StartFileTransferRequest>

  • Method Details

    • connectorId

      public final String connectorId()

      The unique identifier for the connector.

      Returns:
      The unique identifier for the connector.

    • hasSendFilePaths

      public final boolean hasSendFilePaths()
      For responses, this returns true if the service returned a value for the SendFilePaths 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.

    • sendFilePaths

      public final List<String> sendFilePaths()

      One or more source paths for the Amazon S3 storage. Each string represents a source file path for one outbound file transfer. For example, amzn-s3-demo-bucket/myfile.txt .

      Replace amzn-s3-demo-bucket with one of your actual buckets.

      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 hasSendFilePaths() method.

      Returns:
      One or more source paths for the Amazon S3 storage. Each string represents a source file path for one outbound file transfer. For example, amzn-s3-demo-bucket/myfile.txt .

      Replace amzn-s3-demo-bucket with one of your actual buckets.

    • hasRetrieveFilePaths

      public final boolean hasRetrieveFilePaths()
      For responses, this returns true if the service returned a value for the RetrieveFilePaths 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.

    • retrieveFilePaths

      public final List<String> retrieveFilePaths()

      One or more source paths for the partner's SFTP server. Each string represents a source file path for one inbound file transfer.

      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 hasRetrieveFilePaths() method.

      Returns:
      One or more source paths for the partner's SFTP server. Each string represents a source file path for one inbound file transfer.

    • localDirectoryPath

      public final String localDirectoryPath()

      For an inbound transfer, the LocaDirectoryPath specifies the destination for one or more files that are transferred from the partner's SFTP server.

      Returns:
      For an inbound transfer, the LocaDirectoryPath specifies the destination for one or more files that are transferred from the partner's SFTP server.

    • remoteDirectoryPath

      public final String remoteDirectoryPath()

      For an outbound transfer, the RemoteDirectoryPath specifies the destination for one or more files that are transferred to the partner's SFTP server. If you don't specify a RemoteDirectoryPath, the destination for transferred files is the SFTP user's home directory.

      Returns:
      For an outbound transfer, the RemoteDirectoryPath specifies the destination for one or more files that are transferred to the partner's SFTP server. If you don't specify a RemoteDirectoryPath, the destination for transferred files is the SFTP user's home directory.

    • toBuilder

      public StartFileTransferRequest.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<StartFileTransferRequest.Builder,StartFileTransferRequest>
      Specified by:
      toBuilder in class TransferRequest
      Returns:
      a builder for type T

    • builder

      public static StartFileTransferRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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