Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
kinetica.ShowResourceGroupsRequest.Options Struct Reference

Optional parameters. More...

Public Attributes

const string SHOW_DEFAULT_VALUES = "show_default_values"
 If true include values of fields that are based on the default resource group. More...
 
const string TRUE = "true"
 
const string FALSE = "false"
 
const string SHOW_DEFAULT_GROUP = "show_default_group"
 If true include the default and system resource groups in the response. More...
 
const string SHOW_TIER_USAGE = "show_tier_usage"
 If true include the resource group usage on the worker ranks in the response. More...
 

Detailed Description

Optional 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. A set of string constants for the parameter options.

Definition at line 88 of file ShowResourceGroups.cs.

Member Data Documentation

const string kinetica.ShowResourceGroupsRequest.Options.FALSE = "false"

Definition at line 108 of file ShowResourceGroups.cs.

const string kinetica.ShowResourceGroupsRequest.Options.SHOW_DEFAULT_GROUP = "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.

Definition at line 126 of file ShowResourceGroups.cs.

const string kinetica.ShowResourceGroupsRequest.Options.SHOW_DEFAULT_VALUES = "show_default_values"

If true include values of fields that are based on the default resource group.

Supported values:

The default value is TRUE.

Definition at line 106 of file ShowResourceGroups.cs.

const string kinetica.ShowResourceGroupsRequest.Options.SHOW_TIER_USAGE = "show_tier_usage"

If true include the resource group usage on the worker ranks in the response.

Supported values:

The default value is FALSE.

Definition at line 143 of file ShowResourceGroups.cs.

const string kinetica.ShowResourceGroupsRequest.Options.TRUE = "true"

Definition at line 107 of file ShowResourceGroups.cs.


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