Skip to main content
Package com.gpudb.protocol

​
Class AdminShutdownRequest

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

Exits the database server application.

  • ​
    Constructor Details

    • ​
      AdminShutdownRequest

      public AdminShutdownRequest()
      Constructs an AdminShutdownRequest object with default parameters.

    • ​
      AdminShutdownRequest

      public AdminShutdownRequest(String exitType, String authorization, Map<String,String> options)
      Constructs an AdminShutdownRequest object with the specified parameters.
      Parameters:
      exitType - Reserved for future use. User can pass an empty string.
      authorization - No longer used. User can pass an empty string.
      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.

    • ​
      getExitType

      public String getExitType()
      Reserved for future use. User can pass an empty string.
      Returns:
      The current value of exitType.

    • ​
      setExitType

      public AdminShutdownRequest setExitType(String exitType)
      Reserved for future use. User can pass an empty string.
      Parameters:
      exitType - The new value for exitType.
      Returns:
      this to mimic the builder pattern.

    • ​
      getAuthorization

      public String getAuthorization()
      No longer used. User can pass an empty string.
      Returns:
      The current value of authorization.

    • ​
      setAuthorization

      public AdminShutdownRequest setAuthorization(String authorization)
      No longer used. User can pass an empty string.
      Parameters:
      authorization - The new value for authorization.
      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 AdminShutdownRequest 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:
      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