Skip to main content

A set of parameters for Kinetica.alterTier. More…

Inheritance diagram for kinetica.AlterTierRequest:
[legend]
Collaboration diagram for kinetica.AlterTierRequest:
[legend]

​
Classes

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

​
Public Member Functions

 AlterTierRequest ()
 Constructs an AlterTierRequest object with default parameters.
 
 AlterTierRequest (string name, IDictionary< string, string > options=null)
 Constructs an AlterTierRequest object with the specified parameters.
 
 AlterTierRequest ()
 Constructs an AlterTierRequest object with default parameters.
 
 AlterTierRequest (string name, IDictionary< string, string > options=null)
 Constructs an AlterTierRequest object with the specified parameters.
 
 Public Member Functions inherited from kinetica.KineticaData
 KineticaData (KineticaType type)
 Constructor from Kinetica Type.
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type.
 
object Get (int fieldPos)
 Retrieve a specific property from this object.
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object.
 
 KineticaData (KineticaType type)
 Constructor from Kinetica Type.
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type.
 
object Get (int fieldPos)
 Retrieve a specific property from this object.
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object.
 

​
Properties

string name [get, set]
 Name of the tier to be altered.
 
IDictionary< string, string > options = new Dictionary<string, string>() [get, set]
 Optional parameters.
 
 Properties inherited from kinetica.KineticaData
Schema Schema [get]
 Avro Schema for this class.
 

​
Additional Inherited Members

 Static Public Member Functions inherited from kinetica.KineticaData
static ? RecordSchema SchemaFromType (System.Type t, KineticaType? ktype=null)
 Create an Avro Schema from a System.Type and a KineticaType.
 
static ? RecordSchema SchemaFromType (System.Type t, KineticaType? ktype=null)
 Create an Avro Schema from a System.Type and a KineticaType.
 

​
Detailed Description

A set of parameters for Kinetica.alterTier.

Alters properties of an existing tier to facilitate resource management.

To disable watermark-based eviction, set both HIGH_WATERMARK and LOW_WATERMARK to 100.

Definition at line 23 of file AlterTier.cs.

​
Constructor & Destructor Documentation

​
◆ AlterTierRequest() [1/4]

kinetica.AlterTierRequest.AlterTierRequest ()
 inline

Constructs an AlterTierRequest object with default parameters.

Definition at line 166 of file AlterTier.cs.

​
◆ AlterTierRequest() [2/4]

kinetica.AlterTierRequest.AlterTierRequest (stringname,
IDictionary< string, string >options = null )
 inline

Constructs an AlterTierRequest object with the specified parameters.

Parameters
nameName of the tier to be altered. Must be an existing tier group name: vram, ram, disk[n], persist, cold[n].
optionsOptional parameters.
  • CAPACITY: Maximum size in bytes this tier may hold at once, per rank.
  • HIGH_WATERMARK: 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’.
  • LOW_WATERMARK: 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’.
  • 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 minimum allowed value is ‘0’. The maximum allowed value is ‘10000’.
The default value is an empty Dictionary.

Definition at line 241 of file AlterTier.cs.

​
◆ AlterTierRequest() [3/4]

kinetica.AlterTierRequest.AlterTierRequest ()
 inline

Constructs an AlterTierRequest object with default parameters.

Definition at line 166 of file AlterTier.cs.

​
◆ AlterTierRequest() [4/4]

kinetica.AlterTierRequest.AlterTierRequest (stringname,
IDictionary< string, string >options = null )
 inline

Constructs an AlterTierRequest object with the specified parameters.

Parameters
nameName of the tier to be altered. Must be an existing tier group name: vram, ram, disk[n], persist, cold[n].
optionsOptional parameters.
  • CAPACITY: Maximum size in bytes this tier may hold at once, per rank.
  • HIGH_WATERMARK: 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’.
  • LOW_WATERMARK: 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’.
  • 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 minimum allowed value is ‘0’. The maximum allowed value is ‘10000’.
The default value is an empty Dictionary.

Definition at line 241 of file AlterTier.cs.

​
Property Documentation

​
◆ name

string kinetica.AlterTierRequest.name
 getset

Name of the tier to be altered.

Must be an existing tier group name: vram, ram, disk[n], persist, cold[n].

Definition at line 92 of file AlterTier.cs.

​
◆ options

IDictionary< string, string > kinetica.AlterTierRequest.options = new Dictionary<string, string>()
 getset

Optional parameters.

  • CAPACITY: Maximum size in bytes this tier may hold at once, per rank.
  • HIGH_WATERMARK: 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’.
  • LOW_WATERMARK: 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’.
  • 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 minimum allowed value is ‘0’. The maximum allowed value is ‘10000’.

The default value is an empty Dictionary.

Definition at line 162 of file AlterTier.cs.

The documentation for this class 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