com.gpudb.protocol

Class ShowResourceObjectsRequest

java.lang.Object

com.gpudb.protocol.ShowResourceObjectsRequest

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord

public class ShowResourceObjectsRequest
extends Object
implements org.apache.avro.generic.IndexedRecord

A set of parameters for GPUdb.showResourceObjects(ShowResourceObjectsRequest).

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ShowResourceObjectsRequest.Options Optional parameters.

Constructor Summary

Constructors

Constructor and Description
ShowResourceObjectsRequest() Constructs a ShowResourceObjectsRequest object with default parameters.
ShowResourceObjectsRequest(Map<String,String> options) Constructs a ShowResourceObjectsRequest object with the specified parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Object	get(int index) This method supports the Avro framework and is not intended to be called directly by the user.
static org.apache.avro.Schema	getClassSchema() This method supports the Avro framework and is not intended to be called directly by the user.
Map<String,String>	getOptions()
org.apache.avro.Schema	getSchema() This method supports the Avro framework and is not intended to be called directly by the user.
int	hashCode()
void	put(int index, Object value) This method supports the Avro framework and is not intended to be called directly by the user.
ShowResourceObjectsRequest	setOptions(Map<String,String> options)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ShowResourceObjectsRequest

public ShowResourceObjectsRequest()

Constructs a ShowResourceObjectsRequest object with default parameters.

ShowResourceObjectsRequest

public ShowResourceObjectsRequest(Map<String,String> options)

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:
  • 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 Map.

Method Detail

getClassSchema

public static org.apache.avro.Schema getClassSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

Returns:

the schema for the class.

getOptions

public Map<String,String> getOptions()

Returns:

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 Map.

setOptions

public ShowResourceObjectsRequest setOptions(Map<String,String> options)

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:
  • 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 Map.

Returns:

this to mimic the builder pattern.

getSchema

public org.apache.avro.Schema getSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

getSchema in interface org.apache.avro.generic.GenericContainer

Returns:

the schema object describing this class.

get

public Object get(int index)

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

get in interface org.apache.avro.generic.IndexedRecord

Parameters:

index - the position of the field to get

Returns:

value of the field with the given index.

Throws:

IndexOutOfBoundsException

put

public void put(int index,
                Object value)

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

put in interface org.apache.avro.generic.IndexedRecord

Parameters:

index - the position of the field to set

value - the value to set

Throws:

IndexOutOfBoundsException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object