Skip to main content

​
◆ alterTier() [1/2]

AlterTierResponse kinetica.Kinetica.alterTier (AlterTierRequestrequest_)
 inline

Alters properties of an existing tier to facilitate resource management.

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

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 14499 of file KineticaFunctions.cs.

​
◆ alterTier() [2/2]

AlterTierResponse kinetica.Kinetica.alterTier (stringname,
IDictionary< string, string >options = null )
 inline

Alters properties of an existing tier to facilitate resource management.

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

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.
Returns
Response object containing the result of the operation.

Definition at line 14614 of file KineticaFunctions.cs.

​
◆ AlterTierAsync() [1/2]

async System.Threading.Tasks.Task< AlterTierResponse > kinetica.Kinetica.AlterTierAsync (AlterTierRequestrequest_,
System.Threading.CancellationTokencancellationToken = default )
 inline

Alters properties of an existing tier to facilitate resource management.

(async)

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

Parameters
request_Request object containing the parameters for the operation.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 14523 of file KineticaFunctions.cs.

​
◆ AlterTierAsync() [2/2]

async System.Threading.Tasks.Task< AlterTierResponse > kinetica.Kinetica.AlterTierAsync (stringname,
IDictionary< string, string >options = null,
System.Threading.CancellationTokencancellationToken = default )
 inline

Alters properties of an existing tier to facilitate resource management.

(async)

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

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.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 14705 of file KineticaFunctions.cs.