Skip to main content

A set of parameters for Kinetica.showResourceObjects. More…

Inheritance diagram for kinetica.ShowResourceObjectsRequest:
[legend]
Collaboration diagram for kinetica.ShowResourceObjectsRequest:
[legend]

​
Classes

struct  Options
 A set of string constants for the parameter ShowResourceObjectsRequest.options. More…
 

​
Public Member Functions

 ShowResourceObjectsRequest ()
 Constructs a ShowResourceObjectsRequest object with default parameters.
 
 ShowResourceObjectsRequest (IDictionary< string, string > options=null)
 Constructs a ShowResourceObjectsRequest object with the specified parameters.
 
 ShowResourceObjectsRequest ()
 Constructs a ShowResourceObjectsRequest object with default parameters.
 
 ShowResourceObjectsRequest (IDictionary< string, string > options=null)
 Constructs a ShowResourceObjectsRequest object with the specified parameters.
 
 Public Member Functions inherited from kinetica.KineticaData
 KineticaData (KineticaType type)
 Constructor from Kinetica Type.
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type.
 
object Get (int fieldPos)
 Retrieve a specific property from this object.
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object.
 
 KineticaData (KineticaType type)
 Constructor from Kinetica Type.
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type.
 
object Get (int fieldPos)
 Retrieve a specific property from this object.
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object.
 

​
Properties

IDictionary< string, string > options = new Dictionary<string, string>() [get, set]
 Optional parameters.
 
 Properties inherited from kinetica.KineticaData
Schema Schema [get]
 Avro Schema for this class.
 

​
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.
 
static ? RecordSchema SchemaFromType (System.Type t, KineticaType? ktype=null)
 Create an Avro Schema from a System.Type and a KineticaType.
 

​
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]

kinetica.ShowResourceObjectsRequest.ShowResourceObjectsRequest ()
 inline

Constructs a ShowResourceObjectsRequest object with default parameters.

Definition at line 260 of file ShowResourceObjects.cs.

​
◆ ShowResourceObjectsRequest() [2/4]

kinetica.ShowResourceObjectsRequest.ShowResourceObjectsRequest (IDictionary< string, string >options = null)
 inline

Constructs a ShowResourceObjectsRequest object with the specified parameters.

Parameters
optionsOptional 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 368 of file ShowResourceObjects.cs.

​
◆ ShowResourceObjectsRequest() [3/4]

kinetica.ShowResourceObjectsRequest.ShowResourceObjectsRequest ()
 inline

Constructs a ShowResourceObjectsRequest object with default parameters.

Definition at line 260 of file ShowResourceObjects.cs.

​
◆ ShowResourceObjectsRequest() [4/4]

kinetica.ShowResourceObjectsRequest.ShowResourceObjectsRequest (IDictionary< string, string >options = null)
 inline

Constructs a ShowResourceObjectsRequest object with the specified parameters.

Parameters
optionsOptional 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 368 of file ShowResourceObjects.cs.

​
Property Documentation

​
◆ options

IDictionary< string, string > kinetica.ShowResourceObjectsRequest.options = new Dictionary<string, string>()
 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 256 of file ShowResourceObjects.cs.

The documentation for this class was generated from the following files: