Class AdminShowClusterOperationsRequest

  • All Implemented Interfaces:
    org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord

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

    Requests the detailed status of the current operation (by default) or a prior cluster operation specified by historyIndex. Returns details on the requested cluster operation.

    The response will also indicate how many cluster operations are stored in the history.

    • Constructor Detail

      • AdminShowClusterOperationsRequest

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

        public AdminShowClusterOperationsRequest​(int historyIndex,
                                                 Map<String,​String> options)
        Constructs an AdminShowClusterOperationsRequest object with the specified parameters.
        Parameters:
        historyIndex - Indicates which cluster operation to retrieve. Use 0 for the most recent. The default value is 0.
        options - Optional parameters. 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.
      • getHistoryIndex

        public int getHistoryIndex()
        Indicates which cluster operation to retrieve. Use 0 for the most recent. The default value is 0.
        Returns:
        The current value of historyIndex.
      • setHistoryIndex

        public AdminShowClusterOperationsRequest setHistoryIndex​(int historyIndex)
        Indicates which cluster operation to retrieve. Use 0 for the most recent. The default value is 0.
        Parameters:
        historyIndex - The new value for historyIndex.
        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.
      • 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
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object