com.gpudb.protocol

Class AdminRemoveHostRequest

java.lang.Object

com.gpudb.protocol.AdminRemoveHostRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.adminRemoveHost(AdminRemoveHostRequest).

Removes a host from an existing cluster. If the host to be removed has any ranks running on it, the ranks must be removed using GPUdb.adminRemoveRanks(AdminRemoveRanksRequest) or manually switched over to a new host using GPUdb.adminSwitchover(AdminSwitchoverRequest) prior to host removal. If the host to be removed has the graph server or SQL planner running on it, these must be manually switched over to a new host using GPUdb.adminSwitchover(AdminSwitchoverRequest).

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
AdminRemoveHostRequest() Constructs an AdminRemoveHostRequest object with default parameters.
AdminRemoveHostRequest(String host, Map<String,String> options) Constructs an AdminRemoveHostRequest 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	getHost()
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.
AdminRemoveHostRequest	setHost(String host)
AdminRemoveHostRequest	setOptions(Map<String,String> options)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AdminRemoveHostRequest

public AdminRemoveHostRequest()

Constructs an AdminRemoveHostRequest object with default parameters.

AdminRemoveHostRequest

public AdminRemoveHostRequest(String host,
                              Map<String,String> options)

Constructs an AdminRemoveHostRequest 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.

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

getHost

public String getHost()

Returns:

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

setHost

public AdminRemoveHostRequest setHost(String host)

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

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 removed. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

The default value is an empty Map.

setOptions

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

Parameters:

options - Optional parameters.

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