Skip to main content

Class AdminOfflineRequest

java.lang.Object
com.gpudb.protocol.AdminOfflineRequest
All Implemented Interfaces:
org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord

public class AdminOfflineRequest extends Object implements org.apache.avro.generic.IndexedRecord
A set of parameters for GPUdb.adminOffline.

Take the system offline. When the system is offline, no user operations can be performed with the exception of a system shutdown.

  • Constructor Details

    • AdminOfflineRequest

      public AdminOfflineRequest()
      Constructs an AdminOfflineRequest object with default parameters.
    • AdminOfflineRequest

      public AdminOfflineRequest(boolean offline, Map<String,String> options)
      Constructs an AdminOfflineRequest object with the specified parameters.
      Parameters:
      offline - Set to true if desired state is offline. Supported values:
      • true
      • false
      options - Optional parameters.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.
    • getOffline

      public boolean getOffline()
      Set to true if desired state is offline. Supported values:
      • true
      • false
      Returns:
      The current value of offline.
    • setOffline

      public AdminOfflineRequest setOffline(boolean offline)
      Set to true if desired state is offline. Supported values:
      • true
      • false
      Parameters:
      offline - The new value for offline.
      Returns:
      this to mimic the builder pattern.
    • getOptions

      public Map<String,String> getOptions()
      Optional parameters.The default value is an empty Map.
      Returns:
      The current value of options.
    • setOptions

      public AdminOfflineRequest setOptions(Map<String,String> options)
      Optional parameters.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:
    • 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:
    • 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