> ## Documentation Index > Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt > Use this file to discover all available pages before exploring further. # kinetica.CreateResourceGroupRequest > kinetica.CreateResourceGroupRequest — Kinetica C# API

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\>() \[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\() \[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\()
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:

Definition at line 153 of file CreateResourceGroup.cs.

◆ tier\_attributes

IDictionary\< string, IDictionary\< string, string > > kinetica.CreateResourceGroupRequest.tier\_attributes = new Dictionary\>()
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: