Package com.influxdb.client

Class InfluxDBClientOptions

java.lang.Object

com.influxdb.client.InfluxDBClientOptions

public final class InfluxDBClientOptions
extends Object

InfluxDBClientOptions are used to configure theInfluxDB 2.x connections.

Author:

Jakub Bednar (bednar@github) (05/09/2018 10:22)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	InfluxDBClientOptions.AuthScheme	The scheme uses to Authentication.
static class	InfluxDBClientOptions.Builder	A builder for InfluxDBClientOptions.

Method Summary

Modifier and Type	Method	Description
static InfluxDBClientOptions.Builder	builder()	Creates a builder instance.
InfluxDBClientOptions.AuthScheme	getAuthScheme()
String	getBucket()
String	getClientType()	If the clientType is not specified the `java`, `kotlin` or `scala` is used depends on the type of client.
WriteConsistency	getConsistency()	The write consistency for the point.
LogLevel	getLogLevel()
okhttp3.OkHttpClient.Builder	getOkHttpClient()
String	getOrg()
char[]	getPassword()
PointSettings	getPointSettings()	Default tags that will be use for writes by Point and POJO.
WritePrecision	getPrecision()
char[]	getToken()
String	getUrl()
String	getUsername()

Methods inherited from class java.lang.Object

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

Method Details

getUrl

@Nonnull
public String getUrl()

Returns:

the url to connect to InfluxDB

See Also:

• InfluxDBClientOptions.Builder.url(String)

getClientType

@Nullable
public String getClientType()

If the clientType is not specified the `java`, `kotlin` or `scala` is used depends on the type of client.

Returns:

the client type to report as a part of User-Agent to remote server

See Also:

• InfluxDBClientOptions.Builder.clientType(String)

getOkHttpClient

@Nonnull
public okhttp3.OkHttpClient.Builder getOkHttpClient()

Returns:

HTTP client to use for communication with InfluxDB

See Also:

• InfluxDBClientOptions.Builder.okHttpClient(OkHttpClient.Builder)

getLogLevel

@Nonnull
public LogLevel getLogLevel()

Returns:

The log level for the request and response information.

See Also:

• InfluxDBClientOptions.Builder.logLevel(LogLevel)

getAuthScheme

@Nullable
public InfluxDBClientOptions.AuthScheme getAuthScheme()

Returns:

the authorization scheme

See Also:

• InfluxDBClientOptions.Builder.authenticateToken(char[])
• (char[])

getToken

@Nullable
public char[] getToken()

Returns:

the token to use for the authorization

See Also:

• InfluxDBClientOptions.Builder.authenticateToken(char[])

getUsername

@Nullable
public String getUsername()

Returns:

the username to use in the basic auth

See Also:

• InfluxDBClientOptions.Builder.authenticate(String, char[])

getPassword

@Nullable
public char[] getPassword()

Returns:

the password to use in the basic auth

See Also:

• InfluxDBClientOptions.Builder.authenticate(String, char[])

getOrg

@Nullable
public String getOrg()

Returns:

the default destination organization for writes and queries

See Also:

• InfluxDBClientOptions.Builder.org(String)

getBucket

@Nullable
public String getBucket()

Returns:

default destination bucket for writes

See Also:

• InfluxDBClientOptions.Builder.bucket(String)

getPrecision

@Nonnull
public WritePrecision getPrecision()

Returns:

default precision for unix timestamps in the line protocol

See Also:

• InfluxDBClientOptions.Builder.precision(WritePrecision)

getConsistency

@Nullable
public WriteConsistency getConsistency()

The write consistency for the point.

InfluxDB assumes that the write consistency is WriteConsistency.ONE if you do not specify consistency. See the InfluxDB Enterprise documentation for detailed descriptions of each consistency option. Available with InfluxDB Enterprise clusters only!

Returns:

the write consistency for the point.

See Also:

• InfluxDBClientOptions.Builder.consistency(WriteConsistency)

getPointSettings

@Nonnull
public PointSettings getPointSettings()

Default tags that will be use for writes by Point and POJO.

Returns:

default tags

See Also:

• InfluxDBClientOptions.Builder.addDefaultTag(String, String)

builder

@Nonnull
public static InfluxDBClientOptions.Builder builder()

Creates a builder instance.

Returns:

a builder