gpudb::ShowResourceGroupsRequest Struct Reference

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

#include <gpudb/protocol/show_resource_groups.h>

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

Public Attributes
std::vector< std::string >	names
	List of names of groups to be shown. More...
std::map< std::string, std::string >	options
	Optional parameters. More...

Detailed Description

A set of parameters for GPUdb::showResourceGroups.

Requests resource group properties. Returns detailed information about the requested resource groups.

Definition at line 19 of file show_resource_groups.h.

Constructor & Destructor Documentation

ShowResourceGroupsRequest() [1/2]

gpudb::ShowResourceGroupsRequest::ShowResourceGroupsRequest ( )

inline

Constructs a ShowResourceGroupsRequest object with default parameters.

Definition at line 25 of file show_resource_groups.h.

ShowResourceGroupsRequest() [2/2]

gpudb::ShowResourceGroupsRequest::ShowResourceGroupsRequest ( const std::vector< std::string > &  names_, const std::map< std::string, std::string > &  options_  )

inline

Constructs a ShowResourceGroupsRequest object with the specified parameters.

Parameters

[in]	names_	List of names of groups to be shown. A single entry with an empty string returns all groups.
[in]	options_	Optional parameters. show_resource_groups_show_default_values: If true include values of fields that are based on the default resource group. Supported values: show_resource_groups_true show_resource_groups_false The default value is show_resource_groups_true. show_resource_groups_show_default_group: If true include the default and system resource groups in the response. This value defaults to false if an explicit list of group names is provided, and true otherwise. Supported values: show_resource_groups_true show_resource_groups_false The default value is show_resource_groups_true. show_resource_groups_show_tier_usage: If true include the resource group usage on the worker ranks in the response. Supported values: show_resource_groups_true show_resource_groups_false The default value is show_resource_groups_false. The default value is an empty map.

Definition at line 102 of file show_resource_groups.h.

Member Data Documentation

names

std::vector<std::string> gpudb::ShowResourceGroupsRequest::names

List of names of groups to be shown.

A single entry with an empty string returns all groups.

Definition at line 112 of file show_resource_groups.h.

options

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

Optional parameters.

• show_resource_groups_show_default_values: If true include values of fields that are based on the default resource group. Supported values:
  • show_resource_groups_true
  • show_resource_groups_false
  The default value is show_resource_groups_true.
• show_resource_groups_show_default_group: If true include the default and system resource groups in the response. This value defaults to false if an explicit list of group names is provided, and true otherwise. Supported values:
  • show_resource_groups_true
  • show_resource_groups_false
  The default value is show_resource_groups_true.
• show_resource_groups_show_tier_usage: If true include the resource group usage on the worker ranks in the response. Supported values:
  • show_resource_groups_true
  • show_resource_groups_false
  The default value is show_resource_groups_false.

The default value is an empty map.

Definition at line 161 of file show_resource_groups.h.

---

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

• gpudb/protocol/show_resource_groups.h