Package com.influxdb.v3.client.write

Class WriteParameters

java.lang.Object

com.influxdb.v3.client.write.WriteParameters

@ThreadSafe
public final class WriteParameters
extends Object

Write API parameters.

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

Field Summary

Fields

Modifier and Type	Field	Description
static final WritePrecision	DEFAULT_WRITE_PRECISION	Default WritePrecision.
static final WriteParameters	DEFAULTS	Default WriteParameters.

Constructor Summary

Constructors

Constructor	Description
WriteParameters(String database, String organization, WritePrecision precision)	Construct WriteAPI parameters.

Method Summary

Modifier and Type	Method	Description
WriteParameters	copy(WritePrecision precision, InfluxDBClientConfigs configs)	Copy current parameters with new precision.
String	databaseSafe(InfluxDBClientConfigs configs)
boolean	equals(Object o)
int	hashCode()
String	organizationSafe(InfluxDBClientConfigs configs)
WritePrecision	precisionSafe(InfluxDBClientConfigs configs)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_WRITE_PRECISION

public static final WritePrecision DEFAULT_WRITE_PRECISION

Default WritePrecision.

DEFAULTS

public static final WriteParameters DEFAULTS

Default WriteParameters.

Constructor Details

WriteParameters

public WriteParameters(@Nullable
 String database,
 @Nullable
 String organization,
 @Nullable
 WritePrecision precision)

Construct WriteAPI parameters.

Parameters:

database - The database to be used for InfluxDB operations. If it is not specified then use InfluxDBClientConfigs.getDatabase().

organization - The organization to be used for InfluxDB operations. If it is not specified then use InfluxDBClientConfigs.getOrganization().

precision - The precision to use for the timestamp of points. If it is not specified then use WritePrecision.NS.

Method Details

organizationSafe

@Nullable
public String organizationSafe(@Nonnull
 InfluxDBClientConfigs configs)

Parameters:

configs - with default value

Returns:

The destination organization for writes.

databaseSafe

@Nullable
public String databaseSafe(@Nonnull
 InfluxDBClientConfigs configs)

Parameters:

configs - with default value

Returns:

The destination database for writes.

precisionSafe

@Nonnull
public WritePrecision precisionSafe(@Nonnull
 InfluxDBClientConfigs configs)

Parameters:

configs - with default value

Returns:

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

copy

@Nonnull
public WriteParameters copy(@Nonnull
 WritePrecision precision,
 @Nonnull
 InfluxDBClientConfigs configs)

Copy current parameters with new precision.

Parameters:

precision - new precision

configs - default values

Returns:

copied parameters

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object