com.influxdb.client.scala.InfluxDBClientScala.scala Maven / Gradle / Ivy
/*
* The MIT License
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package com.influxdb.client.scala
import com.influxdb.LogLevel
import com.influxdb.client.domain.HealthCheck
import javax.annotation.Nonnull
/**
* The reference Scala client that allows query and write for the InfluxDB 2.x by Pekko Streams.
*
* @author Jakub Bednar (bednar@github) (08/02/2019 09:09)
*/
trait InfluxDBClientScala {
/**
* Create a new Query client.
*
* @return the new client instance for the Query API
*/
@Nonnull def getQueryScalaApi(): QueryScalaApi
/**
* Create a new WriteApi client.
*
* @return the new client instance for the Write API
*/
@Nonnull def getWriteScalaApi: WriteScalaApi
/**
* Get the health of an instance.
*
* @return health of an instance
*/
@deprecated("This method is obsolete. Use `ping()` or `version()`")
@Nonnull def health: HealthCheck
/**
* Check the status of InfluxDB Server.
*
* @return true if server is healthy otherwise return false
*/
@Nonnull def ping: Boolean
/**
* Returns the version of the connected InfluxDB Server.
*
* @return the version String, otherwise unknown.
*/
@Nonnull def version: String
/**
* Gets the [[LogLevel]] that is used for logging requests and responses.
*
* @return the [[LogLevel]] that is used for logging requests and responses
*/
@Nonnull def getLogLevel: LogLevel
/**
* Sets the log level for the request and response information.
*
* @param logLevel the log level to set.
* @return the [[InfluxDBClientScala]] instance to be able to use it in a fluent manner.
*/
@Nonnull def setLogLevel(@Nonnull logLevel: LogLevel): InfluxDBClientScala
/**
* Enable Gzip compress for http requests.
*
* Currently only the "Write" and "Query" endpoints supports the Gzip compression.
*
* @return the [[InfluxDBClientScala]] instance to be able to use it in a fluent manner.
*/
@Nonnull def enableGzip(): InfluxDBClientScala
/**
* Disable Gzip compress for http request body.
*
* @return the [[InfluxDBClientScala]] instance to be able to use it in a fluent manner.
*/
@Nonnull def disableGzip(): InfluxDBClientScala
/**
* Returns whether Gzip compress for http request body is enabled.
*
* @return true if gzip is enabled.
*/
@Nonnull def isGzipEnabled: Boolean
/**
* Shutdown and close the client.
*/
def close(): Unit
}