Reference documentation and code samples for the Google Cloud Sql Admin V1 Client class MySqlReplicaConfiguration.
Read-replica configuration specific to MySQL databases.
Generated from protobuf messagegoogle.cloud.sql.v1.MySqlReplicaConfiguration
Namespace
Google \ Cloud \ Sql \ V1
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.
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 alwayssql#mysqlReplicaConfiguration.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Sql Admin V1 Client - Class MySqlReplicaConfiguration (1.2.6)\n\nVersion latestkeyboard_arrow_down\n\n- [1.2.6 (latest)](/php/docs/reference/cloud-sql-admin/latest/V1.MySqlReplicaConfiguration)\n- [1.2.5](/php/docs/reference/cloud-sql-admin/1.2.5/V1.MySqlReplicaConfiguration)\n- [1.1.0](/php/docs/reference/cloud-sql-admin/1.1.0/V1.MySqlReplicaConfiguration)\n- [1.0.0](/php/docs/reference/cloud-sql-admin/1.0.0/V1.MySqlReplicaConfiguration)\n- [0.19.0](/php/docs/reference/cloud-sql-admin/0.19.0/V1.MySqlReplicaConfiguration)\n- [0.18.0](/php/docs/reference/cloud-sql-admin/0.18.0/V1.MySqlReplicaConfiguration)\n- [0.17.1](/php/docs/reference/cloud-sql-admin/0.17.1/V1.MySqlReplicaConfiguration)\n- [0.16.1](/php/docs/reference/cloud-sql-admin/0.16.1/V1.MySqlReplicaConfiguration)\n- [0.12.0](/php/docs/reference/cloud-sql-admin/0.12.0/V1.MySqlReplicaConfiguration)\n- [0.11.0](/php/docs/reference/cloud-sql-admin/0.11.0/V1.MySqlReplicaConfiguration)\n- [0.10.0](/php/docs/reference/cloud-sql-admin/0.10.0/V1.MySqlReplicaConfiguration)\n- [0.9.0](/php/docs/reference/cloud-sql-admin/0.9.0/V1.MySqlReplicaConfiguration)\n- [0.8.0](/php/docs/reference/cloud-sql-admin/0.8.0/V1.MySqlReplicaConfiguration)\n- [0.7.0](/php/docs/reference/cloud-sql-admin/0.7.0/V1.MySqlReplicaConfiguration)\n- [0.6.0](/php/docs/reference/cloud-sql-admin/0.6.0/V1.MySqlReplicaConfiguration)\n- [0.5.0](/php/docs/reference/cloud-sql-admin/0.5.0/V1.MySqlReplicaConfiguration)\n- [0.4.1](/php/docs/reference/cloud-sql-admin/0.4.1/V1.MySqlReplicaConfiguration)\n- [0.3.1](/php/docs/reference/cloud-sql-admin/0.3.1/V1.MySqlReplicaConfiguration)\n- [0.2.12](/php/docs/reference/cloud-sql-admin/0.2.12/V1.MySqlReplicaConfiguration) \nReference documentation and code samples for the Google Cloud Sql Admin V1 Client class MySqlReplicaConfiguration.\n\nRead-replica configuration specific to MySQL databases.\n\nGenerated from protobuf message `google.cloud.sql.v1.MySqlReplicaConfiguration`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Sql \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getDumpFilePath\n\nPath to a SQL dump file in Google Cloud Storage from which the replica\ninstance is to be created. The URI is in the form gs://bucketName/fileName.\n\nCompressed gzip files (.gz) are also supported.\nDumps have the binlog co-ordinates from which replication\nbegins. This can be accomplished by setting --master-data to 1 when using\nmysqldump.\n\n### setDumpFilePath\n\nPath to a SQL dump file in Google Cloud Storage from which the replica\ninstance is to be created. The URI is in the form gs://bucketName/fileName.\n\nCompressed gzip files (.gz) are also supported.\nDumps have the binlog co-ordinates from which replication\nbegins. This can be accomplished by setting --master-data to 1 when using\nmysqldump.\n\n### getUsername\n\nThe username for the replication connection.\n\n### setUsername\n\nThe username for the replication connection.\n\n### getPassword\n\nThe password for the replication connection.\n\n### setPassword\n\nThe password for the replication connection.\n\n### getConnectRetryInterval\n\nSeconds to wait between connect retries. MySQL's default is 60 seconds.\n\n### hasConnectRetryInterval\n\n### clearConnectRetryInterval\n\n### getConnectRetryIntervalUnwrapped\n\nReturns the unboxed value from `getConnectRetryInterval()`\n\nSeconds to wait between connect retries. MySQL's default is 60 seconds.\n\n### setConnectRetryInterval\n\nSeconds to wait between connect retries. MySQL's default is 60 seconds.\n\n### setConnectRetryIntervalUnwrapped\n\nSets the field by wrapping a primitive type in a Google\\\\Protobuf\\\\Int32Value object.\n\nSeconds to wait between connect retries. MySQL's default is 60 seconds.\n\n### getMasterHeartbeatPeriod\n\nInterval in milliseconds between replication heartbeats.\n\n### hasMasterHeartbeatPeriod\n\n### clearMasterHeartbeatPeriod\n\n### getMasterHeartbeatPeriodUnwrapped\n\nReturns the unboxed value from `getMasterHeartbeatPeriod()`\n\nInterval in milliseconds between replication heartbeats.\n\n### setMasterHeartbeatPeriod\n\nInterval in milliseconds between replication heartbeats.\n\n### setMasterHeartbeatPeriodUnwrapped\n\nSets the field by wrapping a primitive type in a Google\\\\Protobuf\\\\Int64Value object.\n\nInterval in milliseconds between replication heartbeats.\n\n### getCaCertificate\n\nPEM representation of the trusted CA's x509 certificate.\n\n### setCaCertificate\n\nPEM representation of the trusted CA's x509 certificate.\n\n### getClientCertificate\n\nPEM representation of the replica's x509 certificate.\n\n### setClientCertificate\n\nPEM representation of the replica's x509 certificate.\n\n### getClientKey\n\nPEM representation of the replica's private key. The corresponsing public\nkey is encoded in the client's certificate.\n\n### setClientKey\n\nPEM representation of the replica's private key. The corresponsing public\nkey is encoded in the client's certificate.\n\n### getSslCipher\n\nA list of permissible ciphers to use for SSL encryption.\n\n### setSslCipher\n\nA list of permissible ciphers to use for SSL encryption.\n\n### getVerifyServerCertificate\n\nWhether or not to check the primary instance's Common Name value in the\ncertificate that it sends during the SSL handshake.\n\n### hasVerifyServerCertificate\n\n### clearVerifyServerCertificate\n\n### getVerifyServerCertificateUnwrapped\n\nReturns the unboxed value from `getVerifyServerCertificate()`\n\nWhether or not to check the primary instance's Common Name value in the\ncertificate that it sends during the SSL handshake.\n\n### setVerifyServerCertificate\n\nWhether or not to check the primary instance's Common Name value in the\ncertificate that it sends during the SSL handshake.\n\n### setVerifyServerCertificateUnwrapped\n\nSets the field by wrapping a primitive type in a Google\\\\Protobuf\\\\BoolValue object.\n\nWhether or not to check the primary instance's Common Name value in the\ncertificate that it sends during the SSL handshake.\n\n### getKind\n\nThis is always `sql#mysqlReplicaConfiguration`.\n\n### setKind\n\nThis is always `sql#mysqlReplicaConfiguration`."]]
