Class

com.github.arcizon.spark.filetransfer.client

SFTP

Related Doc: package client

Permalink

class SFTP extends BaseClient with Logging

The SFTPClient class provides upload and download methods to transfer files to/from remote host via SFTP.

Since

0.1.0

Linear Supertypes
Logging, BaseClient, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SFTP
  2. Logging
  3. BaseClient
  4. AnyRef
  5. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SFTP(options: FileTransferOptions)

    Permalink

    Create a new SFTPClient by specifying their options.

    Create a new SFTPClient by specifying their options.

    options

    Options passed by the user on the DataFrameReader or DataFrameWriter API.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from SFTP to any2stringadd[SFTP] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (SFTP, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from SFTP to ArrowAssoc[SFTP] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. def download(src: String, dest: String): Unit

    Permalink

    Downloads files from remote host.

    Downloads files from remote host.

    src

    Remote file/directory path.

    dest

    Local directory path.

    returns

    Returns unit of successful download.

    Definition Classes
    SFTP → BaseClient

  9. def ensuring(cond: (SFTP) ⇒ Boolean, msg: ⇒ Any): SFTP

    Permalink
    Implicit information
    This member is added by an implicit conversion from SFTP to Ensuring[SFTP] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  10. def ensuring(cond: (SFTP) ⇒ Boolean): SFTP

    Permalink
    Implicit information
    This member is added by an implicit conversion from SFTP to Ensuring[SFTP] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: Boolean, msg: ⇒ Any): SFTP

    Permalink
    Implicit information
    This member is added by an implicit conversion from SFTP to Ensuring[SFTP] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. def ensuring(cond: Boolean): SFTP

    Permalink
    Implicit information
    This member is added by an implicit conversion from SFTP to Ensuring[SFTP] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  14. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  15. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  16. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from SFTP to StringFormat[SFTP] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  17. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  18. def getPutMode(client: ChannelSftp, target: String, mode: SaveMode): Int

    Permalink

    Gets the SFTP upload mode based on the provided Spark DataFrameWriter save mode.

    Gets the SFTP upload mode based on the provided Spark DataFrameWriter save mode.

    client

    SFTP client instance.

    target

    Target file path to upload on the remote machine.

    mode

    Spark DataFrame save mode to determine the file upload mode.

    returns

    SFTP upload mode.

    Since

    0.3.0

  19. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  20. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  21. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  23. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  24. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  25. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  26. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  27. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  28. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  29. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  30. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  31. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  32. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  33. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  34. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  35. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  36. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  37. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  38. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  39. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  40. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  41. def upload(src: String, dest: String, mode: SaveMode = SaveMode.Overwrite): Unit

    Permalink

    Uploads local files to remote host.

    Uploads local files to remote host.

    src

    Local file/directory path.

    dest

    Remote directory path.

    mode

    Spark DataFrame Write Mode.

    returns

    Returns unit of successful upload.

    Definition Classes
    SFTP → BaseClient

  42. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  43. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  44. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  45. def →[B](y: B): (SFTP, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from SFTP to ArrowAssoc[SFTP] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Logging

Inherited from BaseClient

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from SFTP to any2stringadd[SFTP]

Inherited by implicit conversion StringFormat from SFTP to StringFormat[SFTP]

Inherited by implicit conversion Ensuring from SFTP to Ensuring[SFTP]

Inherited by implicit conversion ArrowAssoc from SFTP to ArrowAssoc[SFTP]

Ungrouped