Class InfluxDBv3EnterpriseParameters

java.lang.Object
software.amazon.awssdk.services.timestreaminfluxdb.model.InfluxDBv3EnterpriseParameters
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<InfluxDBv3EnterpriseParameters.Builder,InfluxDBv3EnterpriseParameters>
@Generated("software.amazon.awssdk:codegen") public final class InfluxDBv3EnterpriseParameters extends Object implements SdkPojo, Serializable, ToCopyableBuilder<InfluxDBv3EnterpriseParameters.Builder,InfluxDBv3EnterpriseParameters>

All the customer-modifiable InfluxDB v3 Enterprise parameters in Timestream for InfluxDB.

See Also:

  • Method Details

    • queryFileLimit

      public final Integer queryFileLimit()

      Limits the number of Parquet files a query can access. If a query attempts to read more than this limit, InfluxDB 3 returns an error.

      Default: 432

      Returns:
      Limits the number of Parquet files a query can access. If a query attempts to read more than this limit, InfluxDB 3 returns an error.

      Default: 432

    • queryLogSize

      public final Integer queryLogSize()

      Defines the size of the query log. Up to this many queries remain in the log before older queries are evicted to make room for new ones.

      Default: 1000

      Returns:
      Defines the size of the query log. Up to this many queries remain in the log before older queries are evicted to make room for new ones.

      Default: 1000

    • logFilter

      public final String logFilter()

      Sets the filter directive for logs.

      Returns:
      Sets the filter directive for logs.

    • logFormat

      public final LogFormats logFormat()

      Defines the message format for logs.

      Default: full

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

      Returns:
      Defines the message format for logs.

      Default: full

      See Also:

    • logFormatAsString

      public final String logFormatAsString()

      Defines the message format for logs.

      Default: full

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

      Returns:
      Defines the message format for logs.

      Default: full

      See Also:

    • dataFusionNumThreads

      public final Integer dataFusionNumThreads()

      Sets the maximum number of DataFusion runtime threads to use.

      Returns:
      Sets the maximum number of DataFusion runtime threads to use.

    • dataFusionRuntimeType

      public final DataFusionRuntimeType dataFusionRuntimeType()

      Specifies the DataFusion tokio runtime type.

      Default: multi-thread

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

      Returns:
      Specifies the DataFusion tokio runtime type.

      Default: multi-thread

      See Also:

    • dataFusionRuntimeTypeAsString

      public final String dataFusionRuntimeTypeAsString()

      Specifies the DataFusion tokio runtime type.

      Default: multi-thread

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

      Returns:
      Specifies the DataFusion tokio runtime type.

      Default: multi-thread

      See Also:

    • dataFusionRuntimeDisableLifoSlot

      public final Boolean dataFusionRuntimeDisableLifoSlot()

      Disables the LIFO slot of the DataFusion runtime.

      Returns:
      Disables the LIFO slot of the DataFusion runtime.

    • dataFusionRuntimeEventInterval

      public final Integer dataFusionRuntimeEventInterval()

      Sets the number of scheduler ticks after which the scheduler of the DataFusion tokio runtime polls for external events–for example: timers, I/O.

      Returns:
      Sets the number of scheduler ticks after which the scheduler of the DataFusion tokio runtime polls for external events–for example: timers, I/O.

    • dataFusionRuntimeGlobalQueueInterval

      public final Integer dataFusionRuntimeGlobalQueueInterval()

      Sets the number of scheduler ticks after which the scheduler of the DataFusion runtime polls the global task queue.

      Returns:
      Sets the number of scheduler ticks after which the scheduler of the DataFusion runtime polls the global task queue.

    • dataFusionRuntimeMaxBlockingThreads

      public final Integer dataFusionRuntimeMaxBlockingThreads()

      Specifies the limit for additional threads spawned by the DataFusion runtime.

      Returns:
      Specifies the limit for additional threads spawned by the DataFusion runtime.

    • dataFusionRuntimeMaxIoEventsPerTick

      public final Integer dataFusionRuntimeMaxIoEventsPerTick()

      Configures the maximum number of events processed per tick by the tokio DataFusion runtime.

      Returns:
      Configures the maximum number of events processed per tick by the tokio DataFusion runtime.

    • dataFusionRuntimeThreadKeepAlive

      public final Duration dataFusionRuntimeThreadKeepAlive()

      Sets a custom timeout for a thread in the blocking pool of the tokio DataFusion runtime.

      Returns:
      Sets a custom timeout for a thread in the blocking pool of the tokio DataFusion runtime.

    • dataFusionRuntimeThreadPriority

      public final Integer dataFusionRuntimeThreadPriority()

      Sets the thread priority for tokio DataFusion runtime workers.

      Default: 10

      Returns:
      Sets the thread priority for tokio DataFusion runtime workers.

      Default: 10

    • dataFusionMaxParquetFanout

      public final Integer dataFusionMaxParquetFanout()

      When multiple parquet files are required in a sorted way (deduplication for example), specifies the maximum fanout.

      Default: 1000

      Returns:
      When multiple parquet files are required in a sorted way (deduplication for example), specifies the maximum fanout.

      Default: 1000

    • dataFusionUseCachedParquetLoader

      public final Boolean dataFusionUseCachedParquetLoader()

      Uses a cached parquet loader when reading parquet files from the object store.

      Returns:
      Uses a cached parquet loader when reading parquet files from the object store.

    • dataFusionConfig

      public final String dataFusionConfig()

      Provides custom configuration to DataFusion as a comma-separated list of key:value pairs.

      Returns:
      Provides custom configuration to DataFusion as a comma-separated list of key:value pairs.

    • maxHttpRequestSize

      public final Long maxHttpRequestSize()

      Specifies the maximum size of HTTP requests.

      Default: 10485760

      Returns:
      Specifies the maximum size of HTTP requests.

      Default: 10485760

    • forceSnapshotMemThreshold

      public final PercentOrAbsoluteLong forceSnapshotMemThreshold()

      Specifies the threshold for the internal memory buffer. Supports either a percentage (portion of available memory) or absolute value in MB–for example: 70% or 100

      Default: 70%

      Returns:
      Specifies the threshold for the internal memory buffer. Supports either a percentage (portion of available memory) or absolute value in MB–for example: 70% or 100

      Default: 70%

    • walSnapshotSize

      public final Integer walSnapshotSize()

      Defines the number of WAL files to attempt to remove in a snapshot. This, multiplied by the interval, determines how often snapshots are taken.

      Default: 600

      Returns:
      Defines the number of WAL files to attempt to remove in a snapshot. This, multiplied by the interval, determines how often snapshots are taken.

      Default: 600

    • walMaxWriteBufferSize

      public final Integer walMaxWriteBufferSize()

      Specifies the maximum number of write requests that can be buffered before a flush must be executed and succeed.

      Default: 100000

      Returns:
      Specifies the maximum number of write requests that can be buffered before a flush must be executed and succeed.

      Default: 100000

    • snapshottedWalFilesToKeep

      public final Integer snapshottedWalFilesToKeep()

      Specifies the number of snapshotted WAL files to retain in the object store. Flushing the WAL files does not clear the WAL files immediately; they are deleted when the number of snapshotted WAL files exceeds this number.

      Default: 300

      Returns:
      Specifies the number of snapshotted WAL files to retain in the object store. Flushing the WAL files does not clear the WAL files immediately; they are deleted when the number of snapshotted WAL files exceeds this number.

      Default: 300

    • preemptiveCacheAge

      public final Duration preemptiveCacheAge()

      Specifies the interval to prefetch into the Parquet cache during compaction.

      Default: 3d

      Returns:
      Specifies the interval to prefetch into the Parquet cache during compaction.

      Default: 3d

    • parquetMemCachePrunePercentage

      public final Float parquetMemCachePrunePercentage()

      Specifies the percentage of entries to prune during a prune operation on the in-memory Parquet cache.

      Default: 0.1

      Returns:
      Specifies the percentage of entries to prune during a prune operation on the in-memory Parquet cache.

      Default: 0.1

    • parquetMemCachePruneInterval

      public final Duration parquetMemCachePruneInterval()

      Sets the interval to check if the in-memory Parquet cache needs to be pruned.

      Default: 1s

      Returns:
      Sets the interval to check if the in-memory Parquet cache needs to be pruned.

      Default: 1s

    • disableParquetMemCache

      public final Boolean disableParquetMemCache()

      Disables the in-memory Parquet cache. By default, the cache is enabled.

      Returns:
      Disables the in-memory Parquet cache. By default, the cache is enabled.

    • parquetMemCacheQueryPathDuration

      public final Duration parquetMemCacheQueryPathDuration()

      Specifies the time window for caching recent Parquet files in memory.

      Default: 5h

      Returns:
      Specifies the time window for caching recent Parquet files in memory.

      Default: 5h

    • lastCacheEvictionInterval

      public final Duration lastCacheEvictionInterval()

      Specifies the interval to evict expired entries from the Last-N-Value cache, expressed as a human-readable duration–for example: 20s, 1m, 1h.

      Default: 10s

      Returns:
      Specifies the interval to evict expired entries from the Last-N-Value cache, expressed as a human-readable duration–for example: 20s, 1m, 1h.

      Default: 10s

    • distinctCacheEvictionInterval

      public final Duration distinctCacheEvictionInterval()

      Specifies the interval to evict expired entries from the distinct value cache, expressed as a human-readable duration–for example: 20s, 1m, 1h.

      Default: 10s

      Returns:
      Specifies the interval to evict expired entries from the distinct value cache, expressed as a human-readable duration–for example: 20s, 1m, 1h.

      Default: 10s

    • gen1Duration

      public final Duration gen1Duration()

      Specifies the duration that Parquet files are arranged into. Data timestamps land each row into a file of this duration. Supported durations are 1m, 5m, and 10m. These files are known as “generation 1” files, which the compactor can merge into larger generations.

      Default: 10m

      Returns:
      Specifies the duration that Parquet files are arranged into. Data timestamps land each row into a file of this duration. Supported durations are 1m, 5m, and 10m. These files are known as “generation 1” files, which the compactor can merge into larger generations.

      Default: 10m

    • execMemPoolBytes

      public final PercentOrAbsoluteLong execMemPoolBytes()

      Specifies the size of memory pool used during query execution. Can be given as absolute value in bytes or as a percentage of the total available memory–for example: 8000000000 or 10%.

      Default: 20%

      Returns:
      Specifies the size of memory pool used during query execution. Can be given as absolute value in bytes or as a percentage of the total available memory–for example: 8000000000 or 10%.

      Default: 20%

    • parquetMemCacheSize

      public final PercentOrAbsoluteLong parquetMemCacheSize()

      Specifies the size of the in-memory Parquet cache in megabytes or percentage of total available memory.

      Default: 20%

      Returns:
      Specifies the size of the in-memory Parquet cache in megabytes or percentage of total available memory.

      Default: 20%

    • walReplayFailOnError

      public final Boolean walReplayFailOnError()

      Determines whether WAL replay should fail when encountering errors.

      Default: false

      Returns:
      Determines whether WAL replay should fail when encountering errors.

      Default: false

    • walReplayConcurrencyLimit

      public final Integer walReplayConcurrencyLimit()

      Concurrency limit during WAL replay. Setting this number too high can lead to OOM. The default is dynamically determined.

      Default: max(num_cpus, 10)

      Returns:
      Concurrency limit during WAL replay. Setting this number too high can lead to OOM. The default is dynamically determined.

      Default: max(num_cpus, 10)

    • tableIndexCacheMaxEntries

      public final Integer tableIndexCacheMaxEntries()

      Specifies the maximum number of entries in the table index cache.

      Default: 1000

      Returns:
      Specifies the maximum number of entries in the table index cache.

      Default: 1000

    • tableIndexCacheConcurrencyLimit

      public final Integer tableIndexCacheConcurrencyLimit()

      Limits the concurrency level for table index cache operations.

      Default: 8

      Returns:
      Limits the concurrency level for table index cache operations.

      Default: 8

    • gen1LookbackDuration

      public final Duration gen1LookbackDuration()

      Specifies how far back to look when creating generation 1 Parquet files.

      Default: 24h

      Returns:
      Specifies how far back to look when creating generation 1 Parquet files.

      Default: 24h

    • retentionCheckInterval

      public final Duration retentionCheckInterval()

      The interval at which retention policies are checked and enforced. Enter as a human-readable time–for example: 30m or 1h.

      Default: 30m

      Returns:
      The interval at which retention policies are checked and enforced. Enter as a human-readable time–for example: 30m or 1h.

      Default: 30m

    • deleteGracePeriod

      public final Duration deleteGracePeriod()

      Specifies the grace period before permanently deleting data.

      Default: 24h

      Returns:
      Specifies the grace period before permanently deleting data.

      Default: 24h

    • hardDeleteDefaultDuration

      public final Duration hardDeleteDefaultDuration()

      Sets the default duration for hard deletion of data.

      Default: 90d

      Returns:
      Sets the default duration for hard deletion of data.

      Default: 90d

    • ingestQueryInstances

      public final Integer ingestQueryInstances()

      Specifies number of instances in the DbCluster which can both ingest and query.

      Returns:
      Specifies number of instances in the DbCluster which can both ingest and query.

    • queryOnlyInstances

      public final Integer queryOnlyInstances()

      Specifies number of instances in the DbCluster which can only query.

      Returns:
      Specifies number of instances in the DbCluster which can only query.

    • dedicatedCompactor

      public final Boolean dedicatedCompactor()

      Specifies if the compactor instance should be a standalone instance or not.

      Returns:
      Specifies if the compactor instance should be a standalone instance or not.

    • compactionRowLimit

      public final Integer compactionRowLimit()

      Specifies the soft limit for the number of rows per file that the compactor writes. The compactor may write more rows than this limit.

      Default: 1000000

      Returns:
      Specifies the soft limit for the number of rows per file that the compactor writes. The compactor may write more rows than this limit.

      Default: 1000000

    • compactionMaxNumFilesPerPlan

      public final Integer compactionMaxNumFilesPerPlan()

      Sets the maximum number of files included in any compaction plan.

      Default: 500

      Returns:
      Sets the maximum number of files included in any compaction plan.

      Default: 500

    • compactionGen2Duration

      public final Duration compactionGen2Duration()

      Specifies the duration of the first level of compaction (gen2). Later levels of compaction are multiples of this duration. This value should be equal to or greater than the gen1 duration.

      Default: 20m

      Returns:
      Specifies the duration of the first level of compaction (gen2). Later levels of compaction are multiples of this duration. This value should be equal to or greater than the gen1 duration.

      Default: 20m

    • compactionMultipliers

      public final String compactionMultipliers()

      Specifies a comma-separated list of multiples defining the duration of each level of compaction. The number of elements in the list determines the number of compaction levels. The first element specifies the duration of the first level (gen3); subsequent levels are multiples of the previous level.

      Default: 3,4,6,5

      Returns:
      Specifies a comma-separated list of multiples defining the duration of each level of compaction. The number of elements in the list determines the number of compaction levels. The first element specifies the duration of the first level (gen3); subsequent levels are multiples of the previous level.

      Default: 3,4,6,5

    • compactionCleanupWait

      public final Duration compactionCleanupWait()

      Specifies the amount of time that the compactor waits after finishing a compaction run to delete files marked as needing deletion during that compaction run.

      Default: 10m

      Returns:
      Specifies the amount of time that the compactor waits after finishing a compaction run to delete files marked as needing deletion during that compaction run.

      Default: 10m

    • compactionCheckInterval

      public final Duration compactionCheckInterval()

      Specifies how often the compactor checks for new compaction work to perform.

      Default: 10s

      Returns:
      Specifies how often the compactor checks for new compaction work to perform.

      Default: 10s

    • lastValueCacheDisableFromHistory

      public final Boolean lastValueCacheDisableFromHistory()

      Disables populating the last-N-value cache from historical data. If disabled, the cache is still populated with data from the write-ahead log (WAL).

      Returns:
      Disables populating the last-N-value cache from historical data. If disabled, the cache is still populated with data from the write-ahead log (WAL).

    • distinctValueCacheDisableFromHistory

      public final Boolean distinctValueCacheDisableFromHistory()

      Disables populating the distinct value cache from historical data. If disabled, the cache is still populated with data from the write-ahead log (WAL).

      Returns:
      Disables populating the distinct value cache from historical data. If disabled, the cache is still populated with data from the write-ahead log (WAL).

    • replicationInterval

      public final Duration replicationInterval()

      Specifies the interval at which data replication occurs between cluster nodes.

      Default: 250ms

      Returns:
      Specifies the interval at which data replication occurs between cluster nodes.

      Default: 250ms

    • catalogSyncInterval

      public final Duration catalogSyncInterval()

      Defines how often the catalog synchronizes across cluster nodes.

      Default: 10s

      Returns:
      Defines how often the catalog synchronizes across cluster nodes.

      Default: 10s

    • toBuilder

      public InfluxDBv3EnterpriseParameters.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<InfluxDBv3EnterpriseParameters.Builder,InfluxDBv3EnterpriseParameters>
      Returns:
      a builder for type T

    • builder

      public static InfluxDBv3EnterpriseParameters.Builder builder()

    • serializableBuilderClass

      public static Class<? extends InfluxDBv3EnterpriseParameters.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.