Package com.influxdb.client.internal

Class InfluxDBClientImpl

java.lang.Object

com.influxdb.internal.AbstractRestClient

com.influxdb.client.internal.AbstractInfluxDBClient

com.influxdb.client.internal.InfluxDBClientImpl

All Implemented Interfaces:

InfluxDBClient, AutoCloseable

public final class InfluxDBClientImpl
extends AbstractInfluxDBClient
implements InfluxDBClient

Author:

Jakub Bednar (bednar@github) (11/10/2018 09:36)

Field Summary

Fields inherited from class com.influxdb.client.internal.AbstractInfluxDBClient

autoCloseables, DEFAULT_DIALECT, gzipInterceptor, healthService, loggingInterceptor, options, pingService, retrofit

Constructor Summary

Constructors

Constructor	Description
InfluxDBClientImpl(InfluxDBClientOptions options)

Method Summary

Modifier and Type	Method	Description
InfluxDBClient	disableGzip()	Disable Gzip compress for http request body.
InfluxDBClient	enableGzip()	Enable Gzip compress for http requests.
AuthorizationsApi	getAuthorizationsApi()	Create a new Authorization client.
BucketsApi	getBucketsApi()	Create a new Bucket client.
ChecksApi	getChecksApi()	Create a new Check client.
DashboardsApi	getDashboardsApi()	Create a new Dashboard client.
DeleteApi	getDeleteApi()	Create a new Delete client.
InfluxQLQueryApi	getInfluxQLQueryApi()	The InfluxQL can be used with /query compatibility endpoint which uses the database and retention policy specified in the query request to map the request to an InfluxDB bucket.
InvokableScriptsApi	getInvokableScriptsApi()	Create an InvokableScripts API instance.
LabelsApi	getLabelsApi()	Create a new Label client.
LogLevel	getLogLevel()
NotificationEndpointsApi	getNotificationEndpointsApi()	Create a new NotificationEndpoint client.
NotificationRulesApi	getNotificationRulesApi()	Create a new NotificationRules client.
OrganizationsApi	getOrganizationsApi()	Create a new Organization client.
QueryApi	getQueryApi()	Create a new Query client.
ScraperTargetsApi	getScraperTargetsApi()	Create a new ScraperTargetResponse client.
<S> S	getService(Class<S> service)	Create an implementation of the API endpoints defined by the service interface.
SourcesApi	getSourcesApi()	Create a new Source client.
TasksApi	getTasksApi()	Create a new Task client.
TelegrafsApi	getTelegrafsApi()	Create a new Telegraf client.
UsersApi	getUsersApi()	Create a new User client.
VariablesApi	getVariablesApi()	Create a new Variable client.
WriteApi	getWriteApi()	Create a new asynchronous non-blocking Write client.
WriteApi	getWriteApi(WriteOptions writeOptions)	Create a new asynchronous non-blocking Write client.
WriteApiBlocking	getWriteApiBlocking()	Create a new synchronous blocking Write client.
HealthCheck	health()	Get the health of an instance.
boolean	isGzipEnabled()	Returns whether Gzip compress for http request body is enabled.
Boolean	isOnboardingAllowed()	Check if database has default user, org, bucket created, returns true if not.
WriteApi	makeWriteApi()	Create a new asynchronous non-blocking Write client.
WriteApi	makeWriteApi(WriteOptions writeOptions)	Create a new asynchronous non-blocking Write client.
OnboardingResponse	onBoarding(OnboardingRequest onboarding)	Post onboarding request, to setup initial user, org and bucket.
Boolean	ping()	Check the status of InfluxDB Server.
Ready	ready()	The readiness of the InfluxDB 2.x.
InfluxDBClient	setLogLevel(LogLevel logLevel)	Set the log level for the request and response information.
String	version()	Returns the version of the connected InfluxDB Server.

Methods inherited from class com.influxdb.client.internal.AbstractInfluxDBClient

close, health

Methods inherited from class com.influxdb.internal.AbstractRestClient

execute, getLogLevel, ping, responseToError, setLogLevel, toInfluxException, version

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.influxdb.client.InfluxDBClient

close

Constructor Details

InfluxDBClientImpl

public InfluxDBClientImpl(@Nonnull
 InfluxDBClientOptions options)

Method Details

getQueryApi

@Nonnull
public QueryApi getQueryApi()

Description copied from interface: InfluxDBClient

Create a new Query client.

Specified by:

getQueryApi in interface InfluxDBClient

Returns:

the new client instance for the Query API

getWriteApi

@Nonnull
public WriteApi getWriteApi()

Description copied from interface: InfluxDBClient

Create a new asynchronous non-blocking Write client.

The WriteApi uses background thread to ingesting data into InfluxDB and is suppose to run as a singleton. Don't create new instance for every write.

Specified by:

getWriteApi in interface InfluxDBClient

Returns:

the new client instance for the Write API

getWriteApi

@Nonnull
public WriteApi getWriteApi(@Nonnull
 WriteOptions writeOptions)

Description copied from interface: InfluxDBClient

Create a new asynchronous non-blocking Write client.

Specified by:

getWriteApi in interface InfluxDBClient

Parameters:

writeOptions - the writes configuration

Returns:

the new client instance for the Write API

makeWriteApi

@Nonnull
public WriteApi makeWriteApi()

Description copied from interface: InfluxDBClient

Create a new asynchronous non-blocking Write client.

The WriteApi uses background thread to ingesting data into InfluxDB and is suppose to run as a singleton. Don't create new instance for every write.

Specified by:

makeWriteApi in interface InfluxDBClient

Returns:

the new client instance for the Write API

makeWriteApi

@Nonnull
public WriteApi makeWriteApi(@Nonnull
 WriteOptions writeOptions)

Description copied from interface: InfluxDBClient

Create a new asynchronous non-blocking Write client.

The WriteApi uses background thread to ingesting data into InfluxDB and is suppose to run as a singleton. Don't create new instance for every write.

Specified by:

makeWriteApi in interface InfluxDBClient

Parameters:

writeOptions - the writes configuration

Returns:

the new client instance for the Write API

getWriteApiBlocking

@Nonnull
public WriteApiBlocking getWriteApiBlocking()

Description copied from interface: InfluxDBClient

Create a new synchronous blocking Write client.

Specified by:

getWriteApiBlocking in interface InfluxDBClient

Returns:

the new client instance for the Write API

getAuthorizationsApi

@Nonnull
public AuthorizationsApi getAuthorizationsApi()

Description copied from interface: InfluxDBClient

Create a new Authorization client.

Specified by:

getAuthorizationsApi in interface InfluxDBClient

Returns:

the new client instance for Authorization API

getBucketsApi

@Nonnull
public BucketsApi getBucketsApi()

Description copied from interface: InfluxDBClient

Create a new Bucket client.

Specified by:

getBucketsApi in interface InfluxDBClient

Returns:

the new client instance for Bucket API

getOrganizationsApi

@Nonnull
public OrganizationsApi getOrganizationsApi()

Description copied from interface: InfluxDBClient

Create a new Organization client.

Specified by:

getOrganizationsApi in interface InfluxDBClient

Returns:

the new client instance for Organization API

getSourcesApi

@Nonnull
public SourcesApi getSourcesApi()

Description copied from interface: InfluxDBClient

Create a new Source client.

Specified by:

getSourcesApi in interface InfluxDBClient

Returns:

the new client instance for Source API

getTasksApi

@Nonnull
public TasksApi getTasksApi()

Description copied from interface: InfluxDBClient

Create a new Task client.

Specified by:

getTasksApi in interface InfluxDBClient

Returns:

the new client instance for Task API

getUsersApi

@Nonnull
public UsersApi getUsersApi()

Description copied from interface: InfluxDBClient

Create a new User client.

Specified by:

getUsersApi in interface InfluxDBClient

Returns:

the new client instance for User API

getScraperTargetsApi

@Nonnull
public ScraperTargetsApi getScraperTargetsApi()

Description copied from interface: InfluxDBClient

Create a new ScraperTargetResponse client.

Specified by:

getScraperTargetsApi in interface InfluxDBClient

Returns:

the new client instance for Scraper API

getTelegrafsApi

@Nonnull
public TelegrafsApi getTelegrafsApi()

Description copied from interface: InfluxDBClient

Create a new Telegraf client.

Specified by:

getTelegrafsApi in interface InfluxDBClient

Returns:

the new client instance for Telegrafs API

getLabelsApi

@Nonnull
public LabelsApi getLabelsApi()

Description copied from interface: InfluxDBClient

Create a new Label client.

Specified by:

getLabelsApi in interface InfluxDBClient

Returns:

the new client instance for Label API

getVariablesApi

@Nonnull
public VariablesApi getVariablesApi()

Description copied from interface: InfluxDBClient

Create a new Variable client.

Specified by:

getVariablesApi in interface InfluxDBClient

Returns:

the new client instance for Variable API

getDashboardsApi

@Nonnull
public DashboardsApi getDashboardsApi()

Description copied from interface: InfluxDBClient

Create a new Dashboard client.

Specified by:

getDashboardsApi in interface InfluxDBClient

Returns:

the new client instance for Dashboard API

getChecksApi

@Nonnull
public ChecksApi getChecksApi()

Description copied from interface: InfluxDBClient

Create a new Check client.

Specified by:

getChecksApi in interface InfluxDBClient

Returns:

the new client instance for Checks API

getNotificationEndpointsApi

@Nonnull
public NotificationEndpointsApi getNotificationEndpointsApi()

Description copied from interface: InfluxDBClient

Create a new NotificationEndpoint client.

Specified by:

getNotificationEndpointsApi in interface InfluxDBClient

Returns:

the new client instance for NotificationEndpoint API

getNotificationRulesApi

@Nonnull
public NotificationRulesApi getNotificationRulesApi()

Description copied from interface: InfluxDBClient

Create a new NotificationRules client.

Specified by:

getNotificationRulesApi in interface InfluxDBClient

Returns:

the new client instance for NotificationRules API

getDeleteApi

@Nonnull
public DeleteApi getDeleteApi()

Description copied from interface: InfluxDBClient

Create a new Delete client.

Specified by:

getDeleteApi in interface InfluxDBClient

Returns:

the new client instance for the Delete API

getInvokableScriptsApi

@Nonnull
public InvokableScriptsApi getInvokableScriptsApi()

Description copied from interface: InfluxDBClient

Create an InvokableScripts API instance.

Specified by:

getInvokableScriptsApi in interface InfluxDBClient

Returns:

InvokableScripts API instance

getInfluxQLQueryApi

@Nonnull
public InfluxQLQueryApi getInfluxQLQueryApi()

Description copied from interface: InfluxDBClient

The InfluxQL can be used with /query compatibility endpoint which uses the database and retention policy specified in the query request to map the request to an InfluxDB bucket.
For more information, see:

• /query 1.x compatibility API
• Database and retention policy mapping

Specified by:

getInfluxQLQueryApi in interface InfluxDBClient

Returns:

InfluxQLQuery API instance

getService

@Nonnull
public <S> S getService(@Nonnull
 Class<S> service)

Description copied from interface: InfluxDBClient

Create an implementation of the API endpoints defined by the service interface.

The endpoints are defined in com.influxdb.client.service.

Specified by:

getService in interface InfluxDBClient

Type Parameters:

S - type of service

Parameters:

service - service to instantiate

Returns:

instance of service

health

@Nonnull
public HealthCheck health()

Description copied from interface: InfluxDBClient

Get the health of an instance.

Specified by:

health in interface InfluxDBClient

Returns:

health of an instance

ping

@Nonnull
public Boolean ping()

Description copied from interface: InfluxDBClient

Check the status of InfluxDB Server.

Specified by:

ping in interface InfluxDBClient

Returns:

Boolean.TRUE if server is healthy otherwise return Boolean.FALSE

version

@Nonnull
public String version()

Description copied from interface: InfluxDBClient

Returns the version of the connected InfluxDB Server.

Specified by:

version in interface InfluxDBClient

Returns:

the version String, otherwise unknown.

ready

@Nullable
public Ready ready()

Description copied from interface: InfluxDBClient

The readiness of the InfluxDB 2.x.

Specified by:

ready in interface InfluxDBClient

Returns:

return null if the InfluxDB is not ready

onBoarding

@Nonnull
public OnboardingResponse onBoarding(@Nonnull
 OnboardingRequest onboarding)
                              throws UnprocessableEntityException

Description copied from interface: InfluxDBClient

Post onboarding request, to setup initial user, org and bucket.

Specified by:

onBoarding in interface InfluxDBClient

Parameters:

onboarding - to setup defaults

Returns:

defaults for first run

Throws:

UnprocessableEntityException - when an onboarding has already been completed

isOnboardingAllowed

@Nonnull
public Boolean isOnboardingAllowed()

Description copied from interface: InfluxDBClient

Check if database has default user, org, bucket created, returns true if not.

Specified by:

isOnboardingAllowed in interface InfluxDBClient

Returns:

Boolean.FALSE if onboarding has already been completed otherwise Boolean.FALSE.

getLogLevel

@Nonnull
public LogLevel getLogLevel()

Specified by:

getLogLevel in interface InfluxDBClient

Returns:

the LogLevel that is used for logging requests and responses

setLogLevel

@Nonnull
public InfluxDBClient setLogLevel(@Nonnull
 LogLevel logLevel)

Description copied from interface: InfluxDBClient

Set the log level for the request and response information.

Specified by:

setLogLevel in interface InfluxDBClient

Parameters:

logLevel - the log level to set.

Returns:

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

enableGzip

@Nonnull
public InfluxDBClient enableGzip()

Description copied from interface: InfluxDBClient

Enable Gzip compress for http requests.

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

Specified by:

enableGzip in interface InfluxDBClient

Returns:

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

disableGzip

@Nonnull
public InfluxDBClient disableGzip()

Description copied from interface: InfluxDBClient

Disable Gzip compress for http request body.

Specified by:

disableGzip in interface InfluxDBClient

Returns:

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

isGzipEnabled

public boolean isGzipEnabled()

Description copied from interface: InfluxDBClient

Returns whether Gzip compress for http request body is enabled.

Specified by:

isGzipEnabled in interface InfluxDBClient

Returns:

true if gzip is enabled.