Class InfluxDBv2Parameters

java.lang.Object

software.amazon.awssdk.services.timestreaminfluxdb.model.InfluxDBv2Parameters

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<InfluxDBv2Parameters.Builder,InfluxDBv2Parameters>

@Generated("software.amazon.awssdk:codegen")
public final class InfluxDBv2Parameters
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<InfluxDBv2Parameters.Builder,InfluxDBv2Parameters>

All the customer-modifiable InfluxDB v2 parameters in Timestream for InfluxDB.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InfluxDBv2Parameters.Builder

Method Summary

Modifier and Type	Method	Description
static InfluxDBv2Parameters.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final Boolean	fluxLogEnabled()	Include option to show detailed logs for Flux queries.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final Duration	httpIdleTimeout()	Maximum duration the server should keep established connections alive while waiting for new requests.
final Duration	httpReadHeaderTimeout()	Maximum duration the server should try to read HTTP headers for new requests.
final Duration	httpReadTimeout()	Maximum duration the server should try to read the entirety of new requests.
final Duration	httpWriteTimeout()	Maximum duration the server should spend processing and responding to write requests.
final Long	influxqlMaxSelectBuckets()	Maximum number of group by time buckets a SELECT statement can create.
final Long	influxqlMaxSelectPoint()	Maximum number of points a SELECT statement can process.
final Long	influxqlMaxSelectSeries()	Maximum number of series a SELECT statement can return.
final LogLevel	logLevel()	Log output level.
final String	logLevelAsString()	Log output level.
final Boolean	metricsDisabled()	Disable the HTTP /metrics endpoint which exposes internal InfluxDB metrics.
final Boolean	noTasks()	Disable the task scheduler.
final Boolean	pprofDisabled()	Disable the /debug/pprof HTTP endpoint.
final Integer	queryConcurrency()	Number of queries allowed to execute concurrently.
final Long	queryInitialMemoryBytes()	Initial bytes of memory allocated for a query.
final Long	queryMaxMemoryBytes()	Maximum number of queries allowed in execution queue.
final Long	queryMemoryBytes()	Maximum bytes of memory allowed for a single query.
final Integer	queryQueueSize()	Maximum number of queries allowed in execution queue.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends InfluxDBv2Parameters.Builder>	serializableBuilderClass()
final Integer	sessionLength()	Specifies the Time to Live (TTL) in minutes for newly created user sessions.
final Boolean	sessionRenewDisabled()	Disables automatically extending a user’s session TTL on each request.
final Long	storageCacheMaxMemorySize()	Maximum size (in bytes) a shard’s cache can reach before it starts rejecting writes.
final 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.
final 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.
final Duration	storageCompactFullWriteColdDuration()	Duration at which the storage engine will compact all TSM files in a shard if it hasn't received writes or deletes.
final Long	storageCompactThroughputBurst()	Rate limit (in bytes per second) that TSM compactions can write to disk.
final Integer	storageMaxConcurrentCompactions()	Maximum number of full and level compactions that can run concurrently.
final Long	storageMaxIndexLogFileSize()	Size (in bytes) at which an index write-ahead log (WAL) file will compact into an index file.
final Boolean	storageNoValidateFieldSize()	Skip field size validation on incoming write requests.
final Duration	storageRetentionCheckInterval()	Interval of retention policy enforcement checks.
final Integer	storageSeriesFileMaxConcurrentSnapshotCompactions()	Maximum number of snapshot compactions that can run concurrently across all series partitions in a database.
final Long	storageSeriesIdSetCacheSize()	Size of the internal cache used in the TSI index to store previously calculated series results.
final Integer	storageWalMaxConcurrentWrites()	Maximum number writes to the WAL directory to attempt at the same time.
final 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.
InfluxDBv2Parameters.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.
final TracingType	tracingType()	Enable tracing in InfluxDB and specifies the tracing type.
final String	tracingTypeAsString()	Enable tracing in InfluxDB and specifies the tracing type.
final Boolean	uiDisabled()	Disable the InfluxDB user interface (UI).

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Details

fluxLogEnabled

public final Boolean fluxLogEnabled()

Include option to show detailed logs for Flux queries.

Default: false

Returns:

Include option to show detailed logs for Flux queries.

Default: false

logLevel

public final LogLevel logLevel()

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

Default: info

If the service returns an enum value that is not available in the current SDK version, logLevel will return LogLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from logLevelAsString().

Returns:

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

Default: info

See Also:

• LogLevel

logLevelAsString

public final String logLevelAsString()

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

Default: info

If the service returns an enum value that is not available in the current SDK version, logLevel will return LogLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from logLevelAsString().

Returns:

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

Default: info

See Also:

• LogLevel

noTasks

public final 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

Returns:

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

Default: false

queryConcurrency

public final Integer queryConcurrency()

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

Default: 0

Returns:

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

Default: 0

queryQueueSize

public final 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

Returns:

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

tracingType

public final TracingType tracingType()

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

If the service returns an enum value that is not available in the current SDK version, tracingType will return TracingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tracingTypeAsString().

Returns:

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

See Also:

• TracingType

tracingTypeAsString

public final String tracingTypeAsString()

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

If the service returns an enum value that is not available in the current SDK version, tracingType will return TracingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tracingTypeAsString().

Returns:

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

See Also:

• TracingType

metricsDisabled

public final Boolean metricsDisabled()

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

Default: false

Returns:

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

Default: false

httpIdleTimeout

public final 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

Returns:

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

Default: 3 minutes

httpReadHeaderTimeout

public final Duration httpReadHeaderTimeout()

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

Default: 10 seconds

Returns:

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

Default: 10 seconds

httpReadTimeout

public final Duration httpReadTimeout()

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

Default: 0

Returns:

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

Default: 0

httpWriteTimeout

public final Duration httpWriteTimeout()

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

Default: 0

Returns:

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

Default: 0

influxqlMaxSelectBuckets

public final Long influxqlMaxSelectBuckets()

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

Default: 0

Returns:

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

Default: 0

influxqlMaxSelectPoint

public final 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

Returns:

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

influxqlMaxSelectSeries

public final Long influxqlMaxSelectSeries()

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

Default: 0

Returns:

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

Default: 0

pprofDisabled

public final Boolean pprofDisabled()

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

Default: true

Returns:

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

Default: true

queryInitialMemoryBytes

public final Long queryInitialMemoryBytes()

Initial bytes of memory allocated for a query.

Default: 0

Returns:

Initial bytes of memory allocated for a query.

Default: 0

queryMaxMemoryBytes

public final 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

Returns:

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

queryMemoryBytes

public final Long queryMemoryBytes()

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

Default: 0

Returns:

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

Default: 0

sessionLength

public final Integer sessionLength()

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

Default: 60

Returns:

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

Default: 60

sessionRenewDisabled

public final 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

Returns:

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

storageCacheMaxMemorySize

public final 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

Returns:

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

storageCacheSnapshotMemorySize

public final 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

Returns:

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

storageCacheSnapshotWriteColdDuration

public final 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

Returns:

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

storageCompactFullWriteColdDuration

public final 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

Returns:

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

storageCompactThroughputBurst

public final Long storageCompactThroughputBurst()

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

Default: 50331648

Returns:

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

Default: 50331648

storageMaxConcurrentCompactions

public final 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

Returns:

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

storageMaxIndexLogFileSize

public final 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

Returns:

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

storageNoValidateFieldSize

public final Boolean storageNoValidateFieldSize()

Skip field size validation on incoming write requests.

Default: false

Returns:

Skip field size validation on incoming write requests.

Default: false

storageRetentionCheckInterval

public final Duration storageRetentionCheckInterval()

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

Default: 30 minutes

Returns:

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

Default: 30 minutes

storageSeriesFileMaxConcurrentSnapshotCompactions

public final Integer storageSeriesFileMaxConcurrentSnapshotCompactions()

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

Default: 0

Returns:

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

Default: 0

storageSeriesIdSetCacheSize

public final 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

Returns:

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

storageWalMaxConcurrentWrites

public final 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

Returns:

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

storageWalMaxWriteDelay

public final 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

Returns:

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

uiDisabled

public final Boolean uiDisabled()

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

Default: false

Returns:

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

Default: false

toBuilder

public InfluxDBv2Parameters.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<InfluxDBv2Parameters.Builder,InfluxDBv2Parameters>

Returns:

a builder for type T

builder

public static InfluxDBv2Parameters.Builder builder()

serializableBuilderClass

public static Class<? extends InfluxDBv2Parameters.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
 Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.