Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
kinetica.AlterTierRequest.Options Struct Reference

Optional parameters. More...

Public Attributes

const string CAPACITY = "capacity"
 Maximum size in bytes this tier may hold at once. More...
 
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. More...
 
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. More...
 
const string WAIT_TIMEOUT = "wait_timeout"
 Timeout in seconds for reading from or writing to this resource. More...
 
const string PERSIST = "persist"
 If true the system configuration will be written to disk upon successful application of this request. More...
 
const string TRUE = "true"
 
const string FALSE = "false"
 
const string RANK = "rank"
 Apply the requested change only to a specific rank. More...
 

Detailed Description

Optional parameters.

  • CAPACITY: Maximum size in bytes this tier may hold at once.
  • HIGH_WATERMARK: Threshold of usage of this tier's resource that once exceeded, will trigger watermark-based eviction from this tier.
  • LOW_WATERMARK: Threshold of resource usage that once fallen below after crossing the high_watermark, will cease watermark-based eviction from this tier.
  • WAIT_TIMEOUT: Timeout in seconds for reading from or writing to this resource. Applies to cold storage tiers only.
  • PERSIST: 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.
  • RANK: Apply the requested change only to a specific rank.

The default value is an empty Dictionary. A set of string constants for the parameter options.

Definition at line 89 of file AlterTier.cs.

Member Data Documentation

const string kinetica.AlterTierRequest.Options.CAPACITY = "capacity"

Maximum size in bytes this tier may hold at once.

Definition at line 94 of file AlterTier.cs.

const string kinetica.AlterTierRequest.Options.FALSE = "false"

Definition at line 129 of file AlterTier.cs.

const string kinetica.AlterTierRequest.Options.HIGH_WATERMARK = "high_watermark"

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

Definition at line 99 of file AlterTier.cs.

const string kinetica.AlterTierRequest.Options.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.

Definition at line 104 of file AlterTier.cs.

const string kinetica.AlterTierRequest.Options.PERSIST = "persist"

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 127 of file AlterTier.cs.

const string kinetica.AlterTierRequest.Options.RANK = "rank"

Apply the requested change only to a specific rank.

Definition at line 133 of file AlterTier.cs.

const string kinetica.AlterTierRequest.Options.TRUE = "true"

Definition at line 128 of file AlterTier.cs.

const string kinetica.AlterTierRequest.Options.WAIT_TIMEOUT = "wait_timeout"

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

Applies to cold storage tiers only.

Definition at line 108 of file AlterTier.cs.


The documentation for this struct was generated from the following file: