gpudb::AlterResourceGroupRequest Struct Reference

A set of input parameters for const. More...

#include <gpudb/protocol/alter_resource_group.h>

Public Member Functions
	AlterResourceGroupRequest ()
	Constructs an AlterResourceGroupRequest object with default parameter values. More...
	AlterResourceGroupRequest (const std::string &name_, const std::map< std::string, std::map< std::string, std::string > > &tierAttributes_, const std::string &ranking_, const std::string &adjoiningResourceGroup_, const std::map< std::string, std::string > &options_)
	Constructs an AlterResourceGroupRequest object with the specified parameters. More...

Public Attributes
std::string	name
std::map< std::string, std::map< std::string, std::string > >	tierAttributes
std::string	ranking
std::string	adjoiningResourceGroup
std::map< std::string, std::string >	options

Detailed Description

A set of input parameters for const.

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

Definition at line 19 of file alter_resource_group.h.

Constructor & Destructor Documentation

gpudb::AlterResourceGroupRequest::AlterResourceGroupRequest ( )

inline

Constructs an AlterResourceGroupRequest object with default parameter values.

Definition at line 26 of file alter_resource_group.h.

gpudb::AlterResourceGroupRequest::AlterResourceGroupRequest ( const std::string &  name_, const std::map< std::string, std::map< std::string, std::string > > &  tierAttributes_, const std::string &  ranking_, const std::string &  adjoiningResourceGroup_, const std::map< std::string, std::string > &  options_  )

inline

Constructs an AlterResourceGroupRequest object with the specified parameters.

Parameters

[in]	name_	Name of the group to be altered. Must be an existing resource group name.
[in]	tierAttributes_	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'}} gpudb::alter_resource_group_max_memory: Maximum amount of memory usable in the given tier at one time for this group.
[in]	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 adjoiningResourceGroup. gpudb::alter_resource_group_empty_string gpudb::alter_resource_group_first gpudb::alter_resource_group_last gpudb::alter_resource_group_before gpudb::alter_resource_group_after The default value is gpudb::alter_resource_group_empty_string.
[in]	adjoiningResourceGroup_	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.
[in]	options_	Optional parameters. gpudb::alter_resource_group_max_cpu_concurrency: Maximum number of simultaneous threads that will be used to execute a request for this group. gpudb::alter_resource_group_max_scheduling_priority: Maximum priority of a scheduled task for this group. gpudb::alter_resource_group_max_tier_priority: Maximum priority of a tiered object for this group. gpudb::alter_resource_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 name field is also populated. gpudb::alter_resource_group_true gpudb::alter_resource_group_false The default value is gpudb::alter_resource_group_false.

Definition at line 110 of file alter_resource_group.h.

Member Data Documentation

std::string gpudb::AlterResourceGroupRequest::adjoiningResourceGroup

Definition at line 122 of file alter_resource_group.h.

std::string gpudb::AlterResourceGroupRequest::name

Definition at line 119 of file alter_resource_group.h.

std::map<std::string, std::string> gpudb::AlterResourceGroupRequest::options

Definition at line 123 of file alter_resource_group.h.

std::string gpudb::AlterResourceGroupRequest::ranking

Definition at line 121 of file alter_resource_group.h.

std::map<std::string, std::map<std::string, std::string> > gpudb::AlterResourceGroupRequest::tierAttributes

Definition at line 120 of file alter_resource_group.h.

---

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

• gpudb/protocol/alter_resource_group.h