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

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

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

Properties inherited from Avro.Specific.ISpecificRecord
Schema	Schema `[get]`

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

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 existing resource group to facilitate resource management.

Definition at line 16 of file AlterResourceGroup.cs.

Constructor & Destructor Documentation

◆ AlterResourceGroupRequest() [1/4]

kinetica.AlterResourceGroupRequest.AlterResourceGroupRequest ( )

inline

Constructs an AlterResourceGroupRequest object with default parameters.

Definition at line 276 of file AlterResourceGroup.cs.

◆ AlterResourceGroupRequest() [2/4]

kinetica.AlterResourceGroupRequest.AlterResourceGroupRequest	(	string	name,
		IDictionary< string, IDictionary< string, string >>	tier_attributes = `null`,
		string	ranking = `null`,
		string	adjoining_resource_group = `null`,
		IDictionary< string, string >	options = `null`
	)

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 in conjunction with IS_DEFAULT_GROUP.
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 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.
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 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_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, 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: TRUE FALSE 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: TRUE FALSE The default value is TRUE. The default value is an empty Dictionary.

Definition at line 419 of file AlterResourceGroup.cs.

◆ AlterResourceGroupRequest() [3/4]

kinetica.AlterResourceGroupRequest.AlterResourceGroupRequest ( )

inline

Constructs an AlterResourceGroupRequest object with default parameters.

Definition at line 276 of file AlterResourceGroup.cs.

◆ AlterResourceGroupRequest() [4/4]

kinetica.AlterResourceGroupRequest.AlterResourceGroupRequest	(	string	name,
		IDictionary< string, IDictionary< string, string >>	tier_attributes = `null`,
		string	ranking = `null`,
		string	adjoining_resource_group = `null`,
		IDictionary< string, string >	options = `null`
	)

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 in conjunction with IS_DEFAULT_GROUP.
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 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.
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 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_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, 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: TRUE FALSE 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: TRUE FALSE The default value is TRUE. The default value is an empty Dictionary.

Definition at line 419 of file AlterResourceGroup.cs.

Property Documentation

◆ adjoining_resource_group

string kinetica.AlterResourceGroupRequest.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 195 of file AlterResourceGroup.cs.

◆ name

string kinetica.AlterResourceGroupRequest.name

getset

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

Definition at line 135 of file AlterResourceGroup.cs.

◆ options

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

getset

Optional 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:
- TRUE
- FALSE
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:
- TRUE
- FALSE
The default value is TRUE.

The default value is an empty Dictionary.

Definition at line 272 of file AlterResourceGroup.cs.

◆ ranking

string kinetica.AlterResourceGroupRequest.ranking = Ranking.EMPTY_STRING

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

Definition at line 187 of file AlterResourceGroup.cs.

◆ tier_attributes

IDictionary< string, IDictionary< string, string > > kinetica.AlterResourceGroupRequest.tier_attributes = new Dictionary<string, IDictionary<string, string>>()

getset

Optional map containing tier names and their respective attribute group limits.

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.

Definition at line 150 of file AlterResourceGroup.cs.

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

_build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/AlterResourceGroup.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AlterResourceGroupRequest() [1/4]

◆ AlterResourceGroupRequest() [2/4]

◆ AlterResourceGroupRequest() [3/4]

◆ AlterResourceGroupRequest() [4/4]

Property Documentation

◆ adjoining_resource_group

◆ name

◆ options

◆ ranking

◆ tier_attributes