Packages

t

com.influxdb.client.scala

InfluxDBClientScala

trait InfluxDBClientScala extends AnyRef

The reference Scala client that allows query and write for the InfluxDB 2.x by Pekko Streams.

Linear Supertypes
AnyRef, Any
Known Subclasses
InfluxDBClientScalaImpl
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. InfluxDBClientScala
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def close(): Unit

    Shutdown and close the client.

  2. abstract def disableGzip(): InfluxDBClientScala

    Disable Gzip compress for http request body.

    Disable Gzip compress for http request body.

    returns

    the InfluxDBClientScala instance to be able to use it in a fluent manner.

    Annotations
    @Nonnull()
  3. abstract def enableGzip(): InfluxDBClientScala

    Enable Gzip compress for http requests.

    Enable Gzip compress for http requests.

    Currently only the "Write" and "Query" endpoints supports the Gzip compression.

    returns

    the InfluxDBClientScala instance to be able to use it in a fluent manner.

    Annotations
    @Nonnull()
  4. abstract def getLogLevel: LogLevel

    Gets the LogLevel that is used for logging requests and responses.

    Gets the LogLevel that is used for logging requests and responses.

    returns

    the LogLevel that is used for logging requests and responses

    Annotations
    @Nonnull()
  5. abstract def getQueryScalaApi(): QueryScalaApi

    Create a new Query client.

    Create a new Query client.

    returns

    the new client instance for the Query API

    Annotations
    @Nonnull()
  6. abstract def getWriteScalaApi: WriteScalaApi

    Create a new WriteApi client.

    Create a new WriteApi client.

    returns

    the new client instance for the Write API

    Annotations
    @Nonnull()
  7. abstract def isGzipEnabled: Boolean

    Returns whether Gzip compress for http request body is enabled.

    Returns whether Gzip compress for http request body is enabled.

    returns

    true if gzip is enabled.

    Annotations
    @Nonnull()
  8. abstract def ping: Boolean

    Check the status of InfluxDB Server.

    Check the status of InfluxDB Server.

    returns

    true if server is healthy otherwise return false

    Annotations
    @Nonnull()
  9. abstract def setLogLevel(logLevel: LogLevel): InfluxDBClientScala

    Sets the log level for the request and response information.

    Sets the log level for the request and response information.

    logLevel

    the log level to set.

    returns

    the InfluxDBClientScala instance to be able to use it in a fluent manner.

    Annotations
    @Nonnull()
  10. abstract def version: String

    Returns the version of the connected InfluxDB Server.

    Returns the version of the connected InfluxDB Server.

    returns

    the version String, otherwise unknown.

    Annotations
    @Nonnull()
  11. abstract def health: HealthCheck

    Get the health of an instance.

    Get the health of an instance.

    returns

    health of an instance

    Annotations
    @deprecated @Nonnull()
    Deprecated

    This method is obsolete. Use ping() or version()