GuardrailsConfig (apache-cassandra API)

All Known Implementing Classes:

GuardrailsOptions
```
public interface GuardrailsConfig
```
Configuration settings for guardrails.
Note that the settings here must only be used by the Guardrails class and not directly by the code checking each guarded constraint (which, again, should use the higher level abstractions defined in Guardrails).
We have 2 variants of guardrails, soft (warn) and hard (fail) limits, each guardrail having either one of the variants or both. Note in particular that hard limits only make sense for guardrails triggering during query execution. For other guardrails, say one triggering during compaction, aborting that compaction does not make sense.
Additionally, each individual setting should have a specific value (typically -1 for numeric settings), that allows to disable the corresponding guardrail.
This configuration is offered as an interface so different implementations of GuardrailsConfigProvider can provide different implementations of this config. However, this mechanism for guardrails config pluggability is not officially supported and this interface may change in a minor release.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`getAllowFilteringEnabled()` Returns whether ALLOW FILTERING property is allowed.
`DataStorageSpec.LongBytesBound`	`getCollectionSizeFailThreshold()`
`DataStorageSpec.LongBytesBound`	`getCollectionSizeWarnThreshold()`
`int`	`getColumnsPerTableFailThreshold()`
`int`	`getColumnsPerTableWarnThreshold()`
`boolean`	`getCompactTablesEnabled()` Returns whether users can create new COMPACT STORAGE tables
`DataStorageSpec.LongBytesBound`	`getDataDiskUsageMaxDiskSize()`
`int`	`getDataDiskUsagePercentageFailThreshold()`
`int`	`getDataDiskUsagePercentageWarnThreshold()`
`boolean`	`getDropTruncateTableEnabled()` Returns whether TRUNCATE or DROP table are allowed
`int`	`getFieldsPerUDTFailThreshold()`
`int`	`getFieldsPerUDTWarnThreshold()`
`boolean`	`getGroupByEnabled()` Returns whether GROUP BY functionality is allowed
`int`	`getInSelectCartesianProductFailThreshold()`
`int`	`getInSelectCartesianProductWarnThreshold()`
`int`	`getItemsPerCollectionFailThreshold()`
`int`	`getItemsPerCollectionWarnThreshold()`
`int`	`getKeyspacesFailThreshold()`
`int`	`getKeyspacesWarnThreshold()`
`int`	`getMaterializedViewsPerTableFailThreshold()`
`int`	`getMaterializedViewsPerTableWarnThreshold()`
`int`	`getMinimumReplicationFactorFailThreshold()`
`int`	`getMinimumReplicationFactorWarnThreshold()`
`int`	`getPageSizeFailThreshold()`
`int`	`getPageSizeWarnThreshold()`
`int`	`getPartitionKeysInSelectFailThreshold()`
`int`	`getPartitionKeysInSelectWarnThreshold()`
`boolean`	`getReadBeforeWriteListOperationsEnabled()` Returns whether list operations that require read before write are allowed.
`java.util.Set<ConsistencyLevel>`	`getReadConsistencyLevelsDisallowed()`
`java.util.Set<ConsistencyLevel>`	`getReadConsistencyLevelsWarned()`
`boolean`	`getSecondaryIndexesEnabled()`
`int`	`getSecondaryIndexesPerTableFailThreshold()`
`int`	`getSecondaryIndexesPerTableWarnThreshold()`
`java.util.Set<java.lang.String>`	`getTablePropertiesDisallowed()`
`java.util.Set<java.lang.String>`	`getTablePropertiesIgnored()`
`java.util.Set<java.lang.String>`	`getTablePropertiesWarned()`
`int`	`getTablesFailThreshold()`
`int`	`getTablesWarnThreshold()`
`boolean`	`getUncompressedTablesEnabled()` Returns whether tables can be uncompressed
`boolean`	`getUserTimestampsEnabled()` Returns whether user-provided timestamps are allowed.
`java.util.Set<ConsistencyLevel>`	`getWriteConsistencyLevelsDisallowed()`
`java.util.Set<ConsistencyLevel>`	`getWriteConsistencyLevelsWarned()`

- Method Detail
  - getKeyspacesWarnThreshold
