Skip to main content

A set of string constants for the parameter AlterTierRequest.options. More…

​
Static Public Attributes

const string CAPACITY = “capacity”
 Maximum size in bytes this tier may hold at once, per rank.
 
const string HIGH_WATERMARK = “high_watermark”
 Threshold of usage of this tier’s resource that once exceeded, will trigger watermark-based eviction from this tier.
 
const string LOW_WATERMARK = “low_watermark”
 Threshold of resource usage that once fallen below after crossing the HIGH_WATERMARK, will cease watermark-based eviction from this tier.
 
const string WAIT_TIMEOUT = “wait_timeout”
 Timeout in seconds for reading from or writing to this resource.
 
const string PERSIST = “persist”
 If TRUE the system configuration will be written to disk upon successful application of this request.
 
const string TRUE = “true”
 A boolean constant for the AlterTierRequest.Options options.
 
const string FALSE = “false”
 A boolean constant for the AlterTierRequest.Options options.
 
const string RANK = “rank”
 Apply the requested change only to a specific rank.
 

​
Detailed Description

A set of string constants for the parameter AlterTierRequest.options.

Optional parameters.

Definition at line 28 of file AlterTier.cs.

​
Member Data Documentation

​
◆ CAPACITY

const string kinetica.AlterTierRequest.Options.CAPACITY = “capacity”
 static

Maximum size in bytes this tier may hold at once, per rank.

Definition at line 32 of file AlterTier.cs.

​
◆ FALSE

const string kinetica.AlterTierRequest.Options.FALSE = “false”
 static

A boolean constant for the AlterTierRequest.Options options.

Definition at line 80 of file AlterTier.cs.

​
◆ HIGH_WATERMARK

const string kinetica.AlterTierRequest.Options.HIGH_WATERMARK = “high_watermark”
 static

Threshold of usage of this tier’s resource that once exceeded, will trigger watermark-based eviction from this tier.

The minimum allowed value is ‘0’. The maximum allowed value is ‘100’.

Definition at line 39 of file AlterTier.cs.

​
◆ LOW_WATERMARK

const string kinetica.AlterTierRequest.Options.LOW_WATERMARK = “low_watermark”
 static

Threshold of resource usage that once fallen below after crossing the HIGH_WATERMARK, will cease watermark-based eviction from this tier.

The minimum allowed value is ‘0’. The maximum allowed value is ‘100’.

Definition at line 47 of file AlterTier.cs.

​
◆ PERSIST

const string kinetica.AlterTierRequest.Options.PERSIST = “persist”
 static

If TRUE the system configuration will be written to disk upon successful application of this request.

This will commit the changes from this request and any additional in-memory modifications. Supported values:

The default value is TRUE.

Definition at line 72 of file AlterTier.cs.

​
◆ RANK

const string kinetica.AlterTierRequest.Options.RANK = “rank”
 static

Apply the requested change only to a specific rank.

The minimum allowed value is ‘0’. The maximum allowed value is ‘10000’.

Definition at line 86 of file AlterTier.cs.

​
◆ TRUE

const string kinetica.AlterTierRequest.Options.TRUE = “true”
 static

A boolean constant for the AlterTierRequest.Options options.

Definition at line 76 of file AlterTier.cs.

​
◆ WAIT_TIMEOUT

const string kinetica.AlterTierRequest.Options.WAIT_TIMEOUT = “wait_timeout”
 static

Timeout in seconds for reading from or writing to this resource.

Applies to cold storage tiers only.

Definition at line 52 of file AlterTier.cs.

The documentation for this struct was generated from the following files:
  • _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/AlterTier.cs
  • Kinetica/Protocol/AlterTier.cs