com.influxdb.client

Class InfluxDBClientOptions.Builder

java.lang.Object

com.influxdb.client.InfluxDBClientOptions.Builder

Enclosing class:

InfluxDBClientOptions

@NotThreadSafe
public static class InfluxDBClientOptions.Builder
extends Object

A builder for InfluxDBClientOptions.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
InfluxDBClientOptions.Builder	addDefaultTag(String key, String expression) Add default tag that will be use for writes by Point and POJO.
InfluxDBClientOptions.Builder	authenticate(String username, char[] password) Setup authorization by InfluxDBClientOptions.AuthScheme.SESSION.
InfluxDBClientOptions.Builder	authenticateToken(char[] token) Setup authorization by InfluxDBClientOptions.AuthScheme.TOKEN.
InfluxDBClientOptions.Builder	bucket(String bucket) Specify the default destination bucket for writes.
InfluxDBClientOptions	build() Build an instance of InfluxDBClientOptions.
InfluxDBClientOptions.Builder	connectionString(String connectionString) Configure Builder via connection string.
InfluxDBClientOptions.Builder	loadProperties() Configure Builder via influx2.properties.
InfluxDBClientOptions.Builder	logLevel(LogLevel logLevel) Set the log level for the request and response information.
InfluxDBClientOptions.Builder	okHttpClient(okhttp3.OkHttpClient.Builder okHttpClient) Set the HTTP client to use for communication with InfluxDB.
InfluxDBClientOptions.Builder	org(String org) Specify the default destination organization for writes and queries.
InfluxDBClientOptions.Builder	url(String url) Set the url to connect to InfluxDB.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

url

@Nonnull
public InfluxDBClientOptions.Builder url(@Nonnull
                                                  String url)

Set the url to connect to InfluxDB.

Parameters:

url - the url to connect to InfluxDB. It must be defined.

Returns:

this

okHttpClient

@Nonnull
public InfluxDBClientOptions.Builder okHttpClient(@Nonnull
                                                           okhttp3.OkHttpClient.Builder okHttpClient)

Set the HTTP client to use for communication with InfluxDB.

Parameters:

okHttpClient - the HTTP client to use.

Returns:

this

logLevel

@Nonnull
public InfluxDBClientOptions.Builder logLevel(@Nonnull
                                                       LogLevel logLevel)

Set the log level for the request and response information.

Parameters:

logLevel - The log level for the request and response information.

Returns:

this

authenticate

@Nonnull
public InfluxDBClientOptions.Builder authenticate(@Nonnull
                                                           String username,
                                                           @Nonnull
                                                           char[] password)

Setup authorization by InfluxDBClientOptions.AuthScheme.SESSION.

The username/password auth is based on HTTP "Basic" authentication. The authorization expires when the time-to-live (TTL) (default 60 minutes) is reached and client produces UnauthorizedException.

Parameters:

username - the username to use in the basic auth

password - the password to use in the basic auth

Returns:

this

authenticateToken

@Nonnull
public InfluxDBClientOptions.Builder authenticateToken(char[] token)

Setup authorization by InfluxDBClientOptions.AuthScheme.TOKEN.

Parameters:

token - the token to use for the authorization

Returns:

this

org

@Nonnull
public InfluxDBClientOptions.Builder org(@Nullable
                                                  String org)

Specify the default destination organization for writes and queries.

Parameters:

org - the default destination organization for writes and queries

Returns:

this

bucket

@Nonnull
public InfluxDBClientOptions.Builder bucket(@Nullable
                                                     String bucket)

Specify the default destination bucket for writes.

Parameters:

bucket - default destination bucket for writes

Returns:

this

addDefaultTag

@Nonnull
public InfluxDBClientOptions.Builder addDefaultTag(@Nonnull
                                                            String key,
                                                            @Nullable
                                                            String expression)

Add default tag that will be use for writes by Point and POJO.

The expressions can be:

• "California Miner" - static value
• "${version}" - system property
• "${env.hostname}" - environment property

Parameters:

key - the tag name

expression - the tag value expression

Returns:

this

connectionString

@Nonnull
public InfluxDBClientOptions.Builder connectionString(@Nonnull
                                                               String connectionString)

Configure Builder via connection string.

Returns:

this

loadProperties

@Nonnull
public InfluxDBClientOptions.Builder loadProperties()

Configure Builder via influx2.properties.

Returns:

this

build

@Nonnull
public InfluxDBClientOptions build()

Build an instance of InfluxDBClientOptions.

Returns:

InfluxDBClientOptions