AdminAddHostRequest.Options (Kinetica Java API 7.1.10.4 API)

java.lang.Object
- com.gpudb.protocol.AdminAddHostRequest.Options

Enclosing class:

AdminAddHostRequest
```
public static final class AdminAddHostRequest.Options
extends Object
```
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. A set of string constants for the parameter options.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`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.
`static String`	`DRY_RUN` If set to `true`, only validation checks will be performed.
`static String`	`FALSE`
`static String`	`GPUS` Comma-delimited list of GPU indices (starting at 1) that are eligible for running worker processes.
`static String`	`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'.
`static String`	`PUBLIC_ADDRESS` The publicly-accessible IP address for the host being added, typically specified for clients using multi-head operations.
`static String`	`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.
`static String`	`TRUE`

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DRY_RUN
```
public static final String 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.
    See Also:
    
    Constant Field Values
  - TRUE
```
public static final String TRUE
```
    See Also:
    
    Constant Field Values
  - FALSE
```
public static final String FALSE
```
    See Also:
    
    Constant Field Values
  - ACCEPTS_FAILOVER
```
public static final String 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.
    See Also:
    
    Constant Field Values
  - PUBLIC_ADDRESS
```
public static final String 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.
    
    See Also:
    
    Constant Field Values
  - HOST_MANAGER_PUBLIC_URL
```
public static final String 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.
    
    See Also:
    
    Constant Field Values
  - RAM_LIMIT
```
public static final String 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.
    
    See Also:
    
    Constant Field Values
  - GPUS
```
public static final String 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.
    
    See Also:
    
    Constant Field Values

Class AdminAddHostRequest.Options

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DRY_RUN

TRUE

FALSE

ACCEPTS_FAILOVER

PUBLIC_ADDRESS

HOST_MANAGER_PUBLIC_URL

RAM_LIMIT

GPUS