```
int getKeyspacesWarnThreshold()
```
    Returns:
    
    The threshold to warn when creating more user keyspaces than threshold.
  - getKeyspacesFailThreshold
```
int getKeyspacesFailThreshold()
```
    Returns:
    
    The threshold to fail when creating more user keyspaces than threshold.
  - getTablesWarnThreshold
```
int getTablesWarnThreshold()
```
    Returns:
    
    The threshold to warn when creating more user tables than threshold.
  - getTablesFailThreshold
```
int getTablesFailThreshold()
```
    Returns:
    
    The threshold to fail when creating more user tables than threshold.
  - getColumnsPerTableWarnThreshold
```
int getColumnsPerTableWarnThreshold()
```
    Returns:
    
    The threshold to warn when creating more columns per table than threshold.
  - getColumnsPerTableFailThreshold
```
int getColumnsPerTableFailThreshold()
```
    Returns:
    
    The threshold to fail when creating more columns per table than threshold.
  - getSecondaryIndexesPerTableWarnThreshold
```
int getSecondaryIndexesPerTableWarnThreshold()
```
    Returns:
    
    The threshold to warn when creating more secondary indexes per table than threshold.
  - getSecondaryIndexesPerTableFailThreshold
```
int getSecondaryIndexesPerTableFailThreshold()
```
    Returns:
    
    The threshold to fail when creating more secondary indexes per table than threshold.
  - getSecondaryIndexesEnabled
```
boolean getSecondaryIndexesEnabled()
```
    Returns:
    
    Whether creation of secondary indexes is allowed.
  - getMaterializedViewsPerTableWarnThreshold
```
int getMaterializedViewsPerTableWarnThreshold()
```
    Returns:
    
    The threshold to warn when creating more materialized views per table than threshold.
  - getPartitionKeysInSelectWarnThreshold
```
int getPartitionKeysInSelectWarnThreshold()
```
    Returns:
    
    The threshold to warn when partition keys in select more than threshold.
  - getPartitionKeysInSelectFailThreshold
```
int getPartitionKeysInSelectFailThreshold()
```
    Returns:
    
    The threshold to fail when partition keys in select more than threshold.
  - getMaterializedViewsPerTableFailThreshold
```
int getMaterializedViewsPerTableFailThreshold()
```
    Returns:
    
    The threshold to fail when creating more materialized views per table than threshold.
  - getTablePropertiesWarned
```
java.util.Set<java.lang.String> getTablePropertiesWarned()
```
    Returns:
    
    The table properties that are warned about when creating or altering a table.
  - getTablePropertiesIgnored
```
java.util.Set<java.lang.String> getTablePropertiesIgnored()
```
    Returns:
    
    The table properties that are ignored when creating or altering a table.
  - getTablePropertiesDisallowed
```
java.util.Set<java.lang.String> getTablePropertiesDisallowed()
```
    Returns:
    
    The table properties that are disallowed 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.
  - getUncompressedTablesEnabled
```
boolean getUncompressedTablesEnabled()
```
    Returns whether tables can be uncompressed
    
    Returns:
    
    true if user's can disable compression, false otherwise.
  - getCompactTablesEnabled
```
boolean getCompactTablesEnabled()
```
    Returns whether users can create new COMPACT STORAGE tables
    
    Returns:
    
    true if allowed, false otherwise.
  - getGroupByEnabled
```
boolean getGroupByEnabled()
```
    Returns whether GROUP BY functionality is allowed
    
    Returns:
    
    true if allowed, false otherwise.
  - getDropTruncateTableEnabled
```
boolean getDropTruncateTableEnabled()
```
    Returns whether TRUNCATE or DROP table are allowed
    
    Returns:
    
    true if allowed, false otherwise.
  - getPageSizeWarnThreshold
```
int getPageSizeWarnThreshold()
```
    Returns:
    
    The threshold to warn when page size exceeds given size.
  - getPageSizeFailThreshold
```
int getPageSizeFailThreshold()
```
    Returns:
    
    The threshold to fail when page size exceeds given size.
  - 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.
  - getAllowFilteringEnabled
