A set of parameters for GPUdb::createResourceGroup. More...

#include <gpudb/protocol/create_resource_group.h>

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

	CreateResourceGroupRequest (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 a CreateResourceGroupRequest object with the specified parameters. More...

Public Attributes
std::string	name
	Name of the group to be created. More...

std::map< std::string, std::map< std::string, std::string > >	tierAttributes
	Optional map containing tier names and their respective attribute group limits. More...

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

std::string	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. More...

std::map< std::string, std::string >	options
	Optional parameters. More...

Detailed Description

A set of parameters for GPUdb::createResourceGroup.

Creates a new resource group to facilitate resource management.

Definition at line 18 of file create_resource_group.h.

Constructor & Destructor Documentation

◆ CreateResourceGroupRequest() [1/2]

gpudb::CreateResourceGroupRequest::CreateResourceGroupRequest ( )

inline

Constructs a CreateResourceGroupRequest object with default parameters.

Definition at line 24 of file create_resource_group.h.

◆ CreateResourceGroupRequest() [2/2]

gpudb::CreateResourceGroupRequest::CreateResourceGroupRequest	(	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 a CreateResourceGroupRequest object with the specified parameters.

Parameters

[in]	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.
[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'}}. create_resource_group_max_memory: Maximum amount of memory usable in the given tier at one time for this group. The default value is an empty map.
[in]	ranking_	Indicates the relative ranking among existing resource groups where this new resource group will be placed. When using before or after, specify which resource group this one will be inserted before or after in adjoiningResourceGroup_. Supported values: create_resource_group_first create_resource_group_last create_resource_group_before create_resource_group_after
[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. The default value is ''.
[in]	options_	Optional parameters. create_resource_group_max_cpu_concurrency: Maximum number of simultaneous threads that will be used to execute a request for this group. The minimum allowed value is '4'. create_resource_group_max_data: Maximum amount of cumulative ram usage regardless of tier status for this group. The minimum allowed value is '-1'. create_resource_group_max_scheduling_priority: Maximum priority of a scheduled task for this group. The minimum allowed value is '1'. The maximum allowed value is '100'. create_resource_group_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 map.

Definition at line 121 of file create_resource_group.h.

Member Data Documentation

◆ adjoiningResourceGroup

std::string gpudb::CreateResourceGroupRequest::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.

The default value is ''.

Definition at line 181 of file create_resource_group.h.

◆ name

std::string gpudb::CreateResourceGroupRequest::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.

Definition at line 135 of file create_resource_group.h.

◆ options

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

Optional parameters.

create_resource_group_max_cpu_concurrency: Maximum number of simultaneous threads that will be used to execute a request for this group. The minimum allowed value is '4'.
create_resource_group_max_data: Maximum amount of cumulative ram usage regardless of tier status for this group. The minimum allowed value is '-1'.
create_resource_group_max_scheduling_priority: Maximum priority of a scheduled task for this group. The minimum allowed value is '1'. The maximum allowed value is '100'.
create_resource_group_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 map.

Definition at line 205 of file create_resource_group.h.

◆ ranking

std::string gpudb::CreateResourceGroupRequest::ranking

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

When using before or after, specify which resource group this one will be inserted before or after in adjoiningResourceGroup. Supported values:

Definition at line 173 of file create_resource_group.h.

◆ tierAttributes

std::map<std::string, std::map<std::string, std::string> > gpudb::CreateResourceGroupRequest::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'}}.

create_resource_group_max_memory: Maximum amount of memory usable in the given tier at one time for this group.