Package org.apache.cassandra.db.guardrails

Interface GuardrailsMBean

All Known Implementing Classes:
Guardrails
public interface GuardrailsMBean
JMX entrypoint for updating the default guardrails configuration parsed from cassandra.yaml.

This is different to just exposing GuardrailsConfig in that the methods here should be JMX-friendly.

For consistency, guardrails based on a simple numeric threshold should use the naming scheme <whatIsGuarded>WarnThreshold for soft limits and <whatIsGuarded>FailThreshold for hard ones, and if the value has a unit, that unit should be added at the end (for instance, <whatIsGuarded>FailThresholdInKb). For "boolean" guardrails that disable a feature, use <whatIsGuardedEnabled. Other type of guardrails can use appropriate suffixes but should start with <whatIsGuarded>.

  • Method Details

    • getKeyspacesWarnThreshold

      int getKeyspacesWarnThreshold()
      Returns:
      The threshold to warn when creating more user keyspaces than threshold. -1 means disabled.

    • getKeyspacesFailThreshold

      int getKeyspacesFailThreshold()
      Returns:
      The threshold to prevent creating more user keyspaces than threshold. -1 means disabled.

    • setKeyspacesThreshold

      void setKeyspacesThreshold(int warn, int fail)
      Parameters:
      warn - The threshold to warn when creating more user keyspaces than threshold. -1 means disabled.
      fail - The threshold to prevent creating more user keyspaces than threshold. -1 means disabled.

    • getTablesWarnThreshold

      int getTablesWarnThreshold()
      Returns:
      The threshold to warn when creating more tables than threshold. -1 means disabled.

    • getTablesFailThreshold

      int getTablesFailThreshold()
      Returns:
      The threshold to prevent creating more tables than threshold. -1 means disabled.

    • setTablesThreshold

      void setTablesThreshold(int warn, int fail)
      Parameters:
      warn - The threshold to warn when creating more tables than threshold. -1 means disabled.
      fail - The threshold to prevent creating more tables than threshold. -1 means disabled.

    • getColumnsPerTableWarnThreshold

      int getColumnsPerTableWarnThreshold()
      Returns:
      The threshold to warn when having more columns per table than threshold. -1 means disabled.

    • getColumnsPerTableFailThreshold

      int getColumnsPerTableFailThreshold()
      Returns:
      The threshold to prevent having more columns per table than threshold. -1 means disabled.

    • setColumnsPerTableThreshold

      void setColumnsPerTableThreshold(int warn, int fail)
      Parameters:
      warn - The threshold to warn when having more columns per table than threshold. -1 means disabled.
      fail - The threshold to prevent having more columns per table than threshold. -1 means disabled.

    • getSecondaryIndexesPerTableWarnThreshold

      int getSecondaryIndexesPerTableWarnThreshold()
      Returns:
      The threshold to warn when creating more secondary indexes per table than threshold. -1 means disabled.

    • getSecondaryIndexesPerTableFailThreshold

      int getSecondaryIndexesPerTableFailThreshold()
      Returns:
      The threshold to prevent creating more secondary indexes per table than threshold. -1 means disabled.

    • setSecondaryIndexesPerTableThreshold

      void setSecondaryIndexesPerTableThreshold(int warn, int fail)
      Parameters:
      warn - The threshold to warn when creating more secondary indexes per table than threshold. -1 means disabled.
      fail - The threshold to prevent creating more secondary indexes per table than threshold. -1 means disabled.

    • getSecondaryIndexesEnabled

      boolean getSecondaryIndexesEnabled()
      Returns:
      Whether secondary index creation is active or not on the node

    • setSecondaryIndexesEnabled

      void setSecondaryIndexesEnabled(boolean enabled)
      Enables or disables the ability to create secondary indexes
      Parameters:
      enabled -

    • getMaterializedViewsPerTableWarnThreshold

      int getMaterializedViewsPerTableWarnThreshold()
      Returns:
      The threshold to warn when creating more materialized views per table than threshold. -1 means disabled.

    • getMaterializedViewsPerTableFailThreshold

      int getMaterializedViewsPerTableFailThreshold()
      Returns:
      The threshold to prevent creating more materialized views per table than threshold. -1 means disabled.

    • setMaterializedViewsPerTableThreshold

      void setMaterializedViewsPerTableThreshold(int warn, int fail)
      Parameters:
      warn - The threshold to warn when creating more materialized views per table than threshold. -1 means disabled.
      fail - The threshold to prevent creating more materialized views per table than threshold. -1 means disabled.

    • getTablePropertiesWarned

      Set<String> getTablePropertiesWarned()
      Returns:
      properties that are warned about when creating or altering a table.

    • getTablePropertiesWarnedCSV

      String getTablePropertiesWarnedCSV()
      Returns:
      Comma-separated list of properties that are warned about when creating or altering a table.

    • setTablePropertiesWarned

      void setTablePropertiesWarned(Set<String> properties)
      Parameters:
      properties - properties that are warned about when creating or altering a table.

    • setTablePropertiesWarnedCSV

      void setTablePropertiesWarnedCSV(String properties)
      Parameters:
      properties - Comma-separated list of properties that are warned about when creating or altering a table.

    • getTablePropertiesDisallowed

      Set<String> getTablePropertiesDisallowed()
      Returns:
      properties that are not allowed when creating or altering a table.

    • getTablePropertiesDisallowedCSV

      String getTablePropertiesDisallowedCSV()
      Returns:
      Comma-separated list of properties that are not allowed when creating or altering a table.

    • setTablePropertiesDisallowed

      void setTablePropertiesDisallowed(Set<String> properties)
      Parameters:
      properties - properties that are not allowed when creating or altering a table.

    • setTablePropertiesDisallowedCSV

      void setTablePropertiesDisallowedCSV(String properties)
      Parameters:
      properties - Comma-separated list of properties that are not allowed when creating or altering a table.

    • getTablePropertiesIgnored

      Set<String> getTablePropertiesIgnored()
      Returns:
      properties that are ignored when creating or altering a table.

    • getTablePropertiesIgnoredCSV

      String getTablePropertiesIgnoredCSV()
      Returns:
      Comma-separated list of properties that are ignored when creating or altering a table.

    • setTablePropertiesIgnored

      void setTablePropertiesIgnored(Set<String> properties)
      Parameters:
      properties - properties that are ignored when creating or altering a table.

    • setTablePropertiesIgnoredCSV

      void setTablePropertiesIgnoredCSV(String properties)
      Parameters:
      properties - Comma-separated list of properties that are ignored when creating or altering a table.

    • getUserTimestampsEnabled

      boolean getUserTimestampsEnabled()
      Returns whether user-provided timestamps are allowed.
      Returns:
      true if user-provided timestamps are allowed, false otherwise.

    • setUserTimestampsEnabled

      void setUserTimestampsEnabled(boolean enabled)
      Sets whether user-provided timestamps are allowed.
      Parameters:
      enabled - true if user-provided timestamps are allowed, false otherwise.

    • getAllowFilteringEnabled

      boolean getAllowFilteringEnabled()
      Returns whether ALLOW FILTERING property is allowed.
      Returns:
      true if ALLOW FILTERING is allowed, false otherwise.

    • setAllowFilteringEnabled

      void setAllowFilteringEnabled(boolean enabled)
      Sets whether ALLOW FILTERING is allowed.
      Parameters:
      enabled - true if ALLOW FILTERING is allowed, false otherwise.

    • getSimpleStrategyEnabled

      boolean getSimpleStrategyEnabled()
      Returns whether SimpleStrategy is allowed on keyspace creation or alteration
      Returns:
      true if SimpleStrategy is allowed; false otherwise

    • setSimpleStrategyEnabled

      void setSimpleStrategyEnabled(boolean enabled)
      Sets whether SimpleStrategy is allowed on keyspace creation or alteration
      Parameters:
      enabled - true if SimpleStrategy is allowed, false otherwise.

    • getUncompressedTablesEnabled

      boolean getUncompressedTablesEnabled()
      Returns whether users can disable compression on tables
      Returns:
      true if users can disable compression on a table, false otherwise.

    • setUncompressedTablesEnabled

      void setUncompressedTablesEnabled(boolean enabled)
      Sets whether users can disable compression on tables
      Parameters:
      enabled - true if users can disable compression on a table, false otherwise.

    • getCompactTablesEnabled

      boolean getCompactTablesEnabled()
      Returns whether users can create new COMPACT STORAGE tables
      Returns:
      true if allowed, false otherwise.

    • setCompactTablesEnabled

      void setCompactTablesEnabled(boolean enabled)
      Sets whether users can create new COMPACT STORAGE tables
      Parameters:
      enabled - true if allowed, false otherwise.

    • getAlterTableEnabled

      boolean getAlterTableEnabled()
      Gets whether users can use the ALTER TABLE statement to change columns
      Returns:
      true if ALTER TABLE is allowed, false otherwise.

    • setAlterTableEnabled

      void setAlterTableEnabled(boolean enabled)
      Sets whether users can use the ALTER TABLE statement to change columns
      Parameters:
      enabled - true if changing columns is allowed, false otherwise.

    • getGroupByEnabled

      boolean getGroupByEnabled()
      Returns whether GROUP BY queries are allowed.
      Returns:
      true if allowed, false otherwise.

    • setGroupByEnabled

      void setGroupByEnabled(boolean enabled)
      Sets whether GROUP BY queries are allowed.
      Parameters:
      enabled - true if allowed, false otherwise.

    • getDropTruncateTableEnabled

      boolean getDropTruncateTableEnabled()
      Returns whether users can TRUNCATE or DROP TABLE
      Returns:
      true if allowed, false otherwise.

    • setDropTruncateTableEnabled

      void setDropTruncateTableEnabled(boolean enabled)
      Sets whether users can TRUNCATE or DROP TABLE

    • getDropKeyspaceEnabled

      boolean getDropKeyspaceEnabled()
      Returns whether users can DROP a keyspace
      Returns:
      true if allowed, false otherwise.

    • setDropKeyspaceEnabled

      void setDropKeyspaceEnabled(boolean enabled)
      Sets whether users can DROP a keyspace

    • getPageSizeWarnThreshold

      int getPageSizeWarnThreshold()
      Returns:
      The threshold to warn when requested page size greater than threshold. -1 means disabled.

    • getPageSizeFailThreshold

      int getPageSizeFailThreshold()
      Returns:
      The threshold to prevent requesting page with more elements than threshold. -1 means disabled.

    • setPageSizeThreshold

      void setPageSizeThreshold(int warn, int fail)
      Parameters:
      warn - The threshold to warn when the requested page size is greater than threshold. -1 means disabled.
      fail - The threshold to prevent requesting pages with more elements than threshold. -1 means disabled.

    • getReadBeforeWriteListOperationsEnabled

      boolean getReadBeforeWriteListOperationsEnabled()
      Returns whether list operations that require read before write are allowed.
      Returns:
      true if list operations that require read before write are allowed, false otherwise.

    • setReadBeforeWriteListOperationsEnabled

      void setReadBeforeWriteListOperationsEnabled(boolean enabled)
      Sets whether list operations that require read before write are allowed.
      Parameters:
      enabled - true if list operations that require read before write are allowed, false otherwise.

    • getPartitionKeysInSelectWarnThreshold

      int getPartitionKeysInSelectWarnThreshold()
      Returns:
      The threshold to warn when the number of partition keys in a select statement greater than threshold. -1 means disabled.

    • getPartitionKeysInSelectFailThreshold

      int getPartitionKeysInSelectFailThreshold()
      Returns:
      The threshold to fail when the number of partition keys in a select statement greater than threshold. -1 means disabled.

    • setPartitionKeysInSelectThreshold

      void setPartitionKeysInSelectThreshold(int warn, int fail)
      Parameters:
      warn - The threshold to warn when the number of partition keys in a select statement is greater than threshold -1 means disabled.
      fail - The threshold to prevent when the number of partition keys in a select statement is more than threshold -1 means disabled.

    • getInSelectCartesianProductWarnThreshold

      int getInSelectCartesianProductWarnThreshold()
      Returns:
      The threshold to warn when an IN query creates a cartesian product with a size exceeding threshold. -1 means disabled.

    • getInSelectCartesianProductFailThreshold

      int getInSelectCartesianProductFailThreshold()
      Returns:
      The threshold to prevent IN queries creating a cartesian product with a size exceeding threshold. -1 means disabled.

    • setInSelectCartesianProductThreshold

      void setInSelectCartesianProductThreshold(int warn, int fail)
      Parameters:
      warn - The threshold to warn when an IN query creates a cartesian product with a size exceeding threshold. -1 means disabled.
      fail - The threshold to prevent IN queries creating a cartesian product with a size exceeding threshold. -1 means disabled.

    • getReadConsistencyLevelsWarned

      Set<String> getReadConsistencyLevelsWarned()
      Returns:
      consistency levels that are warned about when reading.

    • getReadConsistencyLevelsWarnedCSV

      String getReadConsistencyLevelsWarnedCSV()
      Returns:
      Comma-separated list of consistency levels that are warned about when reading.

    • setReadConsistencyLevelsWarned

      void setReadConsistencyLevelsWarned(Set<String> consistencyLevels)
      Parameters:
      consistencyLevels - consistency levels that are warned about when reading.

    • setReadConsistencyLevelsWarnedCSV

      void setReadConsistencyLevelsWarnedCSV(String consistencyLevels)
      Parameters:
      consistencyLevels - Comma-separated list of consistency levels that are warned about when reading.

    • getReadConsistencyLevelsDisallowed

      Set<String> getReadConsistencyLevelsDisallowed()
      Returns:
      consistency levels that are not allowed when reading.

    • getReadConsistencyLevelsDisallowedCSV

      String getReadConsistencyLevelsDisallowedCSV()
      Returns:
      Comma-separated list of consistency levels that are not allowed when reading.

    • setReadConsistencyLevelsDisallowed

      void setReadConsistencyLevelsDisallowed(Set<String> consistencyLevels)
      Parameters:
      consistencyLevels - consistency levels that are not allowed when reading.

    • setReadConsistencyLevelsDisallowedCSV

      void setReadConsistencyLevelsDisallowedCSV(String consistencyLevels)
      Parameters:
      consistencyLevels - Comma-separated list of consistency levels that are not allowed when reading.

    • getWriteConsistencyLevelsWarned

      Set<String> getWriteConsistencyLevelsWarned()
      Returns:
      consistency levels that are warned about when writing.

    • getWriteConsistencyLevelsWarnedCSV

      String getWriteConsistencyLevelsWarnedCSV()
      Returns:
      Comma-separated list of consistency levels that are warned about when writing.

    • setWriteConsistencyLevelsWarned

      void setWriteConsistencyLevelsWarned(Set<String> consistencyLevels)
      Parameters:
      consistencyLevels - consistency levels that are warned about when writing.

    • setWriteConsistencyLevelsWarnedCSV

      void setWriteConsistencyLevelsWarnedCSV(String consistencyLevels)
      Parameters:
      consistencyLevels - Comma-separated list of consistency levels that are warned about when writing.

    • getWriteConsistencyLevelsDisallowed

      Set<String> getWriteConsistencyLevelsDisallowed()
      Returns:
      consistency levels that are not allowed when writing.

    • getWriteConsistencyLevelsDisallowedCSV

      String getWriteConsistencyLevelsDisallowedCSV()
      Returns:
      Comma-separated list of consistency levels that are not allowed when writing.

    • setWriteConsistencyLevelsDisallowed

      void setWriteConsistencyLevelsDisallowed(Set<String> consistencyLevels)
      Parameters:
      consistencyLevels - consistency levels that are not allowed when writing.

    • setWriteConsistencyLevelsDisallowedCSV

      void setWriteConsistencyLevelsDisallowedCSV(String consistencyLevels)
      Parameters:
      consistencyLevels - Comma-separated list of consistency levels that are not allowed when writing.

    • getPartitionSizeWarnThreshold

      @Nullable String getPartitionSizeWarnThreshold()
      Returns:
      The threshold to warn when encountering partitions larger than threshold, as a string formatted as in, for example, 10GiB, 20MiB, 30KiB or 40B. A null value means disabled.

    • getPartitionSizeFailThreshold

      @Nullable String getPartitionSizeFailThreshold()
      Returns:
      The threshold to fail when encountering partitions larger than threshold, as a string formatted as in, for example, 10GiB, 20MiB, 30KiB or 40B. A null value means disabled. Triggering a failure emits a log message and a diagnostic event, but it doesn't throw an exception interrupting the offending sstable write.

    • setPartitionSizeThreshold

      void setPartitionSizeThreshold(@Nullable String warnSize, @Nullable String failSize)
      Parameters:
      warnSize - The threshold to warn when encountering partitions larger than threshold, as a string formatted as in, for example, 10GiB, 20MiB, 30KiB or 40B. A null value means disabled.
      failSize - The threshold to fail when encountering partitions larger than threshold, as a string formatted as in, for example, 10GiB, 20MiB, 30KiB or 40B. A null value means disabled. Triggering a failure emits a log message and a diagnostic event, but it desn't throw an exception interrupting the offending sstable write.

    • getPartitionTombstonesWarnThreshold

      long getPartitionTombstonesWarnThreshold()
      Returns:
      The threshold to warn when encountering partitions with more tombstones than threshold. -1 means disabled.

    • getPartitionTombstonesFailThreshold

      long getPartitionTombstonesFailThreshold()
      Returns:
      The threshold to fail when encountering partitions with more tombstones than threshold. -1 means disabled. Triggering a failure emits a log message and a diagnostic event, but it doesn't throw an exception interrupting the offending sstable write.

    • setPartitionTombstonesThreshold

      void setPartitionTombstonesThreshold(long warn, long fail)
      Parameters:
      warn - The threshold to warn when encountering partitions with more tombstones than threshold. -1 means disabled.
      fail - The threshold to fail when encountering partitions with more tombstones than threshold. -1 means disabled. Triggering a failure emits a log message and a diagnostic event, but it desn't throw an exception interrupting the offending sstable write.

    • getColumnValueSizeWarnThreshold

      @Nullable String getColumnValueSizeWarnThreshold()
      Returns:
      The threshold to warn when encountering column values larger than threshold, as a string formatted as in, for example, 10GiB, 20MiB, 30KiB or 40B. A null value means disabled.

    • getColumnValueSizeFailThreshold

      @Nullable String getColumnValueSizeFailThreshold()
      Returns:
      The threshold to prevent column values larger than threshold, as a string formatted as in, for example, 10GiB, 20MiB, 30KiB or 40B. A null value means disabled.

    • setColumnValueSizeThreshold

      void setColumnValueSizeThreshold(@Nullable String warnSize, @Nullable String failSize)
      Parameters:
      warnSize - The threshold to warn when encountering column values larger than threshold, as a string formatted as in, for example, 10GiB, 20MiB, 30KiB or 40B. A null value means disabled.
      failSize - The threshold to prevent column values larger than threshold, as a string formatted as in, for example, 10GiB, 20MiB, 30KiB or 40B. A null value means disabled.

    • getCollectionSizeWarnThreshold

      @Nullable String getCollectionSizeWarnThreshold()
      Returns:
      The threshold to warn when encountering larger size of collection data than threshold, as a string formatted as in, for example, 10GiB, 20MiB, 30KiB or 40B. A null value means that the threshold is disabled.

    • getCollectionSizeFailThreshold

      @Nullable String getCollectionSizeFailThreshold()
      Returns:
      The threshold to prevent collections with larger data size than threshold, as a string formatted as in, for example, 10GiB, 20MiB, 30KiB or 40B. A null value means that the threshold is disabled.

    • setCollectionSizeThreshold

      void setCollectionSizeThreshold(@Nullable String warnSize, @Nullable String failSize)
      Parameters:
      warnSize - The threshold to warn when encountering larger size of collection data than threshold, as a string formatted as in, for example, 10GiB, 20MiB, 30KiB or 40B. A null value means disabled.
      failSize - The threshold to prevent collections with larger data size than threshold, as a string formatted as in, for example, 10GiB, 20MiB, 30KiB or 40B. A null value means disabled.

    • getItemsPerCollectionWarnThreshold

      int getItemsPerCollectionWarnThreshold()
      Returns:
      The threshold to warn when encountering more elements in a collection than threshold.

    • getItemsPerCollectionFailThreshold

      int getItemsPerCollectionFailThreshold()
      Returns:
      The threshold to prevent collections with more elements than threshold.

    • setItemsPerCollectionThreshold

      void setItemsPerCollectionThreshold(int warn, int fail)
      Parameters:
      warn - The threshold to warn when encountering more elements in a collection than threshold.
      fail - The threshold to prevent collectiosn with more elements than threshold.

    • getFieldsPerUDTWarnThreshold

      int getFieldsPerUDTWarnThreshold()
      Returns:
      The threshold to warn when creating a UDT with more fields than threshold. -1 means disabled.

    • getFieldsPerUDTFailThreshold

      int getFieldsPerUDTFailThreshold()
      Returns:
      The threshold to fail when creating a UDT with more fields than threshold. -1 means disabled.

    • setFieldsPerUDTThreshold

      void setFieldsPerUDTThreshold(int warn, int fail)
      Parameters:
      warn - The threshold to warn when creating a UDT with more fields than threshold. -1 means disabled.
      fail - The threshold to prevent creating a UDT with more fields than threshold. -1 means disabled.

    • getVectorDimensionsWarnThreshold

      int getVectorDimensionsWarnThreshold()
      Returns:
      The threshold to warn when creating a vector with more dimensions than threshold.

    • getVectorDimensionsFailThreshold

      int getVectorDimensionsFailThreshold()
      Returns:
      The threshold to fail when creating a vector with more dimensions than threshold.

    • setVectorDimensionsThreshold

      void setVectorDimensionsThreshold(int warn, int fail)
      Parameters:
      warn - The threshold to warn when creating a vector with more dimensions than threshold.
      fail - The threshold to prevent creating a vector with more dimensions than threshold.

    • setVectorTypeEnabled

      void setVectorTypeEnabled(boolean enabled)
      Parameters:
      enabled - true if vector type usage is enabled.

    • getVectorTypeEnabled

      boolean getVectorTypeEnabled()
      Returns:
      true if vector type usage is enabled.

    • getDataDiskUsagePercentageWarnThreshold

      int getDataDiskUsagePercentageWarnThreshold()
      Returns:
      The threshold to warn when local data disk usage percentage exceeds that threshold. Allowed values are in the range [1, 100], and -1 means disabled.

    • getDataDiskUsagePercentageFailThreshold

      int getDataDiskUsagePercentageFailThreshold()
      Returns:
      The threshold to fail when local data disk usage percentage exceeds that threshold. Allowed values are in the range [1, 100], and -1 means disabled.

    • setDataDiskUsagePercentageThreshold

      void setDataDiskUsagePercentageThreshold(int warn, int fail)
      Parameters:
      warn - The threshold to warn when local disk usage percentage exceeds that threshold. Allowed values are in the range [1, 100], and -1 means disabled.
      fail - The threshold to fail when local disk usage percentage exceeds that threshold. Allowed values are in the range [1, 100], and -1 means disabled.

    • getDataDiskUsageMaxDiskSize

      @Nullable String getDataDiskUsageMaxDiskSize()
      Returns:
      The max disk size of the data directories when calculating disk usage thresholds, as a string formatted as in, for example, 10GiB, 20MiB, 30KiB or 40B. A null value means disabled.

    • setDataDiskUsageMaxDiskSize

      void setDataDiskUsageMaxDiskSize(@Nullable String size)
      Parameters:
      size - The max disk size of the data directories when calculating disk usage thresholds, as a string formatted as in, for example, 10GiB, 20MiB, 30KiB or 40B. A null value means disabled.

    • getMinimumReplicationFactorWarnThreshold

      int getMinimumReplicationFactorWarnThreshold()
      Returns:
      The threshold to warn when replication factor is lesser than threshold.

    • getMinimumReplicationFactorFailThreshold

      int getMinimumReplicationFactorFailThreshold()
      Returns:
      The threshold to fail when replication factor is lesser than threshold.

    • setMinimumReplicationFactorThreshold

      void setMinimumReplicationFactorThreshold(int warn, int fail)
      Parameters:
      warn - The threshold to warn when the minimum replication factor is lesser than threshold. -1 means disabled.
      fail - The threshold to fail when the minimum replication factor is lesser than threshold. -1 means disabled.

    • getMaximumReplicationFactorWarnThreshold

      int getMaximumReplicationFactorWarnThreshold()
      Returns:
      The threshold to fail when replication factor is greater than threshold.

    • getMaximumReplicationFactorFailThreshold

      int getMaximumReplicationFactorFailThreshold()
      Returns:
      The threshold to fail when replication factor is greater than threshold.

    • setMaximumReplicationFactorThreshold

      void setMaximumReplicationFactorThreshold(int warn, int fail)
      Parameters:
      warn - The threshold to warn when the maximum replication factor is greater than threshold. -1 means disabled.
      fail - The threshold to fail when the maximum replication factor is greater than threshold. -1 means disabled.

    • getZeroTTLOnTWCSWarned

      boolean getZeroTTLOnTWCSWarned()
      Returns whether warnings will be emitted when usage of 0 default TTL on a table with TimeWindowCompactionStrategy is detected.
      Returns:
      true if warnings will be emitted, false otherwise.

    • setZeroTTLOnTWCSWarned

      void setZeroTTLOnTWCSWarned(boolean value)
      Sets whether warnings will be emitted when usage of 0 default TTL on a table with TimeWindowCompactionStrategy is detected.
      Parameters:
      value - true if warning will be emitted, false otherwise.

    • getZeroTTLOnTWCSEnabled

      boolean getZeroTTLOnTWCSEnabled()
      Returns whether it is allowed to create or alter table to use 0 default TTL with TimeWindowCompactionStrategy. If it is not, such query will fail.
      Returns:
      true if 0 default TTL is allowed on TWCS table, false otherwise.

    • setZeroTTLOnTWCSEnabled

      void setZeroTTLOnTWCSEnabled(boolean value)
      Sets whether users can use 0 default TTL on a table with TimeWindowCompactionStrategy.
      Parameters:
      value - true if 0 default TTL on TWCS tables is allowed, false otherwise.

    • getMaximumTimestampWarnThreshold

      @Nullable String getMaximumTimestampWarnThreshold()
      Returns:
      The highest acceptable difference between now and the written value timestamp before triggering a warning. Expressed as a string formatted as in, for example, 10s 20m, 30h or 40d. A null value means disabled.

    • getMaximumTimestampFailThreshold

      @Nullable String getMaximumTimestampFailThreshold()
      Returns:
      The highest acceptable difference between now and the written value timestamp before triggering a failure. Expressed as a string formatted as in, for example, 10s 20m, 30h or 40d. A null value means disabled.

    • setMaximumTimestampThreshold

      void setMaximumTimestampThreshold(@Nullable String warnDuration, @Nullable String failDuration)
      Sets the warning upper bound for user supplied timestamps.
      Parameters:
      warnDuration - The highest acceptable difference between now and the written value timestamp before triggering a warning. Expressed as a string formatted as in, for example, 10s, 20m, 30h or 40d. A null value means disabled.
      failDuration - The highest acceptable difference between now and the written value timestamp before triggering a failure. Expressed as a string formatted as in, for example, 10s, 20m, 30h or 40d. A null value means disabled.

    • getMinimumTimestampWarnThreshold

      @Nullable String getMinimumTimestampWarnThreshold()
      Returns:
      The lowest acceptable difference between now and the written value timestamp before triggering a warning. Expressed as a string formatted as in, for example, 10s 20m, 30h or 40d. A null value means disabled.

    • getMinimumTimestampFailThreshold

      @Nullable String getMinimumTimestampFailThreshold()
      Returns:
      The lowest acceptable difference between now and the written value timestamp before triggering a failure. Expressed as a string formatted as in, for example, 10s 20m, 30h or 40d. A null value means disabled.

    • setMinimumTimestampThreshold

      void setMinimumTimestampThreshold(@Nullable String warnDuration, @Nullable String failDuration)
      Sets the warning lower bound for user supplied timestamps.
      Parameters:
      warnDuration - The lowest acceptable difference between now and the written value timestamp before triggering a warning. Expressed as a string formatted as in, for example, 10s, 20m, 30h or 40d. A null value means disabled.
      failDuration - The lowest acceptable difference between now and the written value timestamp before triggering a failure. Expressed as a string formatted as in, for example, 10s, 20m, 30h or 40d. A null value means disabled.

    • getSaiSSTableIndexesPerQueryWarnThreshold

      int getSaiSSTableIndexesPerQueryWarnThreshold()
      Returns:
      the warning threshold for the number of SAI SSTable indexes searched by a query

    • getSaiSSTableIndexesPerQueryFailThreshold

      int getSaiSSTableIndexesPerQueryFailThreshold()
      Returns:
      the failure threshold for the number of SAI SSTable indexes searched by a query

    • setSaiSSTableIndexesPerQueryThreshold

      void setSaiSSTableIndexesPerQueryThreshold(int warn, int fail)
      Sets warning and failure thresholds for the number of SAI SSTable indexes searched by a query
      Parameters:
      warn - value to set for warn threshold
      fail - value to set for fail threshold

    • getSaiStringTermSizeWarnThreshold

      @Nullable String getSaiStringTermSizeWarnThreshold()
      Returns:
      The warning threshold for string terms written to an SAI index, as a human-readable string. (ex. 10GiB, 20MiB, 30KiB or 40B) A null value means disabled.

    • getSaiStringTermSizeFailThreshold

      @Nullable String getSaiStringTermSizeFailThreshold()
      Returns:
      The failure threshold for string terms written to an SAI index, as a human-readable string. (ex. 10GiB, 20MiB, 30KiB or 40B) A null value means disabled.

    • setSaiStringTermSizeThreshold

      void setSaiStringTermSizeThreshold(@Nullable String warnSize, @Nullable String failSize)
      Parameters:
      warnSize - The warning threshold for string terms written to an SAI index, as a human-readable string. (ex. 10GiB, 20MiB, 30KiB or 40B) A null value means disabled.
      failSize - The failure threshold for string terms written to an SAI index, as a human-readable string. (ex. 10GiB, 20MiB, 30KiB or 40B) A null value means disabled.

    • getSaiFrozenTermSizeWarnThreshold

      @Nullable String getSaiFrozenTermSizeWarnThreshold()
      Returns:
      The warning threshold for frozen terms written to an SAI index, as a human-readable string. (ex. 10GiB, 20MiB, 30KiB or 40B) A null value means disabled.

    • getSaiFrozenTermSizeFailThreshold

      @Nullable String getSaiFrozenTermSizeFailThreshold()
      Returns:
      The failure threshold for frozen terms written to an SAI index, as a human-readable string. (ex. 10GiB, 20MiB, 30KiB or 40B) A null value means disabled.

    • setSaiFrozenTermSizeThreshold

      void setSaiFrozenTermSizeThreshold(@Nullable String warnSize, @Nullable String failSize)
      Parameters:
      warnSize - The warning threshold for frozen terms written to an SAI index, as a human-readable string. (ex. 10GiB, 20MiB, 30KiB or 40B) A null value means disabled.
      failSize - The failure threshold for frozen terms written to an SAI index, as a human-readable string. (ex. 10GiB, 20MiB, 30KiB or 40B) A null value means disabled.

    • getSaiVectorTermSizeWarnThreshold

      @Nullable String getSaiVectorTermSizeWarnThreshold()
      Returns:
      The warning threshold for vector terms written to an SAI index, as a human-readable string. (ex. 10GiB, 20MiB, 30KiB or 40B) A null value means disabled.

    • getSaiVectorTermSizeFailThreshold

      @Nullable String getSaiVectorTermSizeFailThreshold()
      Returns:
      The failure threshold for vector terms written to an SAI index, as a human-readable string. (ex. 10GiB, 20MiB, 30KiB or 40B) A null value means disabled.

    • setSaiVectorTermSizeThreshold

      void setSaiVectorTermSizeThreshold(@Nullable String warnSize, @Nullable String failSize)
      Parameters:
      warnSize - The warning threshold for vector terms written to an SAI index, as a human-readable string. (ex. 10GiB, 20MiB, 30KiB or 40B) A null value means disabled.
      failSize - The failure threshold for vector terms written to an SAI index, as a human-readable string. (ex. 10GiB, 20MiB, 30KiB or 40B) A null value means disabled.

    • getNonPartitionRestrictedQueryEnabled

      boolean getNonPartitionRestrictedQueryEnabled()
      Returns whether it is possible to execute a query against secondary indexes without specifying any partition key restrictions.
      Returns:
      true if it is possible to execute a query without a partition key, false otherwise

    • setNonPartitionRestrictedQueryEnabled

      void setNonPartitionRestrictedQueryEnabled(boolean enabled)
      Sets whether it is possible to execute a query against indexes (secondary or SAI) without specifying any partition key restrictions.
      Parameters:
      enabled - true if a query without partition key is enabled or not

    • getIntersectFilteringQueryWarned

      boolean getIntersectFilteringQueryWarned()
      Returns:
      true if a client warning is emitted for a filtering query with an intersection on mutable columns at a consistency level requiring coordinator reconciliation

    • setIntersectFilteringQueryWarned

      void setIntersectFilteringQueryWarned(boolean value)

    • getIntersectFilteringQueryEnabled

      boolean getIntersectFilteringQueryEnabled()
      Returns:
      true if it is possible to execute a filtering query with an intersection on mutable columns at a consistency level requiring coordinator reconciliation

    • setIntersectFilteringQueryEnabled

      void setIntersectFilteringQueryEnabled(boolean value)