kinetica.ShowResourceGroupsRequest Class Reference
A set of parameters for Kinetica.showResourceGroups. More...
Inheritance diagram for kinetica.ShowResourceGroupsRequest:
Collaboration diagram for kinetica.ShowResourceGroupsRequest:
Classes | |
| struct | Options |
| A set of string constants for the parameter options. More... | |
Public Member Functions | |
| ShowResourceGroupsRequest () | |
| Constructs a ShowResourceGroupsRequest object with default parameters. More... | |
| ShowResourceGroupsRequest (IList< string > names, IDictionary< string, string > options=null) | |
| Constructs a ShowResourceGroupsRequest object with the specified parameters. More... | |
| Public Member Functions inherited from kinetica.KineticaData | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type More... | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type More... | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object More... | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object More... | |
Properties | |
| IList< string > | names = new List<string>() [get, set] |
| List of names of groups to be shown. More... | |
| IDictionary< string, string > | options = new Dictionary<string, string>() [get, set] |
| Optional parameters. More... | |
| Properties inherited from kinetica.KineticaData | |
| Schema | Schema [get] |
| Avro Schema for this class More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from kinetica.KineticaData | |
| static ? RecordSchema | SchemaFromType (System.Type t, KineticaType? ktype=null) |
| Create an Avro Schema from a System.Type and a KineticaType. More... | |
Detailed Description
A set of parameters for Kinetica.showResourceGroups.
Requests resource group properties. Returns detailed information about the requested resource groups.
Definition at line 17 of file ShowResourceGroups.cs.
Constructor & Destructor Documentation
◆ ShowResourceGroupsRequest() [1/2]
|
inline |
Constructs a ShowResourceGroupsRequest object with default parameters.
Definition at line 146 of file ShowResourceGroups.cs.
◆ ShowResourceGroupsRequest() [2/2]
|
inline |
Constructs a ShowResourceGroupsRequest object with the specified parameters.
- Parameters
-
names List of names of groups to be shown. A single entry with an empty string returns all groups. options 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.
Definition at line 215 of file ShowResourceGroups.cs.
Property Documentation
◆ names
|
getset |
List of names of groups to be shown.
A single entry with an empty string returns all groups.
Definition at line 78 of file ShowResourceGroups.cs.
◆ options
|
getset |
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.
Definition at line 142 of file ShowResourceGroups.cs.
The documentation for this class was generated from the following file:
- Kinetica/Protocol/ShowResourceGroups.cs
