kinetica.AlterResourceGroupRequest Class Reference
A set of parameters for Kinetica.alterResourceGroup. More...
Inheritance diagram for kinetica.AlterResourceGroupRequest:
Collaboration diagram for kinetica.AlterResourceGroupRequest:
Classes | |
| struct | Options |
| A set of string constants for the parameter options. More... | |
| struct | Ranking |
| A set of string constants for the parameter ranking. More... | |
| struct | TierAttributes |
| A set of string constants for the parameter tier_attributes. More... | |
Public Member Functions | |
| AlterResourceGroupRequest () | |
| Constructs an AlterResourceGroupRequest object with default parameters. More... | |
| AlterResourceGroupRequest (string name, IDictionary< string, IDictionary< string, string >> tier_attributes=null, string ranking=null, string adjoining_resource_group=null, IDictionary< string, string > options=null) | |
| Constructs an AlterResourceGroupRequest 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 group to be altered. More... | |
| IDictionary< string, IDictionary< string, string > > | tier_attributes = new Dictionary<string, IDictionary<string, string>>() [get, set] |
| Optional map containing tier names and their respective attribute group limits. More... | |
| string | ranking = Ranking.EMPTY_STRING [get, set] |
| If the resource group ranking is to be updated, this indicates the relative ranking among existing resource groups where this resource group will be moved; leave blank if not changing the ranking. More... | |
| string | adjoining_resource_group = "" [get, set] |
| If ranking is BEFORE or AFTER, this field indicates the resource group before or after which the current group will be placed; otherwise, leave blank. More... | |
| IDictionary< string, string > | options = new Dictionary<string, string>() [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.alterResourceGroup.
Alters the properties of an exisiting resource group to facilitate resource management.
Definition at line 16 of file AlterResourceGroup.cs.
Constructor & Destructor Documentation
◆ AlterResourceGroupRequest() [1/2]
|
inline |
Constructs an AlterResourceGroupRequest object with default parameters.
Definition at line 249 of file AlterResourceGroup.cs.
◆ AlterResourceGroupRequest() [2/2]
|
inline |
Constructs an AlterResourceGroupRequest object with the specified parameters.
- Parameters
-
name Name of the group to be altered. Must be an existing resource group name or an empty string when used inconjunction with the is_default_group option. tier_attributes Optional 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 & RAM tiers. For instance, to set max VRAM capacity to 1GB and max RAM capacity to 10GB, use: {'VRAM':{'max_memory':'1000000000'}, 'RAM':{'max_memory':'10000000000'}}. - MAX_MEMORY: Maximum amount of memory usable in the given tier at one time for this group.
ranking If the resource group ranking is to be updated, this indicates the relative ranking among existing resource groups where this resource group will be moved; leave blank if not changing the ranking. When using BEFORE or AFTER, specify which resource group this one will be inserted before or after in adjoining_resource_group . Supported values: The default value is EMPTY_STRING. adjoining_resource_group If 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 ''. options Optional parameters. - MAX_CPU_CONCURRENCY: Maximum number of simultaneous threads that will be used to execute a request for this group. The minimum allowed value is '4'.
- MAX_DATA: Maximum amount of cumulative ram usage regardless of tier status for this group. 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.
Definition at line 381 of file AlterResourceGroup.cs.
Property Documentation
◆ adjoining_resource_group
|
getset |
If 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 ''.
Definition at line 169 of file AlterResourceGroup.cs.
◆ name
|
getset |
Name of the group to be altered.
Must be an existing resource group name or an empty string when used inconjunction with the is_default_group option.
Definition at line 121 of file AlterResourceGroup.cs.
◆ options
|
getset |
Optional parameters.
- MAX_CPU_CONCURRENCY: Maximum number of simultaneous threads that will be used to execute a request for this group. The minimum allowed value is '4'.
- MAX_DATA: Maximum amount of cumulative ram usage regardless of tier status for this group. 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.
Definition at line 245 of file AlterResourceGroup.cs.
◆ ranking
|
getset |
If the resource group ranking is to be updated, this indicates the relative ranking among existing resource groups where this resource group will be moved; leave blank if not changing the ranking.
Supported values:
The default value is EMPTY_STRING.
Definition at line 161 of file AlterResourceGroup.cs.
◆ tier_attributes
|
getset |
Optional map containing tier names and their respective attribute group limits.
- MAX_MEMORY: Maximum amount of memory usable in the given tier at one time for this group.
The default value is an empty Dictionary.
Definition at line 134 of file AlterResourceGroup.cs.
The documentation for this class was generated from the following file:
- Kinetica/Protocol/AlterResourceGroup.cs