```
boolean getAllowFilteringEnabled()
```
    Returns whether ALLOW FILTERING property is allowed.
    
    Returns:
    
    true if ALLOW FILTERING is allowed, false otherwise.
  - 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.
  - getReadConsistencyLevelsWarned
```
java.util.Set<ConsistencyLevel> getReadConsistencyLevelsWarned()
```
    Returns:
    
    The consistency levels that are warned about when reading.
  - getReadConsistencyLevelsDisallowed
```
java.util.Set<ConsistencyLevel> getReadConsistencyLevelsDisallowed()
```
    Returns:
    
    The consistency levels that are disallowed when reading.
  - getWriteConsistencyLevelsWarned
```
java.util.Set<ConsistencyLevel> getWriteConsistencyLevelsWarned()
```
    Returns:
    
    The consistency levels that are warned about when writing.
  - getWriteConsistencyLevelsDisallowed
```
java.util.Set<ConsistencyLevel> getWriteConsistencyLevelsDisallowed()
```
    Returns:
    
    The consistency levels that are disallowed when writing.
  - getCollectionSizeWarnThreshold
```
@Nullable
DataStorageSpec.LongBytesBound getCollectionSizeWarnThreshold()
```
    Returns:
    
    The threshold to warn when encountering a collection with larger data size than threshold.
  - getCollectionSizeFailThreshold
```
@Nullable
DataStorageSpec.LongBytesBound getCollectionSizeFailThreshold()
```
    Returns:
    
    The threshold to prevent collections with larger data size than threshold.
  - 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.
  - getFieldsPerUDTWarnThreshold
```
int getFieldsPerUDTWarnThreshold()
```
    Returns:
    
    The threshold to warn when creating a UDT with more fields than threshold.
  - getFieldsPerUDTFailThreshold
```
int getFieldsPerUDTFailThreshold()
```
    Returns:
    
    The threshold to fail when creating a UDT with more fields than threshold.
  - getDataDiskUsagePercentageWarnThreshold
```
int getDataDiskUsagePercentageWarnThreshold()
```
    Returns:
    
    The threshold to warn when local 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 disk usage percentage exceeds that threshold. Allowed values are in the range [1, 100], and -1 means disabled.
  - getDataDiskUsageMaxDiskSize
```
@Nullable
DataStorageSpec.LongBytesBound getDataDiskUsageMaxDiskSize()
```
    Returns:
    
    The max disk size of the data directories when calculating disk usage thresholds, null 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.

Interface GuardrailsConfig

Method Summary

Method Detail

getKeyspacesWarnThreshold

getKeyspacesFailThreshold

getTablesWarnThreshold

getTablesFailThreshold

getColumnsPerTableWarnThreshold

getColumnsPerTableFailThreshold

getSecondaryIndexesPerTableWarnThreshold

getSecondaryIndexesPerTableFailThreshold

getSecondaryIndexesEnabled

getMaterializedViewsPerTableWarnThreshold

getPartitionKeysInSelectWarnThreshold

getPartitionKeysInSelectFailThreshold

getMaterializedViewsPerTableFailThreshold

getTablePropertiesWarned

getTablePropertiesIgnored

getTablePropertiesDisallowed

getUserTimestampsEnabled

getUncompressedTablesEnabled

getCompactTablesEnabled

getGroupByEnabled

getDropTruncateTableEnabled

getPageSizeWarnThreshold

getPageSizeFailThreshold

getReadBeforeWriteListOperationsEnabled

getAllowFilteringEnabled

getInSelectCartesianProductWarnThreshold

getInSelectCartesianProductFailThreshold

getReadConsistencyLevelsWarned

getReadConsistencyLevelsDisallowed

getWriteConsistencyLevelsWarned

getWriteConsistencyLevelsDisallowed

getCollectionSizeWarnThreshold

getCollectionSizeFailThreshold

getItemsPerCollectionWarnThreshold

getItemsPerCollectionFailThreshold

getFieldsPerUDTWarnThreshold

getFieldsPerUDTFailThreshold

getDataDiskUsagePercentageWarnThreshold

getDataDiskUsagePercentageFailThreshold

getDataDiskUsageMaxDiskSize

getMinimumReplicationFactorWarnThreshold

getMinimumReplicationFactorFailThreshold