google_sqladmin_api::ReplicaConfiguration Class Reference

#include <replica_configuration.h>

Inheritance diagram for google_sqladmin_api::ReplicaConfiguration:

Public Member Functions
	ReplicaConfiguration (const Json::Value &storage)
	ReplicaConfiguration (Json::Value *storage)
virtual	~ReplicaConfiguration ()
const StringPiece	GetTypeName () const
bool	has_failover_target () const
void	clear_failover_target ()
bool	get_failover_target () const
void	set_failover_target (bool value)
bool	has_kind () const
void	clear_kind ()
const StringPiece	get_kind () const
void	set_kind (const StringPiece &value)
bool	has_mysql_replica_configuration () const
void	clear_mysql_replica_configuration ()
const MySqlReplicaConfiguration	get_mysql_replica_configuration () const
MySqlReplicaConfiguration	mutable_mysqlReplicaConfiguration ()

Static Public Member Functions
static ReplicaConfiguration *	New ()

Detailed Description

Read-replica configuration for connecting to the master.

Constructor & Destructor Documentation

ReplicaConfiguration() [1/2]

google_sqladmin_api::ReplicaConfiguration::ReplicaConfiguration ( const Json::Value &  storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

ReplicaConfiguration() [2/2]

google_sqladmin_api::ReplicaConfiguration::ReplicaConfiguration ( Json::Value *  storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~ReplicaConfiguration()

google_sqladmin_api::ReplicaConfiguration::~ReplicaConfiguration ( )

virtual

Standard destructor.

Member Function Documentation

clear_failover_target()

void google_sqladmin_api::ReplicaConfiguration::clear_failover_target ( )

inline

Clears the 'failoverTarget' attribute.

clear_kind()

void google_sqladmin_api::ReplicaConfiguration::clear_kind ( )

inline

Clears the 'kind' attribute.

clear_mysql_replica_configuration()

void google_sqladmin_api::ReplicaConfiguration::clear_mysql_replica_configuration ( )

inline

Clears the 'mysqlReplicaConfiguration' attribute.

get_failover_target()

bool google_sqladmin_api::ReplicaConfiguration::get_failover_target ( ) const

inline

Get the value of the 'failoverTarget' attribute.

get_kind()

const StringPiece google_sqladmin_api::ReplicaConfiguration::get_kind ( ) const

inline

Get the value of the 'kind' attribute.

get_mysql_replica_configuration()

const MySqlReplicaConfiguration google_sqladmin_api::ReplicaConfiguration::get_mysql_replica_configuration

(

)

const

Get a reference to the value of the 'mysqlReplicaConfiguration' attribute.

GetTypeName()

const StringPiece google_sqladmin_api::ReplicaConfiguration::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_sqladmin_api::ReplicaConfiguration

has_failover_target()

bool google_sqladmin_api::ReplicaConfiguration::has_failover_target ( ) const

inline

Determine if the 'failoverTarget' attribute was set.

Returns

true if the 'failoverTarget' attribute was set.

has_kind()

bool google_sqladmin_api::ReplicaConfiguration::has_kind ( ) const

inline

Determine if the 'kind' attribute was set.

Returns

true if the 'kind' attribute was set.

has_mysql_replica_configuration()

bool google_sqladmin_api::ReplicaConfiguration::has_mysql_replica_configuration ( ) const

inline

Determine if the 'mysqlReplicaConfiguration' attribute was set.

Returns

true if the 'mysqlReplicaConfiguration' attribute was set.

mutable_mysqlReplicaConfiguration()

MySqlReplicaConfiguration google_sqladmin_api::ReplicaConfiguration::mutable_mysqlReplicaConfiguration

(

)

Gets a reference to a mutable value of the 'mysqlReplicaConfiguration' property.

MySQL specific configuration when replicating from a MySQL on-premises master. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named master.info in the data directory.

Returns

The result can be modified to change the attribute value.

New()

ReplicaConfiguration * google_sqladmin_api::ReplicaConfiguration::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_failover_target()

void google_sqladmin_api::ReplicaConfiguration::set_failover_target ( bool  value )

inline

Change the 'failoverTarget' attribute.

Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. In case the master instance fails, the replica instance will be promoted as the new master instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the master instance.

Parameters

[in]

value

The new value.

set_kind()

void google_sqladmin_api::ReplicaConfiguration::set_kind ( const StringPiece &  value )

inline

Change the 'kind' attribute.

This is always sql::replicaConfiguration.

Parameters

[in]

value

The new value.

---

The documentation for this class was generated from the following files:

• google/sqladmin_api/replica_configuration.h
• google/sqladmin_api/replica_configuration.cc