Class/Object

io.smartdatalake.workflow.connection

SftpFileRefConnection

Related Docs: object SftpFileRefConnection | package connection

Permalink

case class SftpFileRefConnection(id: ConnectionId, host: String, port: Int = 22, authMode: AuthMode, ignoreHostKeyVerification: Boolean = false, maxParallelConnections: Int = 1, connectionPoolMaxIdleTimeSec: Int = 3, metadata: Option[ConnectionMetadata] = None) extends Connection with Product with Serializable

SFTP Connection information

id

unique id of this connection

host

sftp host

port

port of sftp service, default is 22

authMode

authentication information: for now BasicAuthMode and PublicKeyAuthMode are supported.

ignoreHostKeyVerification

do not validate host key if true, default is false

maxParallelConnections

number of parallel sftp connections created by an instance of this connection

connectionPoolMaxIdleTimeSec

timeout to close unused connections in the pool

Linear Supertypes
Serializable, Serializable, Product, Equals, Connection, AtlasExportable, ParsableFromConfig[Connection], SdlConfigObject, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SftpFileRefConnection
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Connection
  7. AtlasExportable
  8. ParsableFromConfig
  9. SdlConfigObject
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SftpFileRefConnection(id: ConnectionId, host: String, port: Int = 22, authMode: AuthMode, ignoreHostKeyVerification: Boolean = false, maxParallelConnections: Int = 1, connectionPoolMaxIdleTimeSec: Int = 3, metadata: Option[ConnectionMetadata] = None)

    Permalink

    id

    unique id of this connection

    host

    sftp host

    port

    port of sftp service, default is 22

    authMode

    authentication information: for now BasicAuthMode and PublicKeyAuthMode are supported.

    ignoreHostKeyVerification

    do not validate host key if true, default is false

    maxParallelConnections

    number of parallel sftp connections created by an instance of this connection

    connectionPoolMaxIdleTimeSec

    timeout to close unused connections in the pool

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def atlasName: String

    Permalink
    Definition Classes
    Connection → AtlasExportable

  6. def atlasQualifiedName(prefix: String): String

    Permalink
    Definition Classes
    AtlasExportable

  7. val authMode: AuthMode

    Permalink

    authentication information: for now BasicAuthMode and PublicKeyAuthMode are supported.

  8. def clone(): AnyRef

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

  9. val connectionPoolMaxIdleTimeSec: Int

    Permalink

    timeout to close unused connections in the pool

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

    Permalink
    Definition Classes
    AnyRef

  11. def execWithSFtpClient[A](func: (SFTPClient) ⇒ A): A

    Permalink

  12. def factory: FromConfigFactory[Connection]

    Permalink

    Returns the factory that can parse this type (that is, type CO).

    Returns the factory that can parse this type (that is, type CO).

    Typically, implementations of this method should return the companion object of the implementing class. The companion object in turn should implement FromConfigFactory.

    returns

    the factory (object) for this class.

    Definition Classes
    SftpFileRefConnection → ParsableFromConfig

  13. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  15. val host: String

    Permalink

    sftp host

  16. val id: ConnectionId

    Permalink

    unique id of this connection

    unique id of this connection

    Definition Classes
    SftpFileRefConnection → Connection → SdlConfigObject

  17. val ignoreHostKeyVerification: Boolean

    Permalink

    do not validate host key if true, default is false

  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  19. val maxParallelConnections: Int

    Permalink

    number of parallel sftp connections created by an instance of this connection

  20. val metadata: Option[ConnectionMetadata]

    Permalink

    Additional metadata for the Connection

    Additional metadata for the Connection

    Definition Classes
    SftpFileRefConnection → Connection

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

    Permalink
    Definition Classes
    AnyRef

  22. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  23. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  24. val pool: GenericObjectPool[SFTPClient]

    Permalink

  25. val port: Int

    Permalink

    port of sftp service, default is 22

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

    Permalink
    Definition Classes
    AnyRef

  27. def test(): Unit

    Permalink

  28. def toStringShort: String

    Permalink
    Definition Classes
    Connection

  29. final def wait(): Unit

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

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

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

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

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Connection

Inherited from AtlasExportable

Inherited from ParsableFromConfig[Connection]

Inherited from SdlConfigObject

Inherited from AnyRef

Inherited from Any

Ungrouped