Skip to main content

◆ showResourceGroups() [1/2]

ShowResourceGroupsResponse kinetica.Kinetica.showResourceGroups (IList< string >names,
IDictionary< string, string >options = null )
inline

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

Parameters
namesList of names of groups to be shown. A single entry with an empty string returns all groups.
optionsOptional parameters.
  • SHOW_DEFAULT_VALUES: If TRUE include values of fields that are based on the default resource group. Supported values:The default value is TRUE.
  • 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:The default value is TRUE.
  • SHOW_TIER_USAGE: If TRUE include the resource group usage on the worker ranks in the response. Supported values:The default value is FALSE.
The default value is an empty Dictionary.
Returns
Response object containing the result of the operation.

Definition at line 61172 of file KineticaFunctions.cs.

◆ showResourceGroups() [2/2]

ShowResourceGroupsResponse kinetica.Kinetica.showResourceGroups (ShowResourceGroupsRequestrequest_)
inline

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

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 61061 of file KineticaFunctions.cs.

◆ ShowResourceGroupsAsync() [1/2]

async System.Threading.Tasks.Task< ShowResourceGroupsResponse > kinetica.Kinetica.ShowResourceGroupsAsync (IList< string >names,
IDictionary< string, string >options = null,
System.Threading.CancellationTokencancellationToken = default )
inline

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

(async)

Parameters
namesList of names of groups to be shown. A single entry with an empty string returns all groups.
optionsOptional parameters.
  • SHOW_DEFAULT_VALUES: If TRUE include values of fields that are based on the default resource group. Supported values:The default value is TRUE.
  • 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:The default value is TRUE.
  • SHOW_TIER_USAGE: If TRUE include the resource group usage on the worker ranks in the response. Supported values:The default value is FALSE.
The default value is an empty Dictionary.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 61267 of file KineticaFunctions.cs.

◆ ShowResourceGroupsAsync() [2/2]

async System.Threading.Tasks.Task< ShowResourceGroupsResponse > kinetica.Kinetica.ShowResourceGroupsAsync (ShowResourceGroupsRequestrequest_,
System.Threading.CancellationTokencancellationToken = default )
inline

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

(async)

Parameters
request_Request object containing the parameters for the operation.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 61077 of file KineticaFunctions.cs.