GPUdb C++ API  Version 7.2.2.4
gpudb::AdminHaOfflineRequest Struct Reference

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

#include <gpudb/protocol/admin_ha_offline.h>

Public Member Functions

 AdminHaOfflineRequest ()
 Constructs an AdminHaOfflineRequest object with default parameters. More...
 
 AdminHaOfflineRequest (const bool offline_, const std::map< std::string, std::string > &options_)
 Constructs an AdminHaOfflineRequest object with the specified parameters. More...
 

Public Attributes

bool offline
 Set to true if desired state is offline. More...
 
std::map< std::string, std::string > options
 Optional parameters. More...
 

Detailed Description

A set of parameters for GPUdb::adminHaOffline.

Pauses consumption of messages from other HA clusters to support data repair/recovery scenarios. In-flight queries may fail to replicate to other clusters in the ring when going offline.

Definition at line 20 of file admin_ha_offline.h.

Constructor & Destructor Documentation

◆ AdminHaOfflineRequest() [1/2]

gpudb::AdminHaOfflineRequest::AdminHaOfflineRequest ( )
inline

Constructs an AdminHaOfflineRequest object with default parameters.

Definition at line 25 of file admin_ha_offline.h.

◆ AdminHaOfflineRequest() [2/2]

gpudb::AdminHaOfflineRequest::AdminHaOfflineRequest ( const bool  offline_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs an AdminHaOfflineRequest object with the specified parameters.

Parameters
[in]offline_Set to true if desired state is offline. Supported values:
  • true
  • false
[in]options_Optional parameters. The default value is an empty map.

Definition at line 44 of file admin_ha_offline.h.

Member Data Documentation

◆ offline

bool gpudb::AdminHaOfflineRequest::offline

Set to true if desired state is offline.

Supported values:

  • true
  • false

Definition at line 58 of file admin_ha_offline.h.

◆ options

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

Optional parameters.

The default value is an empty map.

Definition at line 63 of file admin_ha_offline.h.


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