Interface InfluxDBv2Parameters.Builder

All Superinterfaces:
Buildable, CopyableBuilder<InfluxDBv2Parameters.Builder,InfluxDBv2Parameters>, SdkBuilder<InfluxDBv2Parameters.Builder,InfluxDBv2Parameters>, SdkPojo
Enclosing class:
InfluxDBv2Parameters
@Mutable @NotThreadSafe public static interface InfluxDBv2Parameters.Builder extends SdkPojo, CopyableBuilder<InfluxDBv2Parameters.Builder,InfluxDBv2Parameters>

  • Method Details

    • fluxLogEnabled

      InfluxDBv2Parameters.Builder fluxLogEnabled(Boolean fluxLogEnabled)

      Include option to show detailed logs for Flux queries.

      Default: false

      Parameters:
      fluxLogEnabled - Include option to show detailed logs for Flux queries.

      Default: false

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logLevel

      InfluxDBv2Parameters.Builder logLevel(String logLevel)

      Log output level. InfluxDB outputs log entries with severity levels greater than or equal to the level specified.

      Default: info

      Parameters:
      logLevel - Log output level. InfluxDB outputs log entries with severity levels greater than or equal to the level specified.

      Default: info

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • logLevel

      InfluxDBv2Parameters.Builder logLevel(LogLevel logLevel)

      Log output level. InfluxDB outputs log entries with severity levels greater than or equal to the level specified.

      Default: info

      Parameters:
      logLevel - Log output level. InfluxDB outputs log entries with severity levels greater than or equal to the level specified.

      Default: info

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • noTasks

      InfluxDBv2Parameters.Builder noTasks(Boolean noTasks)

      Disable the task scheduler. If problematic tasks prevent InfluxDB from starting, use this option to start InfluxDB without scheduling or executing tasks.

      Default: false

      Parameters:
      noTasks - Disable the task scheduler. If problematic tasks prevent InfluxDB from starting, use this option to start InfluxDB without scheduling or executing tasks.

      Default: false

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryConcurrency

      InfluxDBv2Parameters.Builder queryConcurrency(Integer queryConcurrency)

      Number of queries allowed to execute concurrently. Setting to 0 allows an unlimited number of concurrent queries.

      Default: 0

      Parameters:
      queryConcurrency - Number of queries allowed to execute concurrently. Setting to 0 allows an unlimited number of concurrent queries.

      Default: 0

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryQueueSize

      InfluxDBv2Parameters.Builder queryQueueSize(Integer queryQueueSize)

      Maximum number of queries allowed in execution queue. When queue limit is reached, new queries are rejected. Setting to 0 allows an unlimited number of queries in the queue.

      Default: 0

      Parameters:
      queryQueueSize - Maximum number of queries allowed in execution queue. When queue limit is reached, new queries are rejected. Setting to 0 allows an unlimited number of queries in the queue.

      Default: 0

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tracingType

      InfluxDBv2Parameters.Builder tracingType(String tracingType)

      Enable tracing in InfluxDB and specifies the tracing type. Tracing is disabled by default.

      Parameters:
      tracingType - Enable tracing in InfluxDB and specifies the tracing type. Tracing is disabled by default.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tracingType

      InfluxDBv2Parameters.Builder tracingType(TracingType tracingType)

      Enable tracing in InfluxDB and specifies the tracing type. Tracing is disabled by default.

      Parameters:
      tracingType - Enable tracing in InfluxDB and specifies the tracing type. Tracing is disabled by default.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • metricsDisabled

      InfluxDBv2Parameters.Builder metricsDisabled(Boolean metricsDisabled)

      Disable the HTTP /metrics endpoint which exposes internal InfluxDB metrics.

      Default: false

      Parameters:
      metricsDisabled - Disable the HTTP /metrics endpoint which exposes internal InfluxDB metrics.

      Default: false

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • httpIdleTimeout

      InfluxDBv2Parameters.Builder httpIdleTimeout(Duration httpIdleTimeout)

      Maximum duration the server should keep established connections alive while waiting for new requests. Set to 0 for no timeout.

      Default: 3 minutes

      Parameters:
      httpIdleTimeout - Maximum duration the server should keep established connections alive while waiting for new requests. Set to 0 for no timeout.

      Default: 3 minutes

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • httpIdleTimeout

      default InfluxDBv2Parameters.Builder httpIdleTimeout(Consumer<Duration.Builder> httpIdleTimeout)

      Maximum duration the server should keep established connections alive while waiting for new requests. Set to 0 for no timeout.

      Default: 3 minutes

      This is a convenience method that creates an instance of the Duration.Builder avoiding the need to create one manually via Duration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to httpIdleTimeout(Duration).

      Parameters:
      httpIdleTimeout - a consumer that will call methods on Duration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • httpReadHeaderTimeout

      InfluxDBv2Parameters.Builder httpReadHeaderTimeout(Duration httpReadHeaderTimeout)

      Maximum duration the server should try to read HTTP headers for new requests. Set to 0 for no timeout.

      Default: 10 seconds

      Parameters:
      httpReadHeaderTimeout - Maximum duration the server should try to read HTTP headers for new requests. Set to 0 for no timeout.

      Default: 10 seconds

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • httpReadHeaderTimeout

      default InfluxDBv2Parameters.Builder httpReadHeaderTimeout(Consumer<Duration.Builder> httpReadHeaderTimeout)

      Maximum duration the server should try to read HTTP headers for new requests. Set to 0 for no timeout.

      Default: 10 seconds

      This is a convenience method that creates an instance of the Duration.Builder avoiding the need to create one manually via Duration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to httpReadHeaderTimeout(Duration).

      Parameters:
      httpReadHeaderTimeout - a consumer that will call methods on Duration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • httpReadTimeout

      InfluxDBv2Parameters.Builder httpReadTimeout(Duration httpReadTimeout)

      Maximum duration the server should try to read the entirety of new requests. Set to 0 for no timeout.

      Default: 0

      Parameters:
      httpReadTimeout - Maximum duration the server should try to read the entirety of new requests. Set to 0 for no timeout.

      Default: 0

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • httpReadTimeout

      default InfluxDBv2Parameters.Builder httpReadTimeout(Consumer<Duration.Builder> httpReadTimeout)

      Maximum duration the server should try to read the entirety of new requests. Set to 0 for no timeout.

      Default: 0

      This is a convenience method that creates an instance of the Duration.Builder avoiding the need to create one manually via Duration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to httpReadTimeout(Duration).

      Parameters:
      httpReadTimeout - a consumer that will call methods on Duration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • httpWriteTimeout

      InfluxDBv2Parameters.Builder httpWriteTimeout(Duration httpWriteTimeout)

      Maximum duration the server should spend processing and responding to write requests. Set to 0 for no timeout.

      Default: 0

      Parameters:
      httpWriteTimeout - Maximum duration the server should spend processing and responding to write requests. Set to 0 for no timeout.

      Default: 0

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • httpWriteTimeout

      default InfluxDBv2Parameters.Builder httpWriteTimeout(Consumer<Duration.Builder> httpWriteTimeout)

      Maximum duration the server should spend processing and responding to write requests. Set to 0 for no timeout.

      Default: 0

      This is a convenience method that creates an instance of the Duration.Builder avoiding the need to create one manually via Duration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to httpWriteTimeout(Duration).

      Parameters:
      httpWriteTimeout - a consumer that will call methods on Duration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • influxqlMaxSelectBuckets

      InfluxDBv2Parameters.Builder influxqlMaxSelectBuckets(Long influxqlMaxSelectBuckets)

      Maximum number of group by time buckets a SELECT statement can create. 0 allows an unlimited number of buckets.

      Default: 0

      Parameters:
      influxqlMaxSelectBuckets - Maximum number of group by time buckets a SELECT statement can create. 0 allows an unlimited number of buckets.

      Default: 0

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • influxqlMaxSelectPoint

      InfluxDBv2Parameters.Builder influxqlMaxSelectPoint(Long influxqlMaxSelectPoint)

      Maximum number of points a SELECT statement can process. 0 allows an unlimited number of points. InfluxDB checks the point count every second (so queries exceeding the maximum aren’t immediately aborted).

      Default: 0

      Parameters:
      influxqlMaxSelectPoint - Maximum number of points a SELECT statement can process. 0 allows an unlimited number of points. InfluxDB checks the point count every second (so queries exceeding the maximum aren’t immediately aborted).

      Default: 0

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • influxqlMaxSelectSeries

      InfluxDBv2Parameters.Builder influxqlMaxSelectSeries(Long influxqlMaxSelectSeries)

      Maximum number of series a SELECT statement can return. 0 allows an unlimited number of series.

      Default: 0

      Parameters:
      influxqlMaxSelectSeries - Maximum number of series a SELECT statement can return. 0 allows an unlimited number of series.

      Default: 0

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pprofDisabled

      InfluxDBv2Parameters.Builder pprofDisabled(Boolean pprofDisabled)

      Disable the /debug/pprof HTTP endpoint. This endpoint provides runtime profiling data and can be helpful when debugging.

      Default: true

      Parameters:
      pprofDisabled - Disable the /debug/pprof HTTP endpoint. This endpoint provides runtime profiling data and can be helpful when debugging.

      Default: true

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryInitialMemoryBytes

      InfluxDBv2Parameters.Builder queryInitialMemoryBytes(Long queryInitialMemoryBytes)

      Initial bytes of memory allocated for a query.

      Default: 0

      Parameters:
      queryInitialMemoryBytes - Initial bytes of memory allocated for a query.

      Default: 0

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryMaxMemoryBytes

      InfluxDBv2Parameters.Builder queryMaxMemoryBytes(Long queryMaxMemoryBytes)

      Maximum number of queries allowed in execution queue. When queue limit is reached, new queries are rejected. Setting to 0 allows an unlimited number of queries in the queue.

      Default: 0

      Parameters:
      queryMaxMemoryBytes - Maximum number of queries allowed in execution queue. When queue limit is reached, new queries are rejected. Setting to 0 allows an unlimited number of queries in the queue.

      Default: 0

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryMemoryBytes

      InfluxDBv2Parameters.Builder queryMemoryBytes(Long queryMemoryBytes)

      Maximum bytes of memory allowed for a single query. Must be greater or equal to queryInitialMemoryBytes.

      Default: 0

      Parameters:
      queryMemoryBytes - Maximum bytes of memory allowed for a single query. Must be greater or equal to queryInitialMemoryBytes.

      Default: 0

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sessionLength

      InfluxDBv2Parameters.Builder sessionLength(Integer sessionLength)

      Specifies the Time to Live (TTL) in minutes for newly created user sessions.

      Default: 60

      Parameters:
      sessionLength - Specifies the Time to Live (TTL) in minutes for newly created user sessions.

      Default: 60

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sessionRenewDisabled

      InfluxDBv2Parameters.Builder sessionRenewDisabled(Boolean sessionRenewDisabled)

      Disables automatically extending a user’s session TTL on each request. By default, every request sets the session’s expiration time to five minutes from now. When disabled, sessions expire after the specified session length and the user is redirected to the login page, even if recently active.

      Default: false

      Parameters:
      sessionRenewDisabled - Disables automatically extending a user’s session TTL on each request. By default, every request sets the session’s expiration time to five minutes from now. When disabled, sessions expire after the specified session length and the user is redirected to the login page, even if recently active.

      Default: false

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • storageCacheMaxMemorySize

      InfluxDBv2Parameters.Builder storageCacheMaxMemorySize(Long storageCacheMaxMemorySize)

      Maximum size (in bytes) a shard’s cache can reach before it starts rejecting writes. Must be greater than storageCacheSnapShotMemorySize and lower than instance’s total memory capacity. We recommend setting it to below 15% of the total memory capacity.

      Default: 1073741824

      Parameters:
      storageCacheMaxMemorySize - Maximum size (in bytes) a shard’s cache can reach before it starts rejecting writes. Must be greater than storageCacheSnapShotMemorySize and lower than instance’s total memory capacity. We recommend setting it to below 15% of the total memory capacity.

      Default: 1073741824

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • storageCacheSnapshotMemorySize

      InfluxDBv2Parameters.Builder storageCacheSnapshotMemorySize(Long storageCacheSnapshotMemorySize)

      Size (in bytes) at which the storage engine will snapshot the cache and write it to a TSM file to make more memory available. Must not be greater than storageCacheMaxMemorySize.

      Default: 26214400

      Parameters:
      storageCacheSnapshotMemorySize - Size (in bytes) at which the storage engine will snapshot the cache and write it to a TSM file to make more memory available. Must not be greater than storageCacheMaxMemorySize.

      Default: 26214400

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • storageCacheSnapshotWriteColdDuration

      InfluxDBv2Parameters.Builder storageCacheSnapshotWriteColdDuration(Duration storageCacheSnapshotWriteColdDuration)

      Duration at which the storage engine will snapshot the cache and write it to a new TSM file if the shard hasn’t received writes or deletes.

      Default: 10 minutes

      Parameters:
      storageCacheSnapshotWriteColdDuration - Duration at which the storage engine will snapshot the cache and write it to a new TSM file if the shard hasn’t received writes or deletes.

      Default: 10 minutes

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • storageCacheSnapshotWriteColdDuration

      default InfluxDBv2Parameters.Builder storageCacheSnapshotWriteColdDuration(Consumer<Duration.Builder> storageCacheSnapshotWriteColdDuration)

      Duration at which the storage engine will snapshot the cache and write it to a new TSM file if the shard hasn’t received writes or deletes.

      Default: 10 minutes

      This is a convenience method that creates an instance of the Duration.Builder avoiding the need to create one manually via Duration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to storageCacheSnapshotWriteColdDuration(Duration).

      Parameters:
      storageCacheSnapshotWriteColdDuration - a consumer that will call methods on Duration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • storageCompactFullWriteColdDuration

      InfluxDBv2Parameters.Builder storageCompactFullWriteColdDuration(Duration storageCompactFullWriteColdDuration)

      Duration at which the storage engine will compact all TSM files in a shard if it hasn't received writes or deletes.

      Default: 4 hours

      Parameters:
      storageCompactFullWriteColdDuration - Duration at which the storage engine will compact all TSM files in a shard if it hasn't received writes or deletes.

      Default: 4 hours

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • storageCompactFullWriteColdDuration

      default InfluxDBv2Parameters.Builder storageCompactFullWriteColdDuration(Consumer<Duration.Builder> storageCompactFullWriteColdDuration)

      Duration at which the storage engine will compact all TSM files in a shard if it hasn't received writes or deletes.

      Default: 4 hours

      This is a convenience method that creates an instance of the Duration.Builder avoiding the need to create one manually via Duration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to storageCompactFullWriteColdDuration(Duration).

      Parameters:
      storageCompactFullWriteColdDuration - a consumer that will call methods on Duration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • storageCompactThroughputBurst

      InfluxDBv2Parameters.Builder storageCompactThroughputBurst(Long storageCompactThroughputBurst)

      Rate limit (in bytes per second) that TSM compactions can write to disk.

      Default: 50331648

      Parameters:
      storageCompactThroughputBurst - Rate limit (in bytes per second) that TSM compactions can write to disk.

      Default: 50331648

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • storageMaxConcurrentCompactions

      InfluxDBv2Parameters.Builder storageMaxConcurrentCompactions(Integer storageMaxConcurrentCompactions)

      Maximum number of full and level compactions that can run concurrently. A value of 0 results in 50% of runtime.GOMAXPROCS(0) used at runtime. Any number greater than zero limits compactions to that value. This setting does not apply to cache snapshotting.

      Default: 0

      Parameters:
      storageMaxConcurrentCompactions - Maximum number of full and level compactions that can run concurrently. A value of 0 results in 50% of runtime.GOMAXPROCS(0) used at runtime. Any number greater than zero limits compactions to that value. This setting does not apply to cache snapshotting.

      Default: 0

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • storageMaxIndexLogFileSize

      InfluxDBv2Parameters.Builder storageMaxIndexLogFileSize(Long storageMaxIndexLogFileSize)

      Size (in bytes) at which an index write-ahead log (WAL) file will compact into an index file. Lower sizes will cause log files to be compacted more quickly and result in lower heap usage at the expense of write throughput.

      Default: 1048576

      Parameters:
      storageMaxIndexLogFileSize - Size (in bytes) at which an index write-ahead log (WAL) file will compact into an index file. Lower sizes will cause log files to be compacted more quickly and result in lower heap usage at the expense of write throughput.

      Default: 1048576

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • storageNoValidateFieldSize

      InfluxDBv2Parameters.Builder storageNoValidateFieldSize(Boolean storageNoValidateFieldSize)

      Skip field size validation on incoming write requests.

      Default: false

      Parameters:
      storageNoValidateFieldSize - Skip field size validation on incoming write requests.

      Default: false

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • storageRetentionCheckInterval

      InfluxDBv2Parameters.Builder storageRetentionCheckInterval(Duration storageRetentionCheckInterval)

      Interval of retention policy enforcement checks. Must be greater than 0.

      Default: 30 minutes

      Parameters:
      storageRetentionCheckInterval - Interval of retention policy enforcement checks. Must be greater than 0.

      Default: 30 minutes

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • storageRetentionCheckInterval

      default InfluxDBv2Parameters.Builder storageRetentionCheckInterval(Consumer<Duration.Builder> storageRetentionCheckInterval)

      Interval of retention policy enforcement checks. Must be greater than 0.

      Default: 30 minutes

      This is a convenience method that creates an instance of the Duration.Builder avoiding the need to create one manually via Duration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to storageRetentionCheckInterval(Duration).

      Parameters:
      storageRetentionCheckInterval - a consumer that will call methods on Duration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • storageSeriesFileMaxConcurrentSnapshotCompactions

      InfluxDBv2Parameters.Builder storageSeriesFileMaxConcurrentSnapshotCompactions(Integer storageSeriesFileMaxConcurrentSnapshotCompactions)

      Maximum number of snapshot compactions that can run concurrently across all series partitions in a database.

      Default: 0

      Parameters:
      storageSeriesFileMaxConcurrentSnapshotCompactions - Maximum number of snapshot compactions that can run concurrently across all series partitions in a database.

      Default: 0

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • storageSeriesIdSetCacheSize

      InfluxDBv2Parameters.Builder storageSeriesIdSetCacheSize(Long storageSeriesIdSetCacheSize)

      Size of the internal cache used in the TSI index to store previously calculated series results. Cached results are returned quickly rather than needing to be recalculated when a subsequent query with the same tag key/value predicate is executed. Setting this value to 0 will disable the cache and may decrease query performance.

      Default: 100

      Parameters:
      storageSeriesIdSetCacheSize - Size of the internal cache used in the TSI index to store previously calculated series results. Cached results are returned quickly rather than needing to be recalculated when a subsequent query with the same tag key/value predicate is executed. Setting this value to 0 will disable the cache and may decrease query performance.

      Default: 100

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • storageWalMaxConcurrentWrites

      InfluxDBv2Parameters.Builder storageWalMaxConcurrentWrites(Integer storageWalMaxConcurrentWrites)

      Maximum number writes to the WAL directory to attempt at the same time. Setting this value to 0 results in number of processing units available x2.

      Default: 0

      Parameters:
      storageWalMaxConcurrentWrites - Maximum number writes to the WAL directory to attempt at the same time. Setting this value to 0 results in number of processing units available x2.

      Default: 0

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • storageWalMaxWriteDelay

      InfluxDBv2Parameters.Builder storageWalMaxWriteDelay(Duration storageWalMaxWriteDelay)

      Maximum amount of time a write request to the WAL directory will wait when the maximum number of concurrent active writes to the WAL directory has been met. Set to 0 to disable the timeout.

      Default: 10 minutes

      Parameters:
      storageWalMaxWriteDelay - Maximum amount of time a write request to the WAL directory will wait when the maximum number of concurrent active writes to the WAL directory has been met. Set to 0 to disable the timeout.

      Default: 10 minutes

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • storageWalMaxWriteDelay

      default InfluxDBv2Parameters.Builder storageWalMaxWriteDelay(Consumer<Duration.Builder> storageWalMaxWriteDelay)

      Maximum amount of time a write request to the WAL directory will wait when the maximum number of concurrent active writes to the WAL directory has been met. Set to 0 to disable the timeout.

      Default: 10 minutes

      This is a convenience method that creates an instance of the Duration.Builder avoiding the need to create one manually via Duration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to storageWalMaxWriteDelay(Duration).

      Parameters:
      storageWalMaxWriteDelay - a consumer that will call methods on Duration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • uiDisabled

      InfluxDBv2Parameters.Builder uiDisabled(Boolean uiDisabled)

      Disable the InfluxDB user interface (UI). The UI is enabled by default.

      Default: false

      Parameters:
      uiDisabled - Disable the InfluxDB user interface (UI). The UI is enabled by default.

      Default: false

      Returns:
      Returns a reference to this object so that method calls can be chained together.