Reference documentation and code samples for the Google Cloud Sql Admin V1beta4 Client class MySqlReplicaConfiguration.
Read-replica configuration specific to MySQL databases.
Generated from protobuf message google.cloud.sql.v1beta4.MySqlReplicaConfiguration
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ dump_file_path |
string
Path to a SQL dump file in Google Cloud Storage from which the replica instance is to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. Dumps have the binlog co-ordinates from which replication begins. This can be accomplished by setting --master-data to 1 when using mysqldump. |
↳ username |
string
The username for the replication connection. |
↳ password |
string
The password for the replication connection. |
↳ connect_retry_interval |
Google\Protobuf\Int32Value
Seconds to wait between connect retries. MySQL's default is 60 seconds. |
↳ master_heartbeat_period |
Google\Protobuf\Int64Value
Interval in milliseconds between replication heartbeats. |
↳ ca_certificate |
string
PEM representation of the trusted CA's x509 certificate. |
↳ client_certificate |
string
PEM representation of the replica's x509 certificate. |
↳ client_key |
string
PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate. |
↳ ssl_cipher |
string
A list of permissible ciphers to use for SSL encryption. |
↳ verify_server_certificate |
Google\Protobuf\BoolValue
Whether or not to check the primary instance's Common Name value in the certificate that it sends during the SSL handshake. |
↳ kind |
string
This is always |
getDumpFilePath
Path to a SQL dump file in Google Cloud Storage from which the replica instance is to be created. The URI is in the form gs://bucketName/fileName.
Compressed gzip files (.gz) are also supported. Dumps have the binlog co-ordinates from which replication begins. This can be accomplished by setting --master-data to 1 when using mysqldump.
| Returns | |
|---|---|
| Type | Description |
string | |
setDumpFilePath
Path to a SQL dump file in Google Cloud Storage from which the replica instance is to be created. The URI is in the form gs://bucketName/fileName.
Compressed gzip files (.gz) are also supported. Dumps have the binlog co-ordinates from which replication begins. This can be accomplished by setting --master-data to 1 when using mysqldump.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUsername
The username for the replication connection.
| Returns | |
|---|---|
| Type | Description |
string | |
setUsername
The username for the replication connection.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPassword
The password for the replication connection.
| Returns | |
|---|---|
| Type | Description |
string | |
setPassword
The password for the replication connection.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getConnectRetryInterval
Seconds to wait between connect retries. MySQL's default is 60 seconds.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Int32Value|null | |
hasConnectRetryInterval
clearConnectRetryInterval
getConnectRetryIntervalValue
Returns the unboxed value from getConnectRetryInterval()
Seconds to wait between connect retries. MySQL's default is 60 seconds.
| Returns | |
|---|---|
| Type | Description |
int|null | |
setConnectRetryInterval
Seconds to wait between connect retries. MySQL's default is 60 seconds.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Int32Value
|
| Returns | |
|---|---|
| Type | Description |
$this | |
setConnectRetryIntervalValue
Sets the field by wrapping a primitive type in a Google\Protobuf\Int32Value object.
Seconds to wait between connect retries. MySQL's default is 60 seconds.
| Parameter | |
|---|---|
| Name | Description |
var |
int|null
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMasterHeartbeatPeriod
Interval in milliseconds between replication heartbeats.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Int64Value|null | |
hasMasterHeartbeatPeriod
clearMasterHeartbeatPeriod
getMasterHeartbeatPeriodValue
Returns the unboxed value from getMasterHeartbeatPeriod()
Interval in milliseconds between replication heartbeats.
| Returns | |
|---|---|
| Type | Description |
int|string|null | |
setMasterHeartbeatPeriod
Interval in milliseconds between replication heartbeats.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Int64Value
|
| Returns | |
|---|---|
| Type | Description |
$this | |
setMasterHeartbeatPeriodValue
Sets the field by wrapping a primitive type in a Google\Protobuf\Int64Value object.
Interval in milliseconds between replication heartbeats.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string|null
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCaCertificate
PEM representation of the trusted CA's x509 certificate.
| Returns | |
|---|---|
| Type | Description |
string | |
setCaCertificate
PEM representation of the trusted CA's x509 certificate.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getClientCertificate
PEM representation of the replica's x509 certificate.
| Returns | |
|---|---|
| Type | Description |
string | |
setClientCertificate
PEM representation of the replica's x509 certificate.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getClientKey
PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.
| Returns | |
|---|---|
| Type | Description |
string | |
setClientKey
PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSslCipher
A list of permissible ciphers to use for SSL encryption.
| Returns | |
|---|---|
| Type | Description |
string | |
setSslCipher
A list of permissible ciphers to use for SSL encryption.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getVerifyServerCertificate
Whether or not to check the primary instance's Common Name value in the certificate that it sends during the SSL handshake.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\BoolValue|null | |
hasVerifyServerCertificate
clearVerifyServerCertificate
getVerifyServerCertificateValue
Returns the unboxed value from getVerifyServerCertificate()
Whether or not to check the primary instance's Common Name value in the certificate that it sends during the SSL handshake.
| Returns | |
|---|---|
| Type | Description |
bool|null | |
setVerifyServerCertificate
Whether or not to check the primary instance's Common Name value in the certificate that it sends during the SSL handshake.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\BoolValue
|
| Returns | |
|---|---|
| Type | Description |
$this | |
setVerifyServerCertificateValue
Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.
Whether or not to check the primary instance's Common Name value in the certificate that it sends during the SSL handshake.
| Parameter | |
|---|---|
| Name | Description |
var |
bool|null
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getKind
This is always sql#mysqlReplicaConfiguration.
| Returns | |
|---|---|
| Type | Description |
string | |
setKind
This is always sql#mysqlReplicaConfiguration.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |