A set of parameters for GPUdb::adminAlterHost. More...

#include <gpudb/protocol/admin_alter_host.h>

Public Member Functions
	AdminAlterHostRequest ()
	Constructs an AdminAlterHostRequest object with default parameters. More...

	AdminAlterHostRequest (const std::string &host_, const std::map< std::string, std::string > &options_)
	Constructs an AdminAlterHostRequest object with the specified parameters. More...

Public Attributes
std::string	host
	Identifies the host this applies to. More...

std::map< std::string, std::string >	options
	Optional parameters. More...

Detailed Description

A set of parameters for GPUdb::adminAlterHost.

Alter properties on an existing host in the cluster. Currently, the only property that can be altered is a hosts ability to accept failover processes.

Definition at line 20 of file admin_alter_host.h.

Constructor & Destructor Documentation

◆ AdminAlterHostRequest() [1/2]

gpudb::AdminAlterHostRequest::AdminAlterHostRequest ( )

inline

Constructs an AdminAlterHostRequest object with default parameters.

Definition at line 25 of file admin_alter_host.h.

◆ AdminAlterHostRequest() [2/2]

gpudb::AdminAlterHostRequest::AdminAlterHostRequest	(	const std::string &	host_,
		const std::map< std::string, std::string > &	options_
	)

inline

Constructs an AdminAlterHostRequest object with the specified parameters.

Parameters

[in]	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
[in]	options_	Optional parameters. admin_alter_host_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: admin_alter_host_true admin_alter_host_false The default value is admin_alter_host_false. The default value is an empty map.

Definition at line 64 of file admin_alter_host.h.

Member Data Documentation

◆ host

std::string gpudb::AdminAlterHostRequest::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

Definition at line 75 of file admin_alter_host.h.

◆ options

std::map<std::string, std::string> gpudb::AdminAlterHostRequest::options

Optional parameters.

admin_alter_host_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:
- admin_alter_host_true
- admin_alter_host_false
The default value is admin_alter_host_false.

The default value is an empty map.

Definition at line 97 of file admin_alter_host.h.

The documentation for this struct was generated from the following file:

gpudb/protocol/admin_alter_host.h

Public Member Functions