showResourceGroups - Kinetica Docs

◆ showResourceGroups() [1/4]

ShowResourceGroupsResponse gpudb::GPUdb::showResourceGroups ( const ShowResourceGroupsRequest & request_ ) const

Requests resource group properties.

Returns detailed information about the requested resource groups.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns

Response object containing the result of the operation.

ShowResourceGroupsResponse & gpudb::GPUdb::showResourceGroups	(	const ShowResourceGroupsRequest &	request_,
		ShowResourceGroupsResponse &	response_ ) const

Requests resource group properties.

Returns detailed information about the requested resource groups.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns

Response object containing the result of the operation (initially passed in by reference).

ShowResourceGroupsResponse gpudb::GPUdb::showResourceGroups	(	const std::vector< std::string > &	names,
		const std::map< std::string, std::string > &	options ) const

Requests resource group properties.

Returns detailed information about the requested resource groups.

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.

Returns

Response object containing the result of the operation.

ShowResourceGroupsResponse & gpudb::GPUdb::showResourceGroups	(	const std::vector< std::string > &	names,
		const std::map< std::string, std::string > &	options,
		ShowResourceGroupsResponse &	response_ ) const

Requests resource group properties.

Returns detailed information about the requested resource groups.

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.
[out]	response_	Response object containing the results of the operation.

Returns

Response object containing the result of the operation (initially passed in by reference).