kinetica.CreateResourceGroupRequest

A set of parameters for Kinetica.createResourceGroup. More…

Inheritance diagram for kinetica.CreateResourceGroupRequest:

Collaboration diagram for kinetica.CreateResourceGroupRequest:

Classes
struct	Options
	A set of string constants for the parameter CreateResourceGroupRequest.options. More…

struct	Ranking
	A set of string constants for the parameter CreateResourceGroupRequest.ranking. More…

struct	TierAttributes
	A set of string constants for the parameter CreateResourceGroupRequest.tier_attributes. More…

Public Member Functions
	CreateResourceGroupRequest ()
	Constructs a CreateResourceGroupRequest object with default parameters.

	CreateResourceGroupRequest (string name, IDictionary< string, IDictionary< string, string > > tier_attributes, string ranking, string adjoining_resource_group=null, IDictionary< string, string > options=null)
	Constructs a CreateResourceGroupRequest object with the specified parameters.

	CreateResourceGroupRequest ()
	Constructs a CreateResourceGroupRequest object with default parameters.

	CreateResourceGroupRequest (string name, IDictionary< string, IDictionary< string, string > > tier_attributes, string ranking, string adjoining_resource_group=null, IDictionary< string, string > options=null)
	Constructs a CreateResourceGroupRequest object with the specified parameters.

Public Member Functions inherited from kinetica.KineticaData
	KineticaData (KineticaType type)
	Constructor from Kinetica Type.

	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type.

object	Get (int fieldPos)
	Retrieve a specific property from this object.

void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object.

	KineticaData (KineticaType type)
	Constructor from Kinetica Type.

	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type.

object	Get (int fieldPos)
	Retrieve a specific property from this object.

void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object.

Properties
string	name `[get, set]`
	Name of the group to be created.

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.

string	ranking `[get, set]`
	Indicates the relative ranking among existing resource groups where this new resource group will be placed.

string	adjoining_resource_group = "" `[get, set]`
	If CreateResourceGroupRequest.ranking is BEFORE or AFTER, this field indicates the resource group before or after which the current group will be placed; otherwise, leave blank.

IDictionary< string, string >	options = new Dictionary<string, string>() `[get, set]`
	Optional parameters.

Properties inherited from kinetica.KineticaData
Schema	Schema `[get]`
	Avro Schema for this class.

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.

static ? RecordSchema	SchemaFromType (System.Type t, KineticaType? ktype=null)
	Create an Avro Schema from a System.Type and a KineticaType.

Detailed Description

A set of parameters for Kinetica.createResourceGroup.

Creates a new resource group to facilitate resource management.

Definition at line 16 of file CreateResourceGroup.cs.

Constructor & Destructor Documentation

◆ CreateResourceGroupRequest() [1/4]

kinetica.CreateResourceGroupRequest.CreateResourceGroupRequest ( )

inline

Constructs a CreateResourceGroupRequest object with default parameters.

Definition at line 204 of file CreateResourceGroup.cs.

◆ CreateResourceGroupRequest() [2/4]

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

inline

Constructs a CreateResourceGroupRequest object with the specified parameters.

Parameters

name	Name of the group to be created. Must contain only letters, digits, and underscores, and cannot begin with a digit. Must not match existing resource group name.
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 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.
ranking	Indicates the relative ranking among existing resource groups where this new resource group will be placed. Supported values: 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.
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’. The default value is an empty Dictionary.

Definition at line 309 of file CreateResourceGroup.cs.

◆ CreateResourceGroupRequest() [3/4]

kinetica.CreateResourceGroupRequest.CreateResourceGroupRequest ( )

inline

Constructs a CreateResourceGroupRequest object with default parameters.

Definition at line 204 of file CreateResourceGroup.cs.

◆ CreateResourceGroupRequest() [4/4]

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

inline

Constructs a CreateResourceGroupRequest object with the specified parameters.

Parameters

name	Name of the group to be created. Must contain only letters, digits, and underscores, and cannot begin with a digit. Must not match existing resource group name.
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 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.
ranking	Indicates the relative ranking among existing resource groups where this new resource group will be placed. Supported values: 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.
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’. The default value is an empty Dictionary.

Definition at line 309 of file CreateResourceGroup.cs.

Property Documentation

◆ adjoining_resource_group

string kinetica.CreateResourceGroupRequest.adjoining_resource_group = ""

getset

If CreateResourceGroupRequest.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 161 of file CreateResourceGroup.cs.

◆ name

string kinetica.CreateResourceGroupRequest.name

getset

Name of the group to be created.

Must contain only letters, digits, and underscores, and cannot begin with a digit. Must not match existing resource group name.

Definition at line 93 of file CreateResourceGroup.cs.

◆ options

IDictionary< string, string > kinetica.CreateResourceGroupRequest.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’.

The default value is an empty Dictionary.

Definition at line 200 of file CreateResourceGroup.cs.

◆ ranking

string kinetica.CreateResourceGroupRequest.ranking

getset

Indicates the relative ranking among existing resource groups where this new resource group will be placed.

Supported values:

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 CreateResourceGroupRequest.adjoining_resource_group in the ordering.
AFTER: Place this resource group after the one specified by CreateResourceGroupRequest.adjoining_resource_group in the ordering.

Definition at line 153 of file CreateResourceGroup.cs.

◆ tier_attributes

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

getset

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

Definition at line 114 of file CreateResourceGroup.cs.

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

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

​ Classes

​ Public Member Functions

​ Properties

​ Additional Inherited Members

​Detailed Description

​Constructor & Destructor Documentation

​◆ CreateResourceGroupRequest() [1/4]

​◆ CreateResourceGroupRequest() [2/4]

​◆ CreateResourceGroupRequest() [3/4]

​◆ CreateResourceGroupRequest() [4/4]

​Property Documentation

​◆ adjoining_resource_group

​◆ name

​◆ options

​◆ ranking

​◆ tier_attributes

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CreateResourceGroupRequest() [1/4]

◆ CreateResourceGroupRequest() [2/4]

◆ CreateResourceGroupRequest() [3/4]

◆ CreateResourceGroupRequest() [4/4]

Property Documentation

◆ adjoining_resource_group

◆ name

◆ options

◆ ranking

◆ tier_attributes