Packages

case class Connection(url: String, username: String, password: String, caCert: String, caPath: String, clientCert: String, clientKey: String, tlsServerName: String, insecure: Boolean = false, verifyConnection: Boolean = true, allowedRoles: Array[String] = Array.empty) extends BaseConnection with Product with Serializable

url

The URL for Elasticsearch's API (eg: "http://localhost:9200").

username

The username to be used in the connection URL.

password

The password to be used in the connection URL.

caCert

The path to a PEM-encoded CA cert file to use to verify the Elasticsearch server's identity.

caPath

The path to a directory of PEM-encoded CA cert files to use to verify the Elasticsearch server's identity.

clientCert

The path to the certificate for the Elasticsearch client to present for communication.

clientKey

The path to the key for the Elasticsearch client to use for communication.

tlsServerName

This, if set, is used to set the SNI host when connecting via TLS.

insecure

If set to true SSL verification will be disabled.

verifyConnection

Specifies if the connection is verified during initial configuration. Defaults to true.

allowedRoles

List of the roles allowed to use this connection. Defaults to empty (no roles), if contains a "*" any role can use this connection.

Source
Connection.scala
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Connection
  2. Serializable
  3. Product
  4. Equals
  5. BaseConnection
  6. AnyRef
  7. Any
Implicitly
  1. by StringFormat
  2. by Ensuring
  3. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Connection(url: String, username: String, password: String, caCert: String, caPath: String, clientCert: String, clientKey: String, tlsServerName: String, insecure: Boolean = false, verifyConnection: Boolean = true, allowedRoles: Array[String] = Array.empty)

    url

    The URL for Elasticsearch's API (eg: "http://localhost:9200").

    username

    The username to be used in the connection URL.

    password

    The password to be used in the connection URL.

    caCert

    The path to a PEM-encoded CA cert file to use to verify the Elasticsearch server's identity.

    caPath

    The path to a directory of PEM-encoded CA cert files to use to verify the Elasticsearch server's identity.

    clientCert

    The path to the certificate for the Elasticsearch client to present for communication.

    clientKey

    The path to the key for the Elasticsearch client to use for communication.

    tlsServerName

    This, if set, is used to set the SNI host when connecting via TLS.

    insecure

    If set to true SSL verification will be disabled.

    verifyConnection

    Specifies if the connection is verified during initial configuration. Defaults to true.

    allowedRoles

    List of the roles allowed to use this connection. Defaults to empty (no roles), if contains a "*" any role can use this connection.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def ->[B](y: B): (Connection, B)
    Implicit
    This member is added by an implicit conversion from Connection toArrowAssoc[Connection] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. val allowedRoles: Array[String]

    List of the roles allowed to use this connection.

    List of the roles allowed to use this connection. Defaults to empty (no roles), if contains a "*" any role can use this connection.

    Definition Classes
    ConnectionBaseConnection
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val caCert: String
  8. val caPath: String
  9. val clientCert: String
  10. val clientKey: String
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  12. def ensuring(cond: (Connection) => Boolean, msg: => Any): Connection
    Implicit
    This member is added by an implicit conversion from Connection toEnsuring[Connection] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (Connection) => Boolean): Connection
    Implicit
    This member is added by an implicit conversion from Connection toEnsuring[Connection] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: => Any): Connection
    Implicit
    This member is added by an implicit conversion from Connection toEnsuring[Connection] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): Connection
    Implicit
    This member is added by an implicit conversion from Connection toEnsuring[Connection] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  18. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Connection toStringFormat[Connection] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  19. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. val insecure: Boolean
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. val password: String
  26. def pluginName: String

    The name of the plugin to use for this connection.

    The name of the plugin to use for this connection.

    Definition Classes
    ConnectionBaseConnection
  27. def productElementNames: Iterator[String]
    Definition Classes
    Product
  28. final val rootRotationStatements: Array[String]

    The elasticsearch plugin does not support root rotation statements

    The elasticsearch plugin does not support root rotation statements

    Definition Classes
    ConnectionBaseConnection
  29. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  30. val tlsServerName: String
  31. val url: String
  32. val username: String
  33. val verifyConnection: Boolean

    If the connection is verified during initial configuration.

    If the connection is verified during initial configuration.

    Definition Classes
    ConnectionBaseConnection
  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def [B](y: B): (Connection, B)
    Implicit
    This member is added by an implicit conversion from Connection toArrowAssoc[Connection] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from BaseConnection

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion StringFormat fromConnection to StringFormat[Connection]

Inherited by implicit conversion Ensuring fromConnection to Ensuring[Connection]

Inherited by implicit conversion ArrowAssoc fromConnection to ArrowAssoc[Connection]

Ungrouped