Google Cloud Sql Admin V1 Client - Class DemoteMasterContext (0.12.0)

Reference documentation and code samples for the Google Cloud Sql Admin V1 Client class DemoteMasterContext.

Database instance demote primary instance context.

Generated from protobuf message google.cloud.sql.v1.DemoteMasterContext

Namespace

Google \ Cloud \ Sql \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ kind`	`string` This is always `sql#demoteMasterContext`.
`↳ verify_gtid_consistency`	`Google\Protobuf\BoolValue` Verify the GTID consistency for demote operation. Default value: `True`. Setting this flag to `false` enables you to bypass the GTID consistency check between on-premises primary instance and Cloud SQL instance during the demotion operation but also exposes you to the risk of future replication failures. Change the value only if you know the reason for the GTID divergence and are confident that doing so will not cause any replication issues.
`↳ master_instance_name`	`string` The name of the instance which will act as on-premises primary instance in the replication setup.
`↳ replica_configuration`	`Google\Cloud\Sql\V1\DemoteMasterConfiguration` Configuration specific to read-replicas replicating from the on-premises primary instance.
`↳ skip_replication_setup`	`bool` Flag to skip replication setup on the instance.

getKind

This is always sql#demoteMasterContext.

Returns
Type	Description
`string`

setKind

This is always sql#demoteMasterContext.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getVerifyGtidConsistency

Verify the GTID consistency for demote operation. Default value: True. Setting this flag to false enables you to bypass the GTID consistency check between on-premises primary instance and Cloud SQL instance during the demotion operation but also exposes you to the risk of future replication failures. Change the value only if you know the reason for the GTID divergence and are confident that doing so will not cause any replication issues.

Returns
Type	Description
`Google\Protobuf\BoolValue\|null`

hasVerifyGtidConsistency

clearVerifyGtidConsistency

getVerifyGtidConsistencyValue

Returns the unboxed value from getVerifyGtidConsistency()

Returns
Type	Description
`bool\|null`

setVerifyGtidConsistency

Parameter
Name	Description
`var`	`Google\Protobuf\BoolValue`

Returns
Type	Description
`$this`

setVerifyGtidConsistencyValue

Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.

Parameter
Name	Description
`var`	`bool\|null`

Returns
Type	Description
`$this`

getMasterInstanceName

The name of the instance which will act as on-premises primary instance in the replication setup.

Returns
Type	Description
`string`

setMasterInstanceName

The name of the instance which will act as on-premises primary instance in the replication setup.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getReplicaConfiguration

Configuration specific to read-replicas replicating from the on-premises primary instance.

Returns
Type	Description
`Google\Cloud\Sql\V1\DemoteMasterConfiguration\|null`

hasReplicaConfiguration

clearReplicaConfiguration

setReplicaConfiguration

Configuration specific to read-replicas replicating from the on-premises primary instance.

Parameter
Name	Description
`var`	`Google\Cloud\Sql\V1\DemoteMasterConfiguration`

Returns
Type	Description
`$this`

getSkipReplicationSetup

Flag to skip replication setup on the instance.

Returns
Type	Description
`bool`

setSkipReplicationSetup

Flag to skip replication setup on the instance.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`