Package com.influxdb.v3.client.write

Class WriteOptions

java.lang.Object

com.influxdb.v3.client.write.WriteOptions

@ThreadSafe
public final class WriteOptions
extends Object

Write options.

Supports to specify:

• database - specifies the database to be used for InfluxDB operations
• organization - specifies the organization to be used for InfluxDB operations
• precision - specified the precision to use for the timestamp of points

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WriteOptions.Builder	A builder for WriteOptions.

Field Summary

Fields

Modifier and Type	Field	Description
static Integer	DEFAULT_GZIP_THRESHOLD	Default GZIP threshold.
static WritePrecision	DEFAULT_WRITE_PRECISION	Default WritePrecision.
static WriteOptions	DEFAULTS	Default WriteOptions.

Constructor Summary

Constructors

Constructor	Description
WriteOptions(String database, WritePrecision precision, Integer gzipThreshold)	Construct WriteAPI options.

Method Summary

Modifier and Type	Method	Description
String	databaseSafe(ClientConfig config)
boolean	equals(Object o)
Integer	gzipThresholdSafe(ClientConfig config)
int	hashCode()
WritePrecision	precisionSafe(ClientConfig config)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_WRITE_PRECISION

public static final WritePrecision DEFAULT_WRITE_PRECISION

Default WritePrecision.

DEFAULT_GZIP_THRESHOLD

public static final Integer DEFAULT_GZIP_THRESHOLD

Default GZIP threshold.

DEFAULTS

public static final WriteOptions DEFAULTS

Default WriteOptions.

Constructor Detail

WriteOptions

public WriteOptions(@Nonnull
                    String database,
                    @Nonnull
                    WritePrecision precision,
                    @Nonnull
                    Integer gzipThreshold)

Construct WriteAPI options.

Parameters:

database - The database to be used for InfluxDB operations.

precision - The precision to use for the timestamp of points.

gzipThreshold - The threshold for compressing request body.

Method Detail

databaseSafe

@Nullable
public String databaseSafe(@Nonnull
                           ClientConfig config)

Parameters:

config - with default value

Returns:

The destination database for writes.

precisionSafe

@Nonnull
public WritePrecision precisionSafe(@Nonnull
                                    ClientConfig config)

Parameters:

config - with default value

Returns:

Precision for unix timestamps in the line protocol of the request payload.

gzipThresholdSafe

@Nonnull
public Integer gzipThresholdSafe(@Nonnull
                                 ClientConfig config)

Parameters:

config - with default value

Returns:

Payload size threshold for compressing it.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object