Skip to main content

​
◆ alterResourceGroup() [1/2]

AlterResourceGroupResponse kinetica.Kinetica.alterResourceGroup (AlterResourceGroupRequestrequest_)
 inline

Alters the properties of an existing resource group to facilitate resource management.

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

Definition at line 10811 of file KineticaFunctions.cs.

​
◆ alterResourceGroup() [2/2]

AlterResourceGroupResponse kinetica.Kinetica.alterResourceGroup (stringname,
IDictionary< string, IDictionary< string, string > >tier_attributes = null,
stringranking = AlterResourceGroupRequest::Ranking::EMPTY_STRING,
stringadjoining_resource_group = "",
IDictionary< string, string >options = null )
 inline

Alters the properties of an existing resource group to facilitate resource management.

Parameters
nameName of the group to be altered. Must be an existing resource group name or an empty string when used in conjunction with IS_DEFAULT_GROUP.
tier_attributesOptional map containing tier names and their respective attribute group limits. The only valid attribute limit that can be set is max_memory (in bytes) for the VRAM and RAM tiers. For instance, to set max VRAM capacity to 1GB per rank per GPU and max RAM capacity to 10GB per rank, use: ‘VRAM’:‘max_memory’:‘1000000000’, ‘RAM’:‘max_memory’:‘10000000000’.
  • MAX_MEMORY: Maximum amount of memory usable at one time, per rank, per GPU, for the VRAM tier; or maximum amount of memory usable at one time, per rank, for the RAM tier.
The default value is an empty Dictionary.
rankingIf the resource group ranking is to be updated, this indicates the relative ranking among existing resource groups where this resource group will be placed. Supported values:
  • EMPTY_STRING: Don’t change the ranking.
  • FIRST: Make this resource group the new first one in the ordering.
  • LAST: Make this resource group the new last one in the ordering.
  • BEFORE: Place this resource group before the one specified by adjoining_resource_group in the ordering.
  • AFTER: Place this resource group after the one specified by adjoining_resource_group in the ordering.
The default value is EMPTY_STRING.
adjoining_resource_groupIf ranking is BEFORE or AFTER, this field indicates the resource group before or after which the current group will be placed; otherwise, leave blank. The default value is ”.
optionsOptional parameters.
  • MAX_CPU_CONCURRENCY: Maximum number of simultaneous threads that will be used to execute a request, per rank, for this group. The minimum allowed value is ‘4’.
  • MAX_DATA: Maximum amount of data, per rank, in bytes, that can be used by all database objects within this group. Set to -1 to indicate no upper limit. The minimum allowed value is ‘-1’.
  • MAX_SCHEDULING_PRIORITY: Maximum priority of a scheduled task for this group. The minimum allowed value is ‘1’. The maximum allowed value is ‘100’.
  • MAX_TIER_PRIORITY: Maximum priority of a tiered object for this group. The minimum allowed value is ‘1’. The maximum allowed value is ‘10’.
  • IS_DEFAULT_GROUP: If TRUE, this request applies to the global default resource group. It is an error for this field to be TRUE when the name field is also populated. Supported values:The default value is FALSE.
  • PERSIST: If TRUE and a system-level change was requested, 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.
The default value is an empty Dictionary.
Returns
Response object containing the result of the operation.

Definition at line 11006 of file KineticaFunctions.cs.

​
◆ AlterResourceGroupAsync() [1/2]

async System.Threading.Tasks.Task< AlterResourceGroupResponse > kinetica.Kinetica.AlterResourceGroupAsync (AlterResourceGroupRequestrequest_,
System.Threading.CancellationTokencancellationToken = default )
 inline

Alters the properties of an existing resource group to facilitate resource management.

(async)

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 10827 of file KineticaFunctions.cs.

​
◆ AlterResourceGroupAsync() [2/2]

async System.Threading.Tasks.Task< AlterResourceGroupResponse > kinetica.Kinetica.AlterResourceGroupAsync (stringname,
IDictionary< string, IDictionary< string, string > >tier_attributes = null,
stringranking = AlterResourceGroupRequest::Ranking::EMPTY_STRING,
stringadjoining_resource_group = "",
IDictionary< string, string >options = null,
System.Threading.CancellationTokencancellationToken = default )
 inline

Alters the properties of an existing resource group to facilitate resource management.

(async)

Parameters
nameName of the group to be altered. Must be an existing resource group name or an empty string when used in conjunction with IS_DEFAULT_GROUP.
tier_attributesOptional map containing tier names and their respective attribute group limits. The only valid attribute limit that can be set is max_memory (in bytes) for the VRAM and RAM tiers. For instance, to set max VRAM capacity to 1GB per rank per GPU and max RAM capacity to 10GB per rank, use: ‘VRAM’:‘max_memory’:‘1000000000’, ‘RAM’:‘max_memory’:‘10000000000’.
  • MAX_MEMORY: Maximum amount of memory usable at one time, per rank, per GPU, for the VRAM tier; or maximum amount of memory usable at one time, per rank, for the RAM tier.
The default value is an empty Dictionary.
rankingIf the resource group ranking is to be updated, this indicates the relative ranking among existing resource groups where this resource group will be placed. Supported values:
  • EMPTY_STRING: Don’t change the ranking.
  • FIRST: Make this resource group the new first one in the ordering.
  • LAST: Make this resource group the new last one in the ordering.
  • BEFORE: Place this resource group before the one specified by adjoining_resource_group in the ordering.
  • AFTER: Place this resource group after the one specified by adjoining_resource_group in the ordering.
The default value is EMPTY_STRING.
adjoining_resource_groupIf ranking is BEFORE or AFTER, this field indicates the resource group before or after which the current group will be placed; otherwise, leave blank. The default value is ”.
optionsOptional parameters.
  • MAX_CPU_CONCURRENCY: Maximum number of simultaneous threads that will be used to execute a request, per rank, for this group. The minimum allowed value is ‘4’.
  • MAX_DATA: Maximum amount of data, per rank, in bytes, that can be used by all database objects within this group. Set to -1 to indicate no upper limit. The minimum allowed value is ‘-1’.
  • MAX_SCHEDULING_PRIORITY: Maximum priority of a scheduled task for this group. The minimum allowed value is ‘1’. The maximum allowed value is ‘100’.
  • MAX_TIER_PRIORITY: Maximum priority of a tiered object for this group. The minimum allowed value is ‘1’. The maximum allowed value is ‘10’.
  • IS_DEFAULT_GROUP: If TRUE, this request applies to the global default resource group. It is an error for this field to be TRUE when the name field is also populated. Supported values:The default value is FALSE.
  • PERSIST: If TRUE and a system-level change was requested, 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.
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 11191 of file KineticaFunctions.cs.