Package com.influxdb.v3.client.write

Class WriteOptions.Builder

java.lang.Object
com.influxdb.v3.client.write.WriteOptions.Builder
Enclosing class:
WriteOptions
public static final class WriteOptions.Builder extends Object
A builder for WriteOptions.

Mutable.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • database

      @Nonnull public WriteOptions.Builder database(@Nonnull String database)
      Sets the database.
      Parameters:
      database - database
      Returns:
      this

    • precision

      @Nonnull public WriteOptions.Builder precision(@Nonnull WritePrecision precision)
      Sets the precision.
      Parameters:
      precision - precision
      Returns:
      this

    • gzipThreshold

      @Nonnull public WriteOptions.Builder gzipThreshold(@Nonnull Integer gzipThreshold)
      Sets the GZIp threshold.
      Parameters:
      gzipThreshold - body size threshold for compression using GZIP
      Returns:
      this

    • noSync

      @Nonnull public WriteOptions.Builder noSync(@Nonnull Boolean noSync)
      Sets whether to skip waiting for WAL persistence on write.
      Parameters:
      noSync - skip waiting for WAL persistence on write.
      Returns:
      this

    • acceptPartial

      @Nonnull public WriteOptions.Builder acceptPartial(@Nonnull Boolean acceptPartial)
      Sets whether to request partial write acceptance.
      Parameters:
      acceptPartial - request partial write acceptance
      Returns:
      this

    • useV2Api

      @Nonnull public WriteOptions.Builder useV2Api(@Nonnull Boolean useV2Api)
      Sets whether to use V2 API endpoint.
      Parameters:
      useV2Api - use V2 API endpoint
      Returns:
      this

    • defaultTags

      @Nonnull public WriteOptions.Builder defaultTags(@Nonnull Map<String,String> defaultTags)
      Sets defaultTags.
      Parameters:
      defaultTags - to be used when writing points
      Returns:
      this

    • tagOrder

      @Nonnull public WriteOptions.Builder tagOrder(@Nonnull List<String> tagOrder)
      Sets preferred tag order for line protocol serialization.
      Parameters:
      tagOrder - tag order preference. Null or empty tag names are ignored.
      Returns:
      this

    • headers

      @Nonnull public WriteOptions.Builder headers(@Nonnull Map<String,String> headers)
      Sets the headers.
      Parameters:
      headers - headers
      Returns:
      this

    • build

      @Nonnull public WriteOptions build()
      Build an instance of ClientConfig.
      Returns:
      the configuration for an InfluxDBClient.