kinetica.ShowResourceObjectsRequest Class Reference
A set of parameters for Kinetica.showResourceObjects. More...
Inheritance diagram for kinetica.ShowResourceObjectsRequest:
Collaboration diagram for kinetica.ShowResourceObjectsRequest:
Classes | |
| struct | Options |
| A set of string constants for the parameter options. More... | |
Public Member Functions | |
| ShowResourceObjectsRequest () | |
| Constructs a ShowResourceObjectsRequest object with default parameters. More... | |
| ShowResourceObjectsRequest (IDictionary< string, string > options=null) | |
| Constructs a ShowResourceObjectsRequest object with the specified parameters. More... | |
| ShowResourceObjectsRequest () | |
| Constructs a ShowResourceObjectsRequest object with default parameters. More... | |
| ShowResourceObjectsRequest (IDictionary< string, string > options=null) | |
| Constructs a ShowResourceObjectsRequest 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... | |
| 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 | |
| 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... | |
| Properties inherited from Avro.Specific.ISpecificRecord | |
| Schema | Schema [get] |
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... | |
| 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.showResourceObjects.
Returns information about the internal sub-components (tiered objects) which use resources of the system. The request can either return results from actively used objects (default) or it can be used to query the status of the objects of a given list of tables. Returns detailed information about the requested resource objects.
Definition at line 20 of file ShowResourceObjects.cs.
Constructor & Destructor Documentation
◆ ShowResourceObjectsRequest() [1/4]
|
inline |
Constructs a ShowResourceObjectsRequest object with default parameters.
Definition at line 166 of file ShowResourceObjects.cs.
◆ ShowResourceObjectsRequest() [2/4]
|
inline |
Constructs a ShowResourceObjectsRequest object with the specified parameters.
- Parameters
-
options Optional parameters. - TIERS: Comma-separated list of tiers to query, leave blank for all tiers.
- EXPRESSION: An expression to filter the returned objects. Expression is limited to the following operators: =,!=,<,<=,>,>=,+,-,*,AND,OR,LIKE. For details see Expressions. To use a more complex expression, query the ki_catalog.ki_tiered_objects table directly.
- ORDER_BY: Single column to be sorted by as well as the sort direction, e.g., 'size asc'. Supported values:
- LIMIT: An integer indicating the maximum number of results to be returned, per rank, or (-1) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. The default value is '100'.
- TABLE_NAMES: Comma-separated list of tables to restrict the results to. Use '*' to show all tables.
Definition at line 239 of file ShowResourceObjects.cs.
◆ ShowResourceObjectsRequest() [3/4]
|
inline |
Constructs a ShowResourceObjectsRequest object with default parameters.
Definition at line 166 of file ShowResourceObjects.cs.
◆ ShowResourceObjectsRequest() [4/4]
|
inline |
Constructs a ShowResourceObjectsRequest object with the specified parameters.
- Parameters
-
options Optional parameters. - TIERS: Comma-separated list of tiers to query, leave blank for all tiers.
- EXPRESSION: An expression to filter the returned objects. Expression is limited to the following operators: =,!=,<,<=,>,>=,+,-,*,AND,OR,LIKE. For details see Expressions. To use a more complex expression, query the ki_catalog.ki_tiered_objects table directly.
- ORDER_BY: Single column to be sorted by as well as the sort direction, e.g., 'size asc'. Supported values:
- LIMIT: An integer indicating the maximum number of results to be returned, per rank, or (-1) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. The default value is '100'.
- TABLE_NAMES: Comma-separated list of tables to restrict the results to. Use '*' to show all tables.
Definition at line 239 of file ShowResourceObjects.cs.
Property Documentation
◆ options
|
getset |
Optional parameters.
- TIERS: Comma-separated list of tiers to query, leave blank for all tiers.
- EXPRESSION: An expression to filter the returned objects. Expression is limited to the following operators: =,!=,<,<=,>,>=,+,-,*,AND,OR,LIKE. For details see Expressions. To use a more complex expression, query the ki_catalog.ki_tiered_objects table directly.
- ORDER_BY: Single column to be sorted by as well as the sort direction, e.g., 'size asc'. Supported values:
- LIMIT: An integer indicating the maximum number of results to be returned, per rank, or (-1) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. The default value is '100'.
- TABLE_NAMES: Comma-separated list of tables to restrict the results to. Use '*' to show all tables.
The default value is an empty Dictionary.
Definition at line 162 of file ShowResourceObjects.cs.
The documentation for this class was generated from the following file:
- _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/ShowResourceObjects.cs
