kinetica.ShowResourceObjectsRequest.Options Struct Reference

Optional parameters. More...

Public Attributes
const string	TIERS = "tiers"
	Comma-separated list of tiers to query, leave blank for all tiers. More...
const string	EXPRESSION = "expression"
	An expression to filter the returned objects. More...
const string	ORDER_BY = "order_by"
	Single column to be sorted by as well as the sort direction, e.g., 'size asc'. More...
const string	SIZE = "size"
const string	ID = "id"
const string	PRIORITY = "priority"
const string	TIER = "tier"
const string	EVICTABLE = "evictable"
const string	OWNER_RESOURCE_GROUP = "owner_resource_group"
const string	LIMIT = "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. More...
const string	TABLE_NAMES = "table_names"
	Comma-separated list of tables to restrict the results to. More...

Detailed Description

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:
  • SIZE
  • ID
  • PRIORITY
  • TIER
  • EVICTABLE
  • OWNER_RESOURCE_GROUP
• 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. A set of string constants for the parameter options.

Definition at line 104 of file ShowResourceObjects.cs.

Member Data Documentation

const string kinetica.ShowResourceObjectsRequest.Options.EVICTABLE = "evictable"

Definition at line 155 of file ShowResourceObjects.cs.

const string kinetica.ShowResourceObjectsRequest.Options.EXPRESSION = "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.

Definition at line 119 of file ShowResourceObjects.cs.

const string kinetica.ShowResourceObjectsRequest.Options.ID = "id"

Definition at line 152 of file ShowResourceObjects.cs.

const string kinetica.ShowResourceObjectsRequest.Options.LIMIT = "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'.

Definition at line 167 of file ShowResourceObjects.cs.

const string kinetica.ShowResourceObjectsRequest.Options.ORDER_BY = "order_by"

Single column to be sorted by as well as the sort direction, e.g., 'size asc'.

Supported values:

• SIZE
• ID
• PRIORITY
• TIER
• EVICTABLE
• OWNER_RESOURCE_GROUP

Definition at line 150 of file ShowResourceObjects.cs.

const string kinetica.ShowResourceObjectsRequest.Options.OWNER_RESOURCE_GROUP = "owner_resource_group"

Definition at line 156 of file ShowResourceObjects.cs.

const string kinetica.ShowResourceObjectsRequest.Options.PRIORITY = "priority"

Definition at line 153 of file ShowResourceObjects.cs.

const string kinetica.ShowResourceObjectsRequest.Options.SIZE = "size"

Definition at line 151 of file ShowResourceObjects.cs.

const string kinetica.ShowResourceObjectsRequest.Options.TABLE_NAMES = "table_names"

Comma-separated list of tables to restrict the results to.

Use '*' to show all tables.

Definition at line 171 of file ShowResourceObjects.cs.

const string kinetica.ShowResourceObjectsRequest.Options.TIER = "tier"

Definition at line 154 of file ShowResourceObjects.cs.

const string kinetica.ShowResourceObjectsRequest.Options.TIERS = "tiers"

Comma-separated list of tiers to query, leave blank for all tiers.

Definition at line 109 of file ShowResourceObjects.cs.

---

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

• Kinetica/Protocol/ShowResourceObjects.cs