-
- All Implemented Interfaces:
-
java.io.Closeable,java.lang.AutoCloseable
public interface InfluxDBClientKotlin implements Closeable
The reference Kotlin client that allows query and write for the InfluxDB 2.x by Kotlin Channel coroutines.
-
-
Method Summary
Modifier and Type Method Description abstract QueryKotlinApigetQueryKotlinApi()Create a new Query client. abstract WriteKotlinApigetWriteKotlinApi()Create a new Write client. abstract HealthCheckhealth()Get the health of an instance. abstract Booleanping()Check the status of InfluxDB Server. abstract Stringversion()Returns the version of the connected InfluxDB Server. abstract LogLevelgetLogLevel()Gets the LogLevel that is used for logging requests and responses. abstract InfluxDBClientKotlinsetLogLevel(LogLevel logLevel)Sets the log level for the request and response information. abstract InfluxDBClientKotlinenableGzip()Enable Gzip compress for http requests. abstract InfluxDBClientKotlindisableGzip()Disable Gzip compress for http request body. abstract BooleanisGzipEnabled()Returns whether Gzip compress for http request body is enabled. abstract Unitclose()Shutdown and close the client. -
-
Method Detail
-
getQueryKotlinApi
abstract QueryKotlinApi getQueryKotlinApi()
Create a new Query client.
-
getWriteKotlinApi
abstract WriteKotlinApi getWriteKotlinApi()
Create a new Write client.
-
health
@Deprecated(message = "This method is obsolete. Use `ping()` or `version()`", replaceWith = @ReplaceWith(imports = {}, expression = "ping()")) abstract HealthCheck health()
Get the health of an instance.
-
getLogLevel
abstract LogLevel getLogLevel()
Gets the LogLevel that is used for logging requests and responses.
-
setLogLevel
abstract InfluxDBClientKotlin setLogLevel(LogLevel logLevel)
Sets the log level for the request and response information.
- Parameters:
logLevel- the log level to set.
-
enableGzip
abstract InfluxDBClientKotlin enableGzip()
Enable Gzip compress for http requests.
Currently only the "Write" and "Query" endpoints supports the Gzip compression.
-
disableGzip
abstract InfluxDBClientKotlin disableGzip()
Disable Gzip compress for http request body.
-
isGzipEnabled
abstract Boolean isGzipEnabled()
Returns whether Gzip compress for http request body is enabled.
-
-
-
-