com.influxdb.client

Interface InfluxDBClient

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

InfluxDBClientImpl

@ThreadSafe
public interface InfluxDBClient
extends AutoCloseable

The client of theInfluxDB 2.0for Time Series that implements HTTP API defined by Influx API Service swagger.yml.

Author:

Jakub Bednar (bednar@github) (11/10/2018 08:56)

Method Summary

Modifier and Type	Method and Description
void	close() Shutdown and close the client.
InfluxDBClient	disableGzip() Disable Gzip compress for http request body.
InfluxDBClient	enableGzip() Enable Gzip compress for http requests.
AuthorizationsApi	getAuthorizationsApi() Get the Authorization client.
BucketsApi	getBucketsApi() Get the Bucket client.
ChecksApi	getChecksApi() Get the Check client.
DashboardsApi	getDashboardsApi() Get the Dashboard client.
DeleteApi	getDeleteApi() Get the Delete client.
LabelsApi	getLabelsApi() Get the Label client.
LogLevel	getLogLevel()
NotificationEndpointsApi	getNotificationEndpointsApi() Get the NotificationEndpoint client.
NotificationRulesApi	getNotificationRulesApi() Get the NotificationRules client.
OrganizationsApi	getOrganizationsApi() Get the Organization client.
QueryApi	getQueryApi() Get the Query client.
ScraperTargetsApi	getScraperTargetsApi() Get the ScraperTargetResponse client.
<S> S	getService(Class<S> service) Create an implementation of the API endpoints defined by the service interface.
SourcesApi	getSourcesApi() Get the Source client.
TasksApi	getTasksApi() Get the Task client.
TelegrafsApi	getTelegrafsApi() Get the Telegraf client.
TemplatesApi	getTemplatesApi() Get the Document client.
UsersApi	getUsersApi() Get the User client.
VariablesApi	getVariablesApi() Get the Variable client.
WriteApi	getWriteApi() Get the asynchronous non-blocking Write client.
WriteApi	getWriteApi(WriteOptions writeOptions) Get the asynchronous non-blocking Write client.
WriteApiBlocking	getWriteApiBlocking() Get the 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.
OnboardingResponse	onBoarding(OnboardingRequest onboarding) Post onboarding request, to setup initial user, org and bucket.
Ready	ready() The readiness of the InfluxDB 2.0.
InfluxDBClient	setLogLevel(LogLevel logLevel) Set the log level for the request and response information.

Method Detail

getQueryApi

@Nonnull
QueryApi getQueryApi()

Get the Query client.

Returns:

the new client instance for the Query API

getWriteApi

@Nonnull
WriteApi getWriteApi()

Get the asynchronous non-blocking Write client.

Returns:

the new client instance for the Write API

getWriteApi

@Nonnull
WriteApi getWriteApi(@Nonnull
                              WriteOptions writeOptions)

Get the asynchronous non-blocking Write client.

Parameters:

writeOptions - the writes configuration

Returns:

the new client instance for the Write API

getWriteApiBlocking

@Nonnull
WriteApiBlocking getWriteApiBlocking()

Get the synchronous blocking Write client.

Returns:

the new client instance for the Write API

getAuthorizationsApi

@Nonnull
AuthorizationsApi getAuthorizationsApi()

Get the Authorization client.

Returns:

the new client instance for Authorization API

getBucketsApi

@Nonnull
BucketsApi getBucketsApi()

Get the Bucket client.

Returns:

the new client instance for Bucket API

getOrganizationsApi

@Nonnull
OrganizationsApi getOrganizationsApi()

Get the Organization client.

Returns:

the new client instance for Organization API

getSourcesApi

@Nonnull
SourcesApi getSourcesApi()

Get the Source client.

Returns:

the new client instance for Source API

getTasksApi

@Nonnull
TasksApi getTasksApi()

Get the Task client.

Returns:

the new client instance for Task API

getUsersApi

@Nonnull
UsersApi getUsersApi()

Get the User client.

Returns:

the new client instance for User API

getScraperTargetsApi

@Nonnull
ScraperTargetsApi getScraperTargetsApi()

Get the ScraperTargetResponse client.

Returns:

the new client instance for Scraper API

getTelegrafsApi

@Nonnull
TelegrafsApi getTelegrafsApi()

Get the Telegraf client.

Returns:

the new client instance for Telegrafs API

getLabelsApi

@Nonnull
LabelsApi getLabelsApi()

Get the Label client.

Returns:

the new client instance for Label API

getTemplatesApi

@Nonnull
TemplatesApi getTemplatesApi()

Get the Document client.

Returns:

the new client instance for Template API

getVariablesApi

@Nonnull
VariablesApi getVariablesApi()

Get the Variable client.

Returns:

the new client instance for Variable API

getDashboardsApi

@Nonnull
DashboardsApi getDashboardsApi()

Get the Dashboard client.

Returns:

the new client instance for Dashboard API

getChecksApi

@Nonnull
ChecksApi getChecksApi()

Get the Check client.

Returns:

the new client instance for Checks API

getNotificationEndpointsApi

@Nonnull
NotificationEndpointsApi getNotificationEndpointsApi()

Get the NotificationEndpoint client.

Returns:

the new client instance for NotificationEndpoint API

getNotificationRulesApi

@Nonnull
NotificationRulesApi getNotificationRulesApi()

Get the NotificationRules client.

Returns:

the new client instance for NotificationRules API

getDeleteApi

@Nonnull
DeleteApi getDeleteApi()

Get the Delete client.

Returns:

the new client instance for the Delete API

getService

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

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

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

Type Parameters:

S - type of service

Parameters:

service - service to instantiate

Returns:

instance of service

health

@Nonnull
HealthCheck health()

Get the health of an instance.

Returns:

health of an instance

ready

@Nullable
Ready ready()

The readiness of the InfluxDB 2.0.

Returns:

return null if the InfluxDB is not ready

onBoarding

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

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

Parameters:

onboarding - to setup defaults

Returns:

defaults for first run

Throws:

UnprocessableEntityException - when an onboarding has already been completed

isOnboardingAllowed

@Nonnull
Boolean isOnboardingAllowed()

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

Returns:

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

getLogLevel

@Nonnull
LogLevel getLogLevel()

Returns:

the LogLevel that is used for logging requests and responses

setLogLevel

@Nonnull
InfluxDBClient setLogLevel(@Nonnull
                                    LogLevel logLevel)

Set the log level for the request and response information.

Parameters:

logLevel - the log level to set.

Returns:

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

enableGzip

@Nonnull
InfluxDBClient enableGzip()

Enable Gzip compress for http requests.

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

Returns:

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

disableGzip

@Nonnull
InfluxDBClient disableGzip()

Disable Gzip compress for http request body.

Returns:

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

isGzipEnabled

boolean isGzipEnabled()

Returns whether Gzip compress for http request body is enabled.

Returns:

true if gzip is enabled.

close

void close()

Shutdown and close the client.

Specified by:

close in interface AutoCloseable