com.gpudb.protocol

Class AdminAddRanksRequest

java.lang.Object

com.gpudb.protocol.AdminAddRanksRequest

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord

public class AdminAddRanksRequest
extends Object
implements org.apache.avro.generic.IndexedRecord

A set of parameters for GPUdb.adminAddRanks(AdminAddRanksRequest).

Add one or more new ranks to the Kinetica cluster. The new ranks will not contain any data initially, other than replicated tables, and not be assigned any shards. To rebalance data across the cluster, which includes shifting some shard key assignments to newly added ranks, see GPUdb.adminRebalance(AdminRebalanceRequest).

For example, if attempting to add three new ranks (two ranks on host 172.123.45.67 and one rank on host 172.123.45.68) to a Kinetica cluster with additional configuration parameters:

* hosts would be an array including 172.123.45.67 in the first two indices (signifying two ranks being added to host 172.123.45.67) and 172.123.45.68 in the last index (signifying one rank being added to host 172.123.45.67)

* configParams would be an array of maps, with each map corresponding to the ranks being added in hosts. The key of each map would be the configuration parameter name and the value would be the parameter's value, e.g. 'rank.gpu':'1'

This endpoint's processing includes copying all replicated table data to the new rank(s) and therefore could take a long time. The API call may time out if run directly. It is recommended to run this endpoint asynchronously via GPUdb.createJob(CreateJobRequest).

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
AdminAddRanksRequest() Constructs an AdminAddRanksRequest object with default parameters.
AdminAddRanksRequest(List<String> hosts, List<Map<String,String>> configParams, Map<String,String> options) Constructs an AdminAddRanksRequest 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.
List<Map<String,String>>	getConfigParams()
List<String>	getHosts()
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.
AdminAddRanksRequest	setConfigParams(List<Map<String,String>> configParams)
AdminAddRanksRequest	setHosts(List<String> hosts)
AdminAddRanksRequest	setOptions(Map<String,String> options)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AdminAddRanksRequest

public AdminAddRanksRequest()

Constructs an AdminAddRanksRequest object with default parameters.

AdminAddRanksRequest

public AdminAddRanksRequest(List<String> hosts,
                            List<Map<String,String>> configParams,
                            Map<String,String> options)

Constructs an AdminAddRanksRequest object with the specified parameters.

Parameters:

hosts - The IP address of each rank being added to the cluster. Insert one entry per rank, even if they are on the same host. The order of the hosts in the array only matters as it relates to the configParams.

configParams - Configuration parameters to apply to the new ranks, e.g., which GPU to use. Configuration parameters that start with 'rankN.', where N is the rank number, should omit the N, as the new rank number(s) are not allocated until the ranks are created. Each entry in this array corresponds to the entry at the same array index in the hosts. This array must either be completely empty or have the same number of elements as the hosts array. An empty array will result in the new ranks being set only with default parameters.

options - Optional parameters.

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

getHosts

public List<String> getHosts()

Returns:

The IP address of each rank being added to the cluster. Insert one entry per rank, even if they are on the same host. The order of the hosts in the array only matters as it relates to the configParams.

setHosts

public AdminAddRanksRequest setHosts(List<String> hosts)

Parameters:

hosts - The IP address of each rank being added to the cluster. Insert one entry per rank, even if they are on the same host. The order of the hosts in the array only matters as it relates to the configParams.

Returns:

this to mimic the builder pattern.

getConfigParams

public List<Map<String,String>> getConfigParams()

Returns:

Configuration parameters to apply to the new ranks, e.g., which GPU to use. Configuration parameters that start with 'rankN.', where N is the rank number, should omit the N, as the new rank number(s) are not allocated until the ranks are created. Each entry in this array corresponds to the entry at the same array index in the hosts. This array must either be completely empty or have the same number of elements as the hosts array. An empty array will result in the new ranks being set only with default parameters.

setConfigParams

public AdminAddRanksRequest setConfigParams(List<Map<String,String>> configParams)

Parameters:

configParams - Configuration parameters to apply to the new ranks, e.g., which GPU to use. Configuration parameters that start with 'rankN.', where N is the rank number, should omit the N, as the new rank number(s) are not allocated until the ranks are created. Each entry in this array corresponds to the entry at the same array index in the hosts. This array must either be completely empty or have the same number of elements as the hosts array. An empty array will result in the new ranks being set only with default parameters.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Returns:

Optional parameters.

• DRY_RUN: If true, only validation checks will be performed. No ranks are added. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

The default value is an empty Map.

setOptions

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

Parameters:

options - Optional parameters.

• DRY_RUN: If true, only validation checks will be performed. No ranks are added. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

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