gpudb::DeleteResourceGroupRequest Struct Reference

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

#include <gpudb/protocol/delete_resource_group.h>

Public Member Functions
	DeleteResourceGroupRequest ()
	Constructs a DeleteResourceGroupRequest object with default parameters. More...
	DeleteResourceGroupRequest (const std::string &name_, const std::map< std::string, std::string > &options_)
	Constructs a DeleteResourceGroupRequest object with the specified parameters. More...

Public Attributes
std::string	name
	Name of the resource group to be deleted. More...
std::map< std::string, std::string >	options
	Optional parameters. More...

Detailed Description

A set of parameters for GPUdb::deleteResourceGroup.

Deletes a resource group.

Definition at line 18 of file delete_resource_group.h.

Constructor & Destructor Documentation

DeleteResourceGroupRequest() [1/2]

gpudb::DeleteResourceGroupRequest::DeleteResourceGroupRequest ( )

inline

Constructs a DeleteResourceGroupRequest object with default parameters.

Definition at line 24 of file delete_resource_group.h.

DeleteResourceGroupRequest() [2/2]

gpudb::DeleteResourceGroupRequest::DeleteResourceGroupRequest ( const std::string &  name_, const std::map< std::string, std::string > &  options_  )

inline

Constructs a DeleteResourceGroupRequest object with the specified parameters.

Parameters

[in]	name_	Name of the resource group to be deleted.
[in]	options_	Optional parameters. delete_resource_group_cascade_delete: If true, delete any existing entities owned by this group. Otherwise this request will return an error of any such entities exist. Supported values: delete_resource_group_true delete_resource_group_false The default value is delete_resource_group_false. The default value is an empty map.

Definition at line 61 of file delete_resource_group.h.

Member Data Documentation

name

std::string gpudb::DeleteResourceGroupRequest::name

Name of the resource group to be deleted.

Definition at line 70 of file delete_resource_group.h.

options

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

Optional parameters.

• delete_resource_group_cascade_delete: If true, delete any existing entities owned by this group. Otherwise this request will return an error of any such entities exist. Supported values:
  • delete_resource_group_true
  • delete_resource_group_false
  The default value is delete_resource_group_false.

The default value is an empty map.

Definition at line 92 of file delete_resource_group.h.

---

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

• gpudb/protocol/delete_resource_group.h