Package com.gpudb.protocol

Class AdminAddHostRequest

  • All Implemented Interfaces:
    org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord
    public class AdminAddHostRequest
extends Object
implements org.apache.avro.generic.IndexedRecord
    A set of parameters for GPUdb.adminAddHost.

    Adds a host to an existing cluster.

    • Constructor Detail

      • AdminAddHostRequest

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

      • AdminAddHostRequest

        public AdminAddHostRequest​(String hostAddress,
                           Map<String,​String> options)
        Constructs an AdminAddHostRequest object with the specified parameters.
        Parameters:
        hostAddress - IP address of the host that will be added to the cluster. This host must have installed the same version of Kinetica as the cluster to which it is being added.
        options - Optional parameters.
        • DRY_RUN: If set to TRUE, only validation checks will be performed. No host is added. Supported values: The default value is FALSE.
        • 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.
        • PUBLIC_ADDRESS: The publicly-accessible IP address for the host being added, typically specified for clients using multi-head operations. This setting is required if any other host(s) in the cluster specify a public address.
        • HOST_MANAGER_PUBLIC_URL: The publicly-accessible full path URL to the host manager on the host being added, e.g., 'http://172.123.45.67:9300'. The default host manager port can be found in the list of ports used by Kinetica.
        • RAM_LIMIT: The desired RAM limit for the host being added, i.e. the sum of RAM usage for all processes on the host will not be able to exceed this value. Supported units: K (thousand), KB (kilobytes), M (million), MB (megabytes), G (billion), GB (gigabytes); if no unit is provided, the value is assumed to be in bytes. For example, if RAM_LIMIT is set to 10M, the resulting RAM limit is 10 million bytes. Set RAM_LIMIT to -1 to have no RAM limit.
        • GPUS: Comma-delimited list of GPU indices (starting at 1) that are eligible for running worker processes. If left blank, all GPUs on the host being added will be eligible.
        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.

      • getHostAddress

        public String getHostAddress()
        IP address of the host that will be added to the cluster. This host must have installed the same version of Kinetica as the cluster to which it is being added.
        Returns:
        The current value of hostAddress.

      • setHostAddress

        public AdminAddHostRequest setHostAddress​(String hostAddress)
        IP address of the host that will be added to the cluster. This host must have installed the same version of Kinetica as the cluster to which it is being added.
        Parameters:
        hostAddress - The new value for hostAddress.
        Returns:
        this to mimic the builder pattern.

      • getOptions

        public Map<String,​String> getOptions()
        Optional parameters.
        • DRY_RUN: If set to TRUE, only validation checks will be performed. No host is added. Supported values: The default value is FALSE.
        • 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.
        • PUBLIC_ADDRESS: The publicly-accessible IP address for the host being added, typically specified for clients using multi-head operations. This setting is required if any other host(s) in the cluster specify a public address.
        • HOST_MANAGER_PUBLIC_URL: The publicly-accessible full path URL to the host manager on the host being added, e.g., 'http://172.123.45.67:9300'. The default host manager port can be found in the list of ports used by Kinetica.
        • RAM_LIMIT: The desired RAM limit for the host being added, i.e. the sum of RAM usage for all processes on the host will not be able to exceed this value. Supported units: K (thousand), KB (kilobytes), M (million), MB (megabytes), G (billion), GB (gigabytes); if no unit is provided, the value is assumed to be in bytes. For example, if RAM_LIMIT is set to 10M, the resulting RAM limit is 10 million bytes. Set RAM_LIMIT to -1 to have no RAM limit.
        • GPUS: Comma-delimited list of GPU indices (starting at 1) that are eligible for running worker processes. If left blank, all GPUs on the host being added will be eligible.
        The default value is an empty Map.
        Returns:
        The current value of options.

      • setOptions

        public AdminAddHostRequest setOptions​(Map<String,​String> options)
        Optional parameters.
        • DRY_RUN: If set to TRUE, only validation checks will be performed. No host is added. Supported values: The default value is FALSE.
        • 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.
        • PUBLIC_ADDRESS: The publicly-accessible IP address for the host being added, typically specified for clients using multi-head operations. This setting is required if any other host(s) in the cluster specify a public address.
        • HOST_MANAGER_PUBLIC_URL: The publicly-accessible full path URL to the host manager on the host being added, e.g., 'http://172.123.45.67:9300'. The default host manager port can be found in the list of ports used by Kinetica.
        • RAM_LIMIT: The desired RAM limit for the host being added, i.e. the sum of RAM usage for all processes on the host will not be able to exceed this value. Supported units: K (thousand), KB (kilobytes), M (million), MB (megabytes), G (billion), GB (gigabytes); if no unit is provided, the value is assumed to be in bytes. For example, if RAM_LIMIT is set to 10M, the resulting RAM limit is 10 million bytes. Set RAM_LIMIT to -1 to have no RAM limit.
        • GPUS: Comma-delimited list of GPU indices (starting at 1) that are eligible for running worker processes. If left blank, all GPUs on the host being added will be eligible.
        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