Skip to main content
Package com.gpudb.protocol

​
Class ShowResourceGroupsRequest

java.lang.Object
com.gpudb.protocol.ShowResourceGroupsRequest
All Implemented Interfaces:
org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord
public class ShowResourceGroupsRequest extends Object implements org.apache.avro.generic.IndexedRecord
A set of parameters for GPUdb.showResourceGroups.

Requests resource group properties. Returns detailed information about the requested resource groups.

  • ​
    Constructor Details

    • ​
      ShowResourceGroupsRequest

      public ShowResourceGroupsRequest()
      Constructs a ShowResourceGroupsRequest object with default parameters.

    • ​
      ShowResourceGroupsRequest

      public ShowResourceGroupsRequest(List<String> names, Map<String,String> options)
      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.
      The default value is an empty Map.

  • ​
    Method Details

    • ​
      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.

    • ​
      getNames

      public List<String> getNames()
      List of names of groups to be shown. A single entry with an empty string returns all groups.
      Returns:
      The current value of names.

    • ​
      setNames

      public ShowResourceGroupsRequest setNames(List<String> names)
      List of names of groups to be shown. A single entry with an empty string returns all groups.
      Parameters:
      names - The new value for names.
      Returns:
      this to mimic the builder pattern.

    • ​
      getOptions

      public Map<String,String> getOptions()
      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 Map.
      Returns:
      The current value of options.

    • ​
      setOptions

      public ShowResourceGroupsRequest setOptions(Map<String,String> 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.
      The default value is an empty Map.
      Parameters:
      options - The new value for options.
      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