Kinetica C# API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
kinetica.AlterTierRequest Class Reference

A set of parameters for Kinetica.alterTier(string,IDictionary{string, string}). More...

+ Inheritance diagram for kinetica.AlterTierRequest:
+ Collaboration diagram for kinetica.AlterTierRequest:

Classes

struct  Options
 Optional parameters. More...
 

Public Member Functions

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

Properties

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

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. More...
 

Detailed Description

A set of parameters for Kinetica.alterTier(string,IDictionary{string, string}).


Alters properties of an exisiting tier to facilitate resource management.
To disable watermark-based eviction, set both high_watermark and low_watermark to 100.

Definition at line 25 of file AlterTier.cs.

Constructor & Destructor Documentation

kinetica.AlterTierRequest.AlterTierRequest ( )
inline

Constructs an AlterTierRequest object with default parameters.

Definition at line 106 of file AlterTier.cs.

kinetica.AlterTierRequest.AlterTierRequest ( string  name,
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.
optionsOptional 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.
The default value is an empty Dictionary.

Definition at line 138 of file AlterTier.cs.

Property Documentation

string kinetica.AlterTierRequest.name
getset

Name of the tier to be altered.

Must be an existing tier group name.

Definition at line 75 of file AlterTier.cs.

IDictionary<string, string> kinetica.AlterTierRequest.options
getset

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.

The default value is an empty Dictionary.

Definition at line 101 of file AlterTier.cs.


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