A set of parameters for Kinetica.alterResourceGroup(string,IDictionary{string, IDictionary{string, string}},string,string,IDictionary{string, string}). More...

Inheritance diagram for kinetica.AlterResourceGroupRequest:

Collaboration diagram for kinetica.AlterResourceGroupRequest:

Classes
struct	Options
	Optional parameters. More...

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

struct	TierAttributes
	Optional map containing tier names and their respective attribute group limits. 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 `[get, set]`
	Optional map containing tier names and their respective attribute group limits. More...

string	ranking = new Dictionary<string, IDictionary<string, 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 = Ranking.EMPTY_STRING `[get, set]`
	If 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 = "" `[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(string,IDictionary{string, IDictionary{string, string}},string,string,IDictionary{string, string}).

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

Definition at line 20 of file AlterResourceGroup.cs.

Constructor & Destructor Documentation

kinetica.AlterResourceGroupRequest.AlterResourceGroupRequest ( )

inline

Constructs an AlterResourceGroupRequest object with default parameters.

Definition at line 288 of file AlterResourceGroup.cs.

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.
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. 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 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 . Supported values: EMPTY_STRING FIRST LAST BEFORE AFTER The default value is EMPTY_STRING.
adjoining_resource_group	If 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. MAX_SCHEDULING_PRIORITY: Maximum priority of a scheduled task for this group. MAX_TIER_PRIORITY: Maximum priority of a tiered object for this group. 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 field is also populated. Supported values: TRUE FALSE The default value is FALSE. The default value is an empty Dictionary.

Definition at line 393 of file AlterResourceGroup.cs.

Property Documentation

string kinetica.AlterResourceGroupRequest.adjoining_resource_group = Ranking.EMPTY_STRING

getset

If 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 238 of file AlterResourceGroup.cs.

string kinetica.AlterResourceGroupRequest.name

getset

Name of the group to be altered.

Must be an existing resource group name.

Definition at line 179 of file AlterResourceGroup.cs.

IDictionary<string, string> kinetica.AlterResourceGroupRequest.options = ""

getset

Optional parameters.

MAX_CPU_CONCURRENCY: Maximum number of simultaneous threads that will be used to execute a request for this group.
MAX_SCHEDULING_PRIORITY: Maximum priority of a scheduled task for this group.
MAX_TIER_PRIORITY: Maximum priority of a tiered object for this group.
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 field is also populated. Supported values:
- TRUE
- FALSE
The default value is FALSE.

The default value is an empty Dictionary.

Definition at line 283 of file AlterResourceGroup.cs.

string kinetica.AlterResourceGroupRequest.ranking = new Dictionary<string, IDictionary<string, 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 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 . Supported values:

The default value is EMPTY_STRING.

Definition at line 232 of file AlterResourceGroup.cs.

IDictionary<string, IDictionary<string, string> > kinetica.AlterResourceGroupRequest.tier_attributes

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

The default value is an empty Dictionary.

Definition at line 197 of file AlterResourceGroup.cs.

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

Kinetica/Protocol/AlterResourceGroup.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Property Documentation