Class AdminAlterHostRequest

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

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

    Alter properties on an existing host in the cluster. Currently, the only property that can be altered is a hosts ability to accept failover processes.

    • Constructor Detail

      • AdminAlterHostRequest

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

        public AdminAlterHostRequest​(String host,
                                     Map<String,​String> options)
        Constructs an AdminAlterHostRequest object with the specified parameters.
        Parameters:
        host - Identifies the host this applies to. Can be the host address, or formatted as 'hostN' where N is the host number as specified in gpudb.conf
        options - Optional parameters.
        • ACCEPTS_FAILOVER: If set to TRUE, the host will accept processes (ranks, graph server, etc.) in the event of a failover on another node in the cluster. Supported values: The default value is FALSE.
        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.
      • getHost

        public String getHost()
        Identifies the host this applies to. Can be the host address, or formatted as 'hostN' where N is the host number as specified in gpudb.conf
        Returns:
        The current value of host.
      • setHost

        public AdminAlterHostRequest setHost​(String host)
        Identifies the host this applies to. Can be the host address, or formatted as 'hostN' where N is the host number as specified in gpudb.conf
        Parameters:
        host - The new value for host.
        Returns:
        this to mimic the builder pattern.
      • getOptions

        public Map<String,​String> getOptions()
        Optional parameters.
        • ACCEPTS_FAILOVER: If set to TRUE, the host will accept processes (ranks, graph server, etc.) in the event of a failover on another node in the cluster. Supported values: The default value is FALSE.
        The default value is an empty Map.
        Returns:
        The current value of options.
      • setOptions

        public AdminAlterHostRequest setOptions​(Map<String,​String> options)
        Optional parameters.
        • ACCEPTS_FAILOVER: If set to TRUE, the host will accept processes (ranks, graph server, etc.) in the event of a failover on another node in the cluster. 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
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object