GPUdb C++ API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
gpudb::CreateResourceGroupRequest Struct Reference

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

#include <gpudb/protocol/create_resource_group.h>

Public Member Functions

 CreateResourceGroupRequest ()
 Constructs a CreateResourceGroupRequest object with default parameter values. 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
 
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.

Creates a new resource group to facilitate resource management.

Definition at line 18 of file create_resource_group.h.

Constructor & Destructor Documentation

gpudb::CreateResourceGroupRequest::CreateResourceGroupRequest ( )
inline

Constructs a CreateResourceGroupRequest object with default parameter values.

Definition at line 25 of file create_resource_group.h.

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'}}
[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.
[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.

Definition at line 94 of file create_resource_group.h.

Member Data Documentation

std::string gpudb::CreateResourceGroupRequest::adjoiningResourceGroup

Definition at line 106 of file create_resource_group.h.

std::string gpudb::CreateResourceGroupRequest::name

Definition at line 103 of file create_resource_group.h.

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

Definition at line 107 of file create_resource_group.h.

std::string gpudb::CreateResourceGroupRequest::ranking

Definition at line 105 of file create_resource_group.h.

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

Definition at line 104 of file create_resource_group.h.


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