Class/Object

com.github.arcizon.spark.filetransfer.util

FileTransferOptions

Related Docs: object FileTransferOptions | package util

Permalink

class FileTransferOptions extends Serializable with Logging

Since

0.1.0

Linear Supertypes
Logging, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FileTransferOptions
  2. Logging
  3. Serializable
  4. Serializable
  5. AnyRef
  6. 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 FileTransferOptions(parameters: Map[String, String])

    Permalink

    parameters

    Options specified on the DataFrame API Reader/Writer.

    Since

    0.1.0

  2. new FileTransferOptions(parameters: CaseInsensitiveMap[String])

    Permalink

    Create a new FileTransferOptions by specifying their parameters.

    Create a new FileTransferOptions by specifying their parameters.

    parameters

    Options specified on the DataFrame API Reader/Writer.

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 FileTransferOptions to any2stringadd[FileTransferOptions] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from FileTransferOptions to ArrowAssoc[FileTransferOptions] 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. val dfOptions: Map[String, String]

    Permalink

    All other options except the extracted options from the above to be passed along to the DataFrame API for read/write.

    All other options except the extracted options from the above to be passed along to the DataFrame API for read/write. For example, csv options like delimiter for the csv file format etc.

    Since

    0.1.0

  9. val dfsTempPath: String

    Permalink

    Value set with the option key dfsTempPath.

    Value set with the option key dfsTempPath. Default value set to option value from localTempPath.

    Since

    0.1.0

    Note

    If dfsTempPath is not provided then the downloaded file from remote host would be on the local path which is not splittable and therefore, parallelism might not be achieved during the file scan to load data.

  10. def ensuring(cond: (FileTransferOptions) ⇒ Boolean, msg: ⇒ Any): FileTransferOptions

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

  11. def ensuring(cond: (FileTransferOptions) ⇒ Boolean): FileTransferOptions

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

  12. def ensuring(cond: Boolean, msg: ⇒ Any): FileTransferOptions

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

  13. def ensuring(cond: Boolean): FileTransferOptions

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

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

    Permalink
    Definition Classes
    AnyRef

  15. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  16. val fileFormat: FileFormat.Value

    Permalink

    Value set with the option key fileFormat.

    Value set with the option key fileFormat.

    Since

    0.1.0

    Exceptions thrown

    java.lang.RuntimeException Missing 'fileFormat' option.

  17. def finalize(): Unit

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

  18. def formatted(fmtstr: String): String

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  20. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  21. val host: String

    Permalink

    Value set with the option key host.

    Value set with the option key host. Default value set to localhost.

    Since

    0.1.0

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  23. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  24. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  25. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  26. val keyFilePath: Option[String]

    Permalink

    Value set with the option key keyFilePath.

    Value set with the option key keyFilePath.

    Since

    0.1.0

  27. val localTempPath: String

    Permalink

    Value set with the option key localTempPath.

    Value set with the option key localTempPath. Default value set to java system property of java.io.tmpdir with a fallback value of /tmp.

    Since

    0.1.0

  28. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  35. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Definition Classes
    AnyRef

  41. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  42. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  43. val passphrase: Option[String]

    Permalink

    Value set with the option key passphrase.

    Value set with the option key passphrase.

    Since

    0.1.0

  44. val password: Option[String]

    Permalink

    Value set with the option key password.

    Value set with the option key password.

    Since

    0.1.0

  45. val path: String

    Permalink

    Value set with the option key path.

    Value set with the option key path.

    Since

    0.1.0

    Exceptions thrown

    java.lang.RuntimeException Missing 'path' option.

  46. val port: Int

    Permalink

    Value set with the option key port.

    Value set with the option key port. Default value set to 22.

    Since

    0.1.0

  47. val protocol: Protocol.Value

    Permalink

    Value set with the option key protocol.

    Value set with the option key protocol. Default value set to sftp.

    Since

    0.1.0

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

    Permalink
    Definition Classes
    AnyRef

  49. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  50. val uploadFilePrefix: String

    Permalink

    Value set with the option key uploadFilePrefix.

    Value set with the option key uploadFilePrefix. Default value set to part.

    Since

    0.1.0

  51. val username: String

    Permalink

    Value set with the option key username.

    Value set with the option key username.

    Since

    0.1.0

    Exceptions thrown

    java.lang.RuntimeException Missing 'username' option.

  52. final def wait(): Unit

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

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

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

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

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

  55. def →[B](y: B): (FileTransferOptions, B)

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

Inherited from Logging

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped