com.gpudb.protocol

Class AdminAddHostRequest

java.lang.Object

com.gpudb.protocol.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(AdminAddHostRequest).

Adds a host to an existing cluster.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AdminAddHostRequest.Options Optional parameters.

Constructor Summary

Constructors

Constructor and Description
AdminAddHostRequest() Constructs an AdminAddHostRequest object with default parameters.
AdminAddHostRequest(String hostAddress, Map<String,String> options) Constructs an AdminAddHostRequest object with the specified parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Object	get(int index) This method supports the Avro framework and is not intended to be called directly by the user.
static org.apache.avro.Schema	getClassSchema() This method supports the Avro framework and is not intended to be called directly by the user.
String	getHostAddress()
Map<String,String>	getOptions()
org.apache.avro.Schema	getSchema() This method supports the Avro framework and is not intended to be called directly by the user.
int	hashCode()
void	put(int index, Object value) This method supports the Avro framework and is not intended to be called directly by the user.
AdminAddHostRequest	setHostAddress(String hostAddress)
AdminAddHostRequest	setOptions(Map<String,String> options)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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:
  • TRUE
  • FALSE
  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:
  • TRUE
  • FALSE
  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()

Returns:

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.

setHostAddress

public AdminAddHostRequest setHostAddress(String hostAddress)

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.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Returns:

Optional parameters.

• DRY_RUN: If set to true, only validation checks will be performed. No host is added. Supported values:
  • TRUE
  • FALSE
  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:
  • TRUE
  • FALSE
  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.

setOptions

public AdminAddHostRequest setOptions(Map<String,String> options)

Parameters:

options - Optional parameters.

• DRY_RUN: If set to true, only validation checks will be performed. No host is added. Supported values:
  • TRUE
  • FALSE
  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:
  • TRUE
  • FALSE
  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:

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