docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/sql_v1beta4.instances.html b/docs/dyn/sql_v1beta4.instances.html
new file mode 100644
index 0000000..7e59129
--- /dev/null
+++ b/docs/dyn/sql_v1beta4.instances.html
@@ -0,0 +1,4381 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 em;
+}
+
+.method {
+ margin-top: 1em;
+ border: solid 1px #CCC;
+ padding: 1em;
+ background: #EEE;
+}
+
+.details {
+ font-weight: bold;
+ font-size: 14px;
+}
+
+</style>
+
+<h1><a href="sql_v1beta4.html">Cloud SQL Admin API</a> . <a href="sql_v1beta4.instances.html">instances</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#addServerCa">addServerCa(project, instance, x__xgafv=None)</a></code></p>
+<p class="firstline">Add a new trusted Certificate Authority (CA) version for the specified</p>
+<p class="toc_element">
+ <code><a href="#clone">clone(project, instance, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Creates a Cloud SQL instance as a clone of the source instance. Using this</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, instance, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes a Cloud SQL instance.</p>
+<p class="toc_element">
+ <code><a href="#demoteMaster">demoteMaster(project, instance, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Demotes the stand-alone instance to be a Cloud SQL read replica for an</p>
+<p class="toc_element">
+ <code><a href="#export">export(project, instance, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL</p>
+<p class="toc_element">
+ <code><a href="#failover">failover(project, instance, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Failover the instance to its failover replica instance. Using this</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, instance, x__xgafv=None)</a></code></p>
+<p class="firstline">Retrieves a resource containing information about a Cloud SQL instance.</p>
+<p class="toc_element">
+ <code><a href="#import_">import_(project, instance, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Imports data into a Cloud SQL instance from a SQL dump or CSV file in</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Creates a new Cloud SQL instance.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, pageToken=None, maxResults=None, filter=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists instances under a given project.</p>
+<p class="toc_element">
+ <code><a href="#listServerCas">listServerCas(project, instance, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists all of the trusted Certificate Authorities (CAs) for the specified</p>
+<p class="toc_element">
+ <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
+<p class="firstline">Retrieves the next page of results.</p>
+<p class="toc_element">
+ <code><a href="#patch">patch(project, instance, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Updates settings of a Cloud SQL instance.</p>
+<p class="toc_element">
+ <code><a href="#promoteReplica">promoteReplica(project, instance, x__xgafv=None)</a></code></p>
+<p class="firstline">Promotes the read replica instance to be a stand-alone Cloud SQL instance.</p>
+<p class="toc_element">
+ <code><a href="#resetSslConfig">resetSslConfig(project, instance, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes all client certificates and generates a new server SSL certificate</p>
+<p class="toc_element">
+ <code><a href="#restart">restart(project, instance, x__xgafv=None)</a></code></p>
+<p class="firstline">Restarts a Cloud SQL instance.</p>
+<p class="toc_element">
+ <code><a href="#restoreBackup">restoreBackup(project, instance, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Restores a backup of a Cloud SQL instance. Using this operation might cause</p>
+<p class="toc_element">
+ <code><a href="#rotateServerCa">rotateServerCa(project, instance, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Rotates the server certificate to one signed by the Certificate Authority</p>
+<p class="toc_element">
+ <code><a href="#startReplica">startReplica(project, instance, x__xgafv=None)</a></code></p>
+<p class="firstline">Starts the replication in the read replica instance.</p>
+<p class="toc_element">
+ <code><a href="#stopReplica">stopReplica(project, instance, x__xgafv=None)</a></code></p>
+<p class="firstline">Stops the replication in the read replica instance.</p>
+<p class="toc_element">
+ <code><a href="#truncateLog">truncateLog(project, instance, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Truncate MySQL general and slow query log tables</p>
+<p class="toc_element">
+ <code><a href="#update">update(project, instance, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Updates settings of a Cloud SQL instance. Using this operation might cause</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="addServerCa">addServerCa(project, instance, x__xgafv=None)</code>
+ <pre>Add a new trusted Certificate Authority (CA) version for the specified
+instance. Required to prepare for a certificate rotation. If a CA version
+was previously added but never used in a certificate rotation, this
+operation replaces that version. There cannot be more than one CA version
+waiting to be rotated in.
+
+Args:
+ project: string, Project ID of the project that contains the instance. (required)
+ instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource.&nbsp;For successful operations that return an
+ # Operation resource, only the fields relevant to the operation are populated
+ # in the resource.
+ "user": "A String", # The email address of the user who initiated this operation.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "targetLink": "A String",
+ "operationType": "A String", # The type of the operation. Valid values are <code>CREATE</code>,
+ # <code>DELETE</code>, <code>UPDATE</code>, <code>RESTART</code>,
+ # <code>IMPORT</code>, <code>EXPORT</code>, <code>BACKUP_VOLUME</code>,
+ # <code>RESTORE_VOLUME</code>, <code>CREATE_USER</code>,
+ # <code>DELETE_USER</code>, <code>CREATE_DATABASE</code>,
+ # <code>DELETE_DATABASE</code> .
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
+ # populated.
+ "errors": [ # The list of errors encountered while processing this operation.
+ { # Database instance operation error.
+ "code": "A String", # Identifies the specific error that occurred.
+ "message": "A String", # Additional information about the error encountered.
+ "kind": "A String", # This is always <code>sql#operationError</code>.
+ },
+ ],
+ "kind": "A String", # This is always <code>sql#operationErrors</code>.
+ },
+ "kind": "A String", # This is always <code>sql#operation</code>.
+ "importContext": { # Database instance import context. # The context for import operation, if applicable.
+ "csvImportOptions": { # Options for importing data as CSV.
+ "columns": [ # The columns to which CSV data is imported. If not specified, all columns
+ # of the database table are loaded with CSV data.
+ "A String",
+ ],
+ "table": "A String", # The table to which CSV data is imported.
+ },
+ "kind": "A String", # This is always <code>sql#importContext</code>.
+ "database": "A String", # The target database for the import. If <code>fileType</code> is
+ # <code>SQL</code>, this field is required only if the import file does not
+ # specify a database, and is overridden by any database specification in the
+ # import file. If <code>fileType</code> is <code>CSV</code>, one database
+ # must be specified.
+ "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
+ "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
+ "encryptionOptions": {
+ "pvkPassword": "A String", # Password that encrypts the private key
+ "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form
+ # <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
+ # form <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ },
+ },
+ "uri": "A String", # Path to the import file in Cloud Storage, in the form
+ # <code>gs:
+ # //bucketName/fileName</code>. Compressed gzip files (.gz) are supported
+ # // when <code>fileType</code> is <code>SQL</code>. The instance must have
+ # // write permissions to the bucket and read access to the file.
+ "fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ },
+ "status": "A String", # The status of an operation. Valid values are <code>PENDING</code>,
+ # <code>RUNNING</code>, <code>DONE</code>,
+ # <code>SQL_OPERATION_STATUS_UNSPECIFIED</code>.
+ "name": "A String", # An identifier that uniquely identifies the operation. You can use this
+ # identifier to retrieve the Operations resource that has information about
+ # the operation.
+ "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+ "databases": [ # Databases to be exported. <br /> <b>MySQL instances:</b> If
+ # <code>fileType</code> is <code>SQL</code> and no database is specified, all
+ # databases are exported, except for the <code>mysql</code> system database.
+ # If <code>fileType</code> is <code>CSV</code>, you can specify one database,
+ # either by using this property or by using the
+ # <code>csvExportOptions.selectQuery</code> property, which takes precedence
+ # over this property. <br /> <b>PostgreSQL instances:</b> You must specify
+ # one database to be exported. If <code>fileType</code> is <code>CSV</code>,
+ # this database must match the one specified in the
+ # <code>csvExportOptions.selectQuery</code> property.
+ "A String",
+ ],
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "tables": [ # Tables to export, or that were exported, from the specified database. If
+ # you specify tables, specify one and only one database. For PostgreSQL
+ # instances, you can specify only one table.
+ "A String",
+ ],
+ "schemaOnly": True or False, # Export only schemas.
+ "mysqlExportOptions": { # Options for exporting from MySQL.
+ "masterData": 42, # Option to include SQL statement required to set up replication.
+ # If set to <code>1</code>, the dump file includes
+ # a CHANGE MASTER TO statement with the binary log coordinates.
+ # If set to <code>2</code>, the CHANGE MASTER TO statement is written as
+ # a SQL comment, and has no effect.
+ # All other values are ignored.
+ },
+ },
+ "fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ "uri": "A String", # The path to the file in Google Cloud Storage where the export will be
+ # stored. The URI is in the form <code>gs:
+ # //bucketName/fileName</code>. If the file already exists, the requests
+ # // succeeds, but the operation fails. If <code>fileType</code> is
+ # // <code>SQL</code> and the filename ends with .gz, the contents are
+ # // compressed.
+ "csvExportOptions": { # Options for exporting data as CSV.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "kind": "A String", # This is always <code>sql#exportContext</code>.
+ },
+ "targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "startTime": "A String", # The time this operation actually started in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="clone">clone(project, instance, body=None, x__xgafv=None)</code>
+ <pre>Creates a Cloud SQL instance as a clone of the source instance. Using this
+operation might cause your instance to restart.
+
+Args:
+ project: string, Project ID of the source as well as the clone Cloud SQL instance. (required)
+ instance: string, The ID of the Cloud SQL instance to be cloned (source). This does not
+include the project ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Database instance clone request.
+ "cloneContext": { # Database instance clone context. # Contains details about the clone operation.
+ "pitrTimestampMs": "A String", # Reserved for future use.
+ "binLogCoordinates": { # Binary log coordinates. # Binary log coordinates, if specified, identify the position up to which the
+ # source instance should be cloned. If not specified, the source instance is
+ # cloned up to the most recent binary log coordinates.
+ "binLogPosition": "A String", # Position (offset) within the binary log file.
+ "kind": "A String", # This is always <code>sql#binLogCoordinates</code>.
+ "binLogFileName": "A String", # Name of the binary log file for a Cloud SQL instance.
+ },
+ "kind": "A String", # This is always <code>sql#cloneContext</code>.
+ "pointInTime": "A String", # Reserved for future use.
+ "destinationInstanceName": "A String", # Name of the Cloud SQL instance to be created as a clone.
+ },
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource.&nbsp;For successful operations that return an
+ # Operation resource, only the fields relevant to the operation are populated
+ # in the resource.
+ "user": "A String", # The email address of the user who initiated this operation.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "targetLink": "A String",
+ "operationType": "A String", # The type of the operation. Valid values are <code>CREATE</code>,
+ # <code>DELETE</code>, <code>UPDATE</code>, <code>RESTART</code>,
+ # <code>IMPORT</code>, <code>EXPORT</code>, <code>BACKUP_VOLUME</code>,
+ # <code>RESTORE_VOLUME</code>, <code>CREATE_USER</code>,
+ # <code>DELETE_USER</code>, <code>CREATE_DATABASE</code>,
+ # <code>DELETE_DATABASE</code> .
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
+ # populated.
+ "errors": [ # The list of errors encountered while processing this operation.
+ { # Database instance operation error.
+ "code": "A String", # Identifies the specific error that occurred.
+ "message": "A String", # Additional information about the error encountered.
+ "kind": "A String", # This is always <code>sql#operationError</code>.
+ },
+ ],
+ "kind": "A String", # This is always <code>sql#operationErrors</code>.
+ },
+ "kind": "A String", # This is always <code>sql#operation</code>.
+ "importContext": { # Database instance import context. # The context for import operation, if applicable.
+ "csvImportOptions": { # Options for importing data as CSV.
+ "columns": [ # The columns to which CSV data is imported. If not specified, all columns
+ # of the database table are loaded with CSV data.
+ "A String",
+ ],
+ "table": "A String", # The table to which CSV data is imported.
+ },
+ "kind": "A String", # This is always <code>sql#importContext</code>.
+ "database": "A String", # The target database for the import. If <code>fileType</code> is
+ # <code>SQL</code>, this field is required only if the import file does not
+ # specify a database, and is overridden by any database specification in the
+ # import file. If <code>fileType</code> is <code>CSV</code>, one database
+ # must be specified.
+ "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
+ "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
+ "encryptionOptions": {
+ "pvkPassword": "A String", # Password that encrypts the private key
+ "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form
+ # <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
+ # form <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ },
+ },
+ "uri": "A String", # Path to the import file in Cloud Storage, in the form
+ # <code>gs:
+ # //bucketName/fileName</code>. Compressed gzip files (.gz) are supported
+ # // when <code>fileType</code> is <code>SQL</code>. The instance must have
+ # // write permissions to the bucket and read access to the file.
+ "fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ },
+ "status": "A String", # The status of an operation. Valid values are <code>PENDING</code>,
+ # <code>RUNNING</code>, <code>DONE</code>,
+ # <code>SQL_OPERATION_STATUS_UNSPECIFIED</code>.
+ "name": "A String", # An identifier that uniquely identifies the operation. You can use this
+ # identifier to retrieve the Operations resource that has information about
+ # the operation.
+ "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+ "databases": [ # Databases to be exported. <br /> <b>MySQL instances:</b> If
+ # <code>fileType</code> is <code>SQL</code> and no database is specified, all
+ # databases are exported, except for the <code>mysql</code> system database.
+ # If <code>fileType</code> is <code>CSV</code>, you can specify one database,
+ # either by using this property or by using the
+ # <code>csvExportOptions.selectQuery</code> property, which takes precedence
+ # over this property. <br /> <b>PostgreSQL instances:</b> You must specify
+ # one database to be exported. If <code>fileType</code> is <code>CSV</code>,
+ # this database must match the one specified in the
+ # <code>csvExportOptions.selectQuery</code> property.
+ "A String",
+ ],
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "tables": [ # Tables to export, or that were exported, from the specified database. If
+ # you specify tables, specify one and only one database. For PostgreSQL
+ # instances, you can specify only one table.
+ "A String",
+ ],
+ "schemaOnly": True or False, # Export only schemas.
+ "mysqlExportOptions": { # Options for exporting from MySQL.
+ "masterData": 42, # Option to include SQL statement required to set up replication.
+ # If set to <code>1</code>, the dump file includes
+ # a CHANGE MASTER TO statement with the binary log coordinates.
+ # If set to <code>2</code>, the CHANGE MASTER TO statement is written as
+ # a SQL comment, and has no effect.
+ # All other values are ignored.
+ },
+ },
+ "fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ "uri": "A String", # The path to the file in Google Cloud Storage where the export will be
+ # stored. The URI is in the form <code>gs:
+ # //bucketName/fileName</code>. If the file already exists, the requests
+ # // succeeds, but the operation fails. If <code>fileType</code> is
+ # // <code>SQL</code> and the filename ends with .gz, the contents are
+ # // compressed.
+ "csvExportOptions": { # Options for exporting data as CSV.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "kind": "A String", # This is always <code>sql#exportContext</code>.
+ },
+ "targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "startTime": "A String", # The time this operation actually started in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(project, instance, x__xgafv=None)</code>
+ <pre>Deletes a Cloud SQL instance.
+
+Args:
+ project: string, Project ID of the project that contains the instance to be deleted. (required)
+ instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource.&nbsp;For successful operations that return an
+ # Operation resource, only the fields relevant to the operation are populated
+ # in the resource.
+ "user": "A String", # The email address of the user who initiated this operation.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "targetLink": "A String",
+ "operationType": "A String", # The type of the operation. Valid values are <code>CREATE</code>,
+ # <code>DELETE</code>, <code>UPDATE</code>, <code>RESTART</code>,
+ # <code>IMPORT</code>, <code>EXPORT</code>, <code>BACKUP_VOLUME</code>,
+ # <code>RESTORE_VOLUME</code>, <code>CREATE_USER</code>,
+ # <code>DELETE_USER</code>, <code>CREATE_DATABASE</code>,
+ # <code>DELETE_DATABASE</code> .
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
+ # populated.
+ "errors": [ # The list of errors encountered while processing this operation.
+ { # Database instance operation error.
+ "code": "A String", # Identifies the specific error that occurred.
+ "message": "A String", # Additional information about the error encountered.
+ "kind": "A String", # This is always <code>sql#operationError</code>.
+ },
+ ],
+ "kind": "A String", # This is always <code>sql#operationErrors</code>.
+ },
+ "kind": "A String", # This is always <code>sql#operation</code>.
+ "importContext": { # Database instance import context. # The context for import operation, if applicable.
+ "csvImportOptions": { # Options for importing data as CSV.
+ "columns": [ # The columns to which CSV data is imported. If not specified, all columns
+ # of the database table are loaded with CSV data.
+ "A String",
+ ],
+ "table": "A String", # The table to which CSV data is imported.
+ },
+ "kind": "A String", # This is always <code>sql#importContext</code>.
+ "database": "A String", # The target database for the import. If <code>fileType</code> is
+ # <code>SQL</code>, this field is required only if the import file does not
+ # specify a database, and is overridden by any database specification in the
+ # import file. If <code>fileType</code> is <code>CSV</code>, one database
+ # must be specified.
+ "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
+ "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
+ "encryptionOptions": {
+ "pvkPassword": "A String", # Password that encrypts the private key
+ "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form
+ # <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
+ # form <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ },
+ },
+ "uri": "A String", # Path to the import file in Cloud Storage, in the form
+ # <code>gs:
+ # //bucketName/fileName</code>. Compressed gzip files (.gz) are supported
+ # // when <code>fileType</code> is <code>SQL</code>. The instance must have
+ # // write permissions to the bucket and read access to the file.
+ "fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ },
+ "status": "A String", # The status of an operation. Valid values are <code>PENDING</code>,
+ # <code>RUNNING</code>, <code>DONE</code>,
+ # <code>SQL_OPERATION_STATUS_UNSPECIFIED</code>.
+ "name": "A String", # An identifier that uniquely identifies the operation. You can use this
+ # identifier to retrieve the Operations resource that has information about
+ # the operation.
+ "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+ "databases": [ # Databases to be exported. <br /> <b>MySQL instances:</b> If
+ # <code>fileType</code> is <code>SQL</code> and no database is specified, all
+ # databases are exported, except for the <code>mysql</code> system database.
+ # If <code>fileType</code> is <code>CSV</code>, you can specify one database,
+ # either by using this property or by using the
+ # <code>csvExportOptions.selectQuery</code> property, which takes precedence
+ # over this property. <br /> <b>PostgreSQL instances:</b> You must specify
+ # one database to be exported. If <code>fileType</code> is <code>CSV</code>,
+ # this database must match the one specified in the
+ # <code>csvExportOptions.selectQuery</code> property.
+ "A String",
+ ],
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "tables": [ # Tables to export, or that were exported, from the specified database. If
+ # you specify tables, specify one and only one database. For PostgreSQL
+ # instances, you can specify only one table.
+ "A String",
+ ],
+ "schemaOnly": True or False, # Export only schemas.
+ "mysqlExportOptions": { # Options for exporting from MySQL.
+ "masterData": 42, # Option to include SQL statement required to set up replication.
+ # If set to <code>1</code>, the dump file includes
+ # a CHANGE MASTER TO statement with the binary log coordinates.
+ # If set to <code>2</code>, the CHANGE MASTER TO statement is written as
+ # a SQL comment, and has no effect.
+ # All other values are ignored.
+ },
+ },
+ "fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ "uri": "A String", # The path to the file in Google Cloud Storage where the export will be
+ # stored. The URI is in the form <code>gs:
+ # //bucketName/fileName</code>. If the file already exists, the requests
+ # // succeeds, but the operation fails. If <code>fileType</code> is
+ # // <code>SQL</code> and the filename ends with .gz, the contents are
+ # // compressed.
+ "csvExportOptions": { # Options for exporting data as CSV.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "kind": "A String", # This is always <code>sql#exportContext</code>.
+ },
+ "targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "startTime": "A String", # The time this operation actually started in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="demoteMaster">demoteMaster(project, instance, body=None, x__xgafv=None)</code>
+ <pre>Demotes the stand-alone instance to be a Cloud SQL read replica for an
+external database server.
+
+Args:
+ project: string, ID of the project that contains the instance. (required)
+ instance: string, Cloud SQL instance name. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Database demote master request.
+ "demoteMasterContext": { # Database instance demote master context. # Contains details about the demoteMaster operation.
+ "replicaConfiguration": { # Read-replica configuration for connecting to the on-premises master. # Configuration specific to read-replicas replicating from the on-premises
+ # master.
+ "kind": "A String", # This is always <code>sql#demoteMasterConfiguration</code>.
+ "mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # 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 <code>master.info</code>
+ # in the data directory.
+ "clientCertificate": "A String", # PEM representation of the slave's x509 certificate.
+ "username": "A String", # The username for the replication connection.
+ "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
+ "kind": "A String", # This is always <code>sql#demoteMasterMysqlReplicaConfiguration</code>.
+ "password": "A String", # The password for the replication connection.
+ "clientKey": "A String", # PEM representation of the slave's private key. The corresponsing public key
+ # is encoded in the client's certificate. The format of the slave's private
+ # key can be either PKCS #1 or PKCS #8.
+ },
+ },
+ "kind": "A String", # This is always <code>sql#demoteMasterContext</code>.
+ "masterInstanceName": "A String", # The name of the instance which will act as on-premises master in the
+ # replication setup.
+ "verifyGtidConsistency": True or False, # Verify GTID consistency for demote operation. Default value:
+ # <code>True</code>. Second Generation instances only. Setting this flag to
+ # false enables you to bypass GTID consistency check between on-premises
+ # master 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.
+ },
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource.&nbsp;For successful operations that return an
+ # Operation resource, only the fields relevant to the operation are populated
+ # in the resource.
+ "user": "A String", # The email address of the user who initiated this operation.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "targetLink": "A String",
+ "operationType": "A String", # The type of the operation. Valid values are <code>CREATE</code>,
+ # <code>DELETE</code>, <code>UPDATE</code>, <code>RESTART</code>,
+ # <code>IMPORT</code>, <code>EXPORT</code>, <code>BACKUP_VOLUME</code>,
+ # <code>RESTORE_VOLUME</code>, <code>CREATE_USER</code>,
+ # <code>DELETE_USER</code>, <code>CREATE_DATABASE</code>,
+ # <code>DELETE_DATABASE</code> .
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
+ # populated.
+ "errors": [ # The list of errors encountered while processing this operation.
+ { # Database instance operation error.
+ "code": "A String", # Identifies the specific error that occurred.
+ "message": "A String", # Additional information about the error encountered.
+ "kind": "A String", # This is always <code>sql#operationError</code>.
+ },
+ ],
+ "kind": "A String", # This is always <code>sql#operationErrors</code>.
+ },
+ "kind": "A String", # This is always <code>sql#operation</code>.
+ "importContext": { # Database instance import context. # The context for import operation, if applicable.
+ "csvImportOptions": { # Options for importing data as CSV.
+ "columns": [ # The columns to which CSV data is imported. If not specified, all columns
+ # of the database table are loaded with CSV data.
+ "A String",
+ ],
+ "table": "A String", # The table to which CSV data is imported.
+ },
+ "kind": "A String", # This is always <code>sql#importContext</code>.
+ "database": "A String", # The target database for the import. If <code>fileType</code> is
+ # <code>SQL</code>, this field is required only if the import file does not
+ # specify a database, and is overridden by any database specification in the
+ # import file. If <code>fileType</code> is <code>CSV</code>, one database
+ # must be specified.
+ "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
+ "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
+ "encryptionOptions": {
+ "pvkPassword": "A String", # Password that encrypts the private key
+ "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form
+ # <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
+ # form <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ },
+ },
+ "uri": "A String", # Path to the import file in Cloud Storage, in the form
+ # <code>gs:
+ # //bucketName/fileName</code>. Compressed gzip files (.gz) are supported
+ # // when <code>fileType</code> is <code>SQL</code>. The instance must have
+ # // write permissions to the bucket and read access to the file.
+ "fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ },
+ "status": "A String", # The status of an operation. Valid values are <code>PENDING</code>,
+ # <code>RUNNING</code>, <code>DONE</code>,
+ # <code>SQL_OPERATION_STATUS_UNSPECIFIED</code>.
+ "name": "A String", # An identifier that uniquely identifies the operation. You can use this
+ # identifier to retrieve the Operations resource that has information about
+ # the operation.
+ "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+ "databases": [ # Databases to be exported. <br /> <b>MySQL instances:</b> If
+ # <code>fileType</code> is <code>SQL</code> and no database is specified, all
+ # databases are exported, except for the <code>mysql</code> system database.
+ # If <code>fileType</code> is <code>CSV</code>, you can specify one database,
+ # either by using this property or by using the
+ # <code>csvExportOptions.selectQuery</code> property, which takes precedence
+ # over this property. <br /> <b>PostgreSQL instances:</b> You must specify
+ # one database to be exported. If <code>fileType</code> is <code>CSV</code>,
+ # this database must match the one specified in the
+ # <code>csvExportOptions.selectQuery</code> property.
+ "A String",
+ ],
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "tables": [ # Tables to export, or that were exported, from the specified database. If
+ # you specify tables, specify one and only one database. For PostgreSQL
+ # instances, you can specify only one table.
+ "A String",
+ ],
+ "schemaOnly": True or False, # Export only schemas.
+ "mysqlExportOptions": { # Options for exporting from MySQL.
+ "masterData": 42, # Option to include SQL statement required to set up replication.
+ # If set to <code>1</code>, the dump file includes
+ # a CHANGE MASTER TO statement with the binary log coordinates.
+ # If set to <code>2</code>, the CHANGE MASTER TO statement is written as
+ # a SQL comment, and has no effect.
+ # All other values are ignored.
+ },
+ },
+ "fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ "uri": "A String", # The path to the file in Google Cloud Storage where the export will be
+ # stored. The URI is in the form <code>gs:
+ # //bucketName/fileName</code>. If the file already exists, the requests
+ # // succeeds, but the operation fails. If <code>fileType</code> is
+ # // <code>SQL</code> and the filename ends with .gz, the contents are
+ # // compressed.
+ "csvExportOptions": { # Options for exporting data as CSV.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "kind": "A String", # This is always <code>sql#exportContext</code>.
+ },
+ "targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "startTime": "A String", # The time this operation actually started in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="export">export(project, instance, body=None, x__xgafv=None)</code>
+ <pre>Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL
+dump or CSV file.
+
+Args:
+ project: string, Project ID of the project that contains the instance to be exported. (required)
+ instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Database instance export request.
+ "exportContext": { # Database instance export context. # Contains details about the export operation.
+ "databases": [ # Databases to be exported. <br /> <b>MySQL instances:</b> If
+ # <code>fileType</code> is <code>SQL</code> and no database is specified, all
+ # databases are exported, except for the <code>mysql</code> system database.
+ # If <code>fileType</code> is <code>CSV</code>, you can specify one database,
+ # either by using this property or by using the
+ # <code>csvExportOptions.selectQuery</code> property, which takes precedence
+ # over this property. <br /> <b>PostgreSQL instances:</b> You must specify
+ # one database to be exported. If <code>fileType</code> is <code>CSV</code>,
+ # this database must match the one specified in the
+ # <code>csvExportOptions.selectQuery</code> property.
+ "A String",
+ ],
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "tables": [ # Tables to export, or that were exported, from the specified database. If
+ # you specify tables, specify one and only one database. For PostgreSQL
+ # instances, you can specify only one table.
+ "A String",
+ ],
+ "schemaOnly": True or False, # Export only schemas.
+ "mysqlExportOptions": { # Options for exporting from MySQL.
+ "masterData": 42, # Option to include SQL statement required to set up replication.
+ # If set to <code>1</code>, the dump file includes
+ # a CHANGE MASTER TO statement with the binary log coordinates.
+ # If set to <code>2</code>, the CHANGE MASTER TO statement is written as
+ # a SQL comment, and has no effect.
+ # All other values are ignored.
+ },
+ },
+ "fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ "uri": "A String", # The path to the file in Google Cloud Storage where the export will be
+ # stored. The URI is in the form <code>gs:
+ # //bucketName/fileName</code>. If the file already exists, the requests
+ # // succeeds, but the operation fails. If <code>fileType</code> is
+ # // <code>SQL</code> and the filename ends with .gz, the contents are
+ # // compressed.
+ "csvExportOptions": { # Options for exporting data as CSV.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "kind": "A String", # This is always <code>sql#exportContext</code>.
+ },
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource.&nbsp;For successful operations that return an
+ # Operation resource, only the fields relevant to the operation are populated
+ # in the resource.
+ "user": "A String", # The email address of the user who initiated this operation.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "targetLink": "A String",
+ "operationType": "A String", # The type of the operation. Valid values are <code>CREATE</code>,
+ # <code>DELETE</code>, <code>UPDATE</code>, <code>RESTART</code>,
+ # <code>IMPORT</code>, <code>EXPORT</code>, <code>BACKUP_VOLUME</code>,
+ # <code>RESTORE_VOLUME</code>, <code>CREATE_USER</code>,
+ # <code>DELETE_USER</code>, <code>CREATE_DATABASE</code>,
+ # <code>DELETE_DATABASE</code> .
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
+ # populated.
+ "errors": [ # The list of errors encountered while processing this operation.
+ { # Database instance operation error.
+ "code": "A String", # Identifies the specific error that occurred.
+ "message": "A String", # Additional information about the error encountered.
+ "kind": "A String", # This is always <code>sql#operationError</code>.
+ },
+ ],
+ "kind": "A String", # This is always <code>sql#operationErrors</code>.
+ },
+ "kind": "A String", # This is always <code>sql#operation</code>.
+ "importContext": { # Database instance import context. # The context for import operation, if applicable.
+ "csvImportOptions": { # Options for importing data as CSV.
+ "columns": [ # The columns to which CSV data is imported. If not specified, all columns
+ # of the database table are loaded with CSV data.
+ "A String",
+ ],
+ "table": "A String", # The table to which CSV data is imported.
+ },
+ "kind": "A String", # This is always <code>sql#importContext</code>.
+ "database": "A String", # The target database for the import. If <code>fileType</code> is
+ # <code>SQL</code>, this field is required only if the import file does not
+ # specify a database, and is overridden by any database specification in the
+ # import file. If <code>fileType</code> is <code>CSV</code>, one database
+ # must be specified.
+ "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
+ "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
+ "encryptionOptions": {
+ "pvkPassword": "A String", # Password that encrypts the private key
+ "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form
+ # <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
+ # form <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ },
+ },
+ "uri": "A String", # Path to the import file in Cloud Storage, in the form
+ # <code>gs:
+ # //bucketName/fileName</code>. Compressed gzip files (.gz) are supported
+ # // when <code>fileType</code> is <code>SQL</code>. The instance must have
+ # // write permissions to the bucket and read access to the file.
+ "fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ },
+ "status": "A String", # The status of an operation. Valid values are <code>PENDING</code>,
+ # <code>RUNNING</code>, <code>DONE</code>,
+ # <code>SQL_OPERATION_STATUS_UNSPECIFIED</code>.
+ "name": "A String", # An identifier that uniquely identifies the operation. You can use this
+ # identifier to retrieve the Operations resource that has information about
+ # the operation.
+ "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+ "databases": [ # Databases to be exported. <br /> <b>MySQL instances:</b> If
+ # <code>fileType</code> is <code>SQL</code> and no database is specified, all
+ # databases are exported, except for the <code>mysql</code> system database.
+ # If <code>fileType</code> is <code>CSV</code>, you can specify one database,
+ # either by using this property or by using the
+ # <code>csvExportOptions.selectQuery</code> property, which takes precedence
+ # over this property. <br /> <b>PostgreSQL instances:</b> You must specify
+ # one database to be exported. If <code>fileType</code> is <code>CSV</code>,
+ # this database must match the one specified in the
+ # <code>csvExportOptions.selectQuery</code> property.
+ "A String",
+ ],
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "tables": [ # Tables to export, or that were exported, from the specified database. If
+ # you specify tables, specify one and only one database. For PostgreSQL
+ # instances, you can specify only one table.
+ "A String",
+ ],
+ "schemaOnly": True or False, # Export only schemas.
+ "mysqlExportOptions": { # Options for exporting from MySQL.
+ "masterData": 42, # Option to include SQL statement required to set up replication.
+ # If set to <code>1</code>, the dump file includes
+ # a CHANGE MASTER TO statement with the binary log coordinates.
+ # If set to <code>2</code>, the CHANGE MASTER TO statement is written as
+ # a SQL comment, and has no effect.
+ # All other values are ignored.
+ },
+ },
+ "fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ "uri": "A String", # The path to the file in Google Cloud Storage where the export will be
+ # stored. The URI is in the form <code>gs:
+ # //bucketName/fileName</code>. If the file already exists, the requests
+ # // succeeds, but the operation fails. If <code>fileType</code> is
+ # // <code>SQL</code> and the filename ends with .gz, the contents are
+ # // compressed.
+ "csvExportOptions": { # Options for exporting data as CSV.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "kind": "A String", # This is always <code>sql#exportContext</code>.
+ },
+ "targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "startTime": "A String", # The time this operation actually started in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="failover">failover(project, instance, body=None, x__xgafv=None)</code>
+ <pre>Failover the instance to its failover replica instance. Using this
+operation might cause your instance to restart.
+
+Args:
+ project: string, ID of the project that contains the read replica. (required)
+ instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Instance failover request.
+ "failoverContext": { # Database instance failover context. # Failover Context.
+ "settingsVersion": "A String", # The current settings version of this instance. Request will be rejected if
+ # this version doesn't match the current settings version.
+ "kind": "A String", # This is always <code>sql#failoverContext</code>.
+ },
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource.&nbsp;For successful operations that return an
+ # Operation resource, only the fields relevant to the operation are populated
+ # in the resource.
+ "user": "A String", # The email address of the user who initiated this operation.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "targetLink": "A String",
+ "operationType": "A String", # The type of the operation. Valid values are <code>CREATE</code>,
+ # <code>DELETE</code>, <code>UPDATE</code>, <code>RESTART</code>,
+ # <code>IMPORT</code>, <code>EXPORT</code>, <code>BACKUP_VOLUME</code>,
+ # <code>RESTORE_VOLUME</code>, <code>CREATE_USER</code>,
+ # <code>DELETE_USER</code>, <code>CREATE_DATABASE</code>,
+ # <code>DELETE_DATABASE</code> .
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
+ # populated.
+ "errors": [ # The list of errors encountered while processing this operation.
+ { # Database instance operation error.
+ "code": "A String", # Identifies the specific error that occurred.
+ "message": "A String", # Additional information about the error encountered.
+ "kind": "A String", # This is always <code>sql#operationError</code>.
+ },
+ ],
+ "kind": "A String", # This is always <code>sql#operationErrors</code>.
+ },
+ "kind": "A String", # This is always <code>sql#operation</code>.
+ "importContext": { # Database instance import context. # The context for import operation, if applicable.
+ "csvImportOptions": { # Options for importing data as CSV.
+ "columns": [ # The columns to which CSV data is imported. If not specified, all columns
+ # of the database table are loaded with CSV data.
+ "A String",
+ ],
+ "table": "A String", # The table to which CSV data is imported.
+ },
+ "kind": "A String", # This is always <code>sql#importContext</code>.
+ "database": "A String", # The target database for the import. If <code>fileType</code> is
+ # <code>SQL</code>, this field is required only if the import file does not
+ # specify a database, and is overridden by any database specification in the
+ # import file. If <code>fileType</code> is <code>CSV</code>, one database
+ # must be specified.
+ "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
+ "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
+ "encryptionOptions": {
+ "pvkPassword": "A String", # Password that encrypts the private key
+ "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form
+ # <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
+ # form <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ },
+ },
+ "uri": "A String", # Path to the import file in Cloud Storage, in the form
+ # <code>gs:
+ # //bucketName/fileName</code>. Compressed gzip files (.gz) are supported
+ # // when <code>fileType</code> is <code>SQL</code>. The instance must have
+ # // write permissions to the bucket and read access to the file.
+ "fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ },
+ "status": "A String", # The status of an operation. Valid values are <code>PENDING</code>,
+ # <code>RUNNING</code>, <code>DONE</code>,
+ # <code>SQL_OPERATION_STATUS_UNSPECIFIED</code>.
+ "name": "A String", # An identifier that uniquely identifies the operation. You can use this
+ # identifier to retrieve the Operations resource that has information about
+ # the operation.
+ "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+ "databases": [ # Databases to be exported. <br /> <b>MySQL instances:</b> If
+ # <code>fileType</code> is <code>SQL</code> and no database is specified, all
+ # databases are exported, except for the <code>mysql</code> system database.
+ # If <code>fileType</code> is <code>CSV</code>, you can specify one database,
+ # either by using this property or by using the
+ # <code>csvExportOptions.selectQuery</code> property, which takes precedence
+ # over this property. <br /> <b>PostgreSQL instances:</b> You must specify
+ # one database to be exported. If <code>fileType</code> is <code>CSV</code>,
+ # this database must match the one specified in the
+ # <code>csvExportOptions.selectQuery</code> property.
+ "A String",
+ ],
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "tables": [ # Tables to export, or that were exported, from the specified database. If
+ # you specify tables, specify one and only one database. For PostgreSQL
+ # instances, you can specify only one table.
+ "A String",
+ ],
+ "schemaOnly": True or False, # Export only schemas.
+ "mysqlExportOptions": { # Options for exporting from MySQL.
+ "masterData": 42, # Option to include SQL statement required to set up replication.
+ # If set to <code>1</code>, the dump file includes
+ # a CHANGE MASTER TO statement with the binary log coordinates.
+ # If set to <code>2</code>, the CHANGE MASTER TO statement is written as
+ # a SQL comment, and has no effect.
+ # All other values are ignored.
+ },
+ },
+ "fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ "uri": "A String", # The path to the file in Google Cloud Storage where the export will be
+ # stored. The URI is in the form <code>gs:
+ # //bucketName/fileName</code>. If the file already exists, the requests
+ # // succeeds, but the operation fails. If <code>fileType</code> is
+ # // <code>SQL</code> and the filename ends with .gz, the contents are
+ # // compressed.
+ "csvExportOptions": { # Options for exporting data as CSV.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "kind": "A String", # This is always <code>sql#exportContext</code>.
+ },
+ "targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "startTime": "A String", # The time this operation actually started in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(project, instance, x__xgafv=None)</code>
+ <pre>Retrieves a resource containing information about a Cloud SQL instance.
+
+Args:
+ project: string, Project ID of the project that contains the instance. (required)
+ instance: string, Database instance ID. This does not include the project ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A Cloud SQL instance resource.
+ "ipv6Address": "A String", # The IPv6 address assigned to the instance. This property is applicable only
+ # to First Generation instances.
+ "selfLink": "A String", # The URI of this resource.
+ "diskEncryptionStatus": { # Disk encryption status for an instance. # Disk encryption status specific to an instance.
+ # Applies only to Second Generation instances.
+ "kmsKeyVersionName": "A String", # KMS key version used to encrypt the Cloud SQL instance resource
+ "kind": "A String", # This is always <code>sql#diskEncryptionStatus</code>.
+ },
+ "kind": "A String", # This is always <code>sql#instance</code>.
+ "region": "A String", # The geographical region. Can be <code>us-central</code>
+ # (<code>FIRST_GEN</code> instances only), <code>us-central1</code>
+ # (<code>SECOND_GEN</code> instances only), <code>asia-east1</code> or
+ # <code>europe-west1</code>. Defaults to <code>us-central</code> or
+ # <code>us-central1</code> depending on the instance type (First Generation
+ # or Second Generation). The region can not be changed after instance
+ # creation.
+ "state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the
+ # following. <br><code>RUNNABLE</code>: The instance is running, or is ready
+ # to run when accessed. <br><code>SUSPENDED</code>: The instance is not
+ # available, for example due to problems with billing.
+ # <br><code>PENDING_CREATE</code>: The instance is being created.
+ # <br><code>MAINTENANCE</code>: The instance is down for maintenance.
+ # <br><code>FAILED</code>: The instance creation failed.
+ # <br><code>UNKNOWN_STATE</code>: The state of the instance is unknown.
+ "backendType": "A String", # <code>FIRST_GEN</code>: First Generation instance. MySQL only. <br
+ # /><code>SECOND_GEN</code>: Second Generation instance or PostgreSQL
+ # instance. <br /><code>EXTERNAL</code>: A database server that is not
+ # managed by Google. <br>This property is read-only; use the
+ # <code>tier</code> property in the <code>settings</code> object to determine
+ # the database type and Second or First Generation.
+ "onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances.
+ "hostPort": "A String", # The host and port of the on-premises instance in host:port format
+ "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica.
+ "clientCertificate": "A String", # PEM representation of the slave's x509 certificate.
+ "username": "A String", # The username for connecting to on-premises instance.
+ "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
+ "kind": "A String", # This is always <code>sql#onPremisesConfiguration</code>.
+ "password": "A String", # The password for connecting to on-premises instance.
+ "clientKey": "A String", # PEM representation of the slave's private key. The corresponsing public key
+ # is encoded in the client's certificate.
+ },
+ "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google
+ # apps domain is prefixed if applicable.
+ "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance. This property
+ # is applicable only to Second Generation instances.
+ "databaseVersion": "A String", # The database engine type and version. The <code>databaseVersion</code>
+ # field can not be changed after instance creation. MySQL Second Generation
+ # instances: <code>MYSQL_5_7</code> (default) or <code>MYSQL_5_6</code>.
+ # PostgreSQL instances: <code>POSTGRES_9_6</code> (default) or
+ # <code>POSTGRES_11 Beta</code> MySQL First Generation
+ # instances: <code>MYSQL_5_6</code> (default) or <code>MYSQL_5_5</code>
+ "suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension.
+ "A String",
+ ],
+ "settings": { # Database instance settings. # The user settings.
+ "ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the
+ # instance IP and manage which external networks can connect to the instance.
+ # The IPv4 address cannot be disabled for Second Generation instances.
+ "privateNetwork": "A String", # The resource link for the VPC network from which the Cloud SQL instance is
+ # accessible for private IP. For example,
+ # <code>/projects/myProject/global/networks/default</code>. This setting can
+ # be updated, but it cannot be removed after it is set.
+ "ipv4Enabled": True or False, # Whether the instance should be assigned an IP address or not.
+ "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance
+ # using the IP. In <a
+ # href="http://en.wikipedia.org/wiki/CIDR_notation#CIDR_notation">CIDR
+ # notation</a>, also known as 'slash' notation (e.g.
+ # <code>192.168.100.0/24</code>).
+ { # An entry for an Access Control list.
+ "value": "A String", # The whitelisted value for the access control list.
+ "expirationTime": "A String", # The time when this access control entry expires in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "name": "A String", # Optional. A label to identify this entry.
+ "kind": "A String", # This is always <code>sql#aclEntry</code>.
+ },
+ ],
+ "requireSsl": True or False, # Whether SSL connections over IP should be enforced or not.
+ },
+ "availabilityType": "A String", # Availability type (PostgreSQL and MySQL instances only). Potential values:
+ # <br><code>ZONAL</code>: The instance serves data from only one zone.
+ # Outages in that zone affect data accessibility. <br><code>REGIONAL</code>:
+ # The instance can serve data from more than one zone in a region (it is
+ # highly available). <br>For more information, see <a
+ # href="https://cloud.google.com/sql/docs/postgres/high-availability">Overview
+ # of the High Availability Configuration</a>.
+ "settingsVersion": "A String", # The version of instance settings. This is a required field for update
+ # method to make sure concurrent updates are handled properly. During update,
+ # use the most recent settingsVersion value for this instance and do not try
+ # to update this value.
+ "databaseFlags": [ # The database flags passed to the instance at startup.
+ { # Database flags for Cloud SQL instances.
+ "value": "A String", # The value of the flag. Booleans should be set to <code>on</code> for true
+ # and <code>off</code> for false. This field must be omitted if the flag
+ # doesn't take a value.
+ "name": "A String", # The name of the flag. These flags are passed at instance startup, so
+ # include both server options and system variables for MySQL. Flags should be
+ # specified with underscores, not hyphens. For more information, see <a
+ # href="/sql/docs/mysql/flags">Configuring Database Flags</a> in the Cloud
+ # SQL documentation.
+ },
+ ],
+ "maintenanceWindow": { # Maintenance window. This specifies when a v2 Cloud SQL instance should # The maintenance window for this instance. This specifies when the instance
+ # can be restarted for maintenance purposes. Not used for First Generation
+ # instances.
+ # preferably be restarted for system maintenance purposes.
+ "updateTrack": "A String", # Maintenance timing setting: <code>canary</code> (Earlier) or
+ # <code>stable</code> (Later). <br /><a
+ # href="/sql/docs/db_path/instance-settings#maintenance-timing-2ndgen">
+ # Learn more</a>.
+ "hour": 42, # hour of day - 0 to 23.
+ "day": 42, # day of week (1-7), starting on Monday.
+ "kind": "A String", # This is always <code>sql#maintenanceWindow</code>.
+ },
+ "pricingPlan": "A String", # The pricing plan for this instance. This can be either <code>PER_USE</code>
+ # or <code>PACKAGE</code>. Only <code>PER_USE</code> is supported for Second
+ # Generation instances.
+ "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is
+ # true. Not used for First Generation instances.
+ "storageAutoResizeLimit": "A String", # The maximum size to which storage capacity can be automatically increased.
+ # The default value is 0, which specifies that there is no limit. Not used
+ # for First Generation instances.
+ "authorizedGaeApplications": [ # The App Engine app IDs that can access this instance. First Generation
+ # instances only.
+ "A String",
+ ],
+ "tier": "A String", # The tier (or machine type) for this instance, for example
+ # <code>db-n1-standard-1</code> (MySQL instances) or
+ # <code>db-custom-1-3840</code> (PostgreSQL instances). For MySQL instances,
+ # this property determines whether the instance is First or Second
+ # Generation. For more information, see <a
+ # href="/sql/docs/db_path/instance-settings">Instance Settings</a>.
+ "dataDiskSizeGb": "A String", # The size of data disk, in GB. The data disk size minimum is 10GB. Not used
+ # for First Generation instances.
+ "dataDiskType": "A String", # The type of data disk: <code>PD_SSD</code> (default) or
+ # <code>PD_HDD</code>. Not used for First Generation instances.
+ "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether
+ # replication is enabled or not.
+ "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether
+ # database flags for crash-safe replication are enabled. This property is
+ # only applicable to First Generation instances.
+ "backupConfiguration": { # Database instance backup configuration. # The daily backup configuration for the instance.
+ "pointInTimeRecoveryEnabled": True or False, # Reserved for future use.
+ "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24
+ # hour format - <code>HH:MM</code>.
+ "kind": "A String", # This is always <code>sql#backupConfiguration</code>.
+ "enabled": True or False, # Whether this configuration is enabled.
+ "binaryLogEnabled": True or False, # (MySQL only) Whether binary log is enabled. If backup configuration is
+ # disabled, binarylog must be disabled as well.
+ "replicationLogArchivingEnabled": True or False, # Reserved for future use.
+ "location": "A String", # Location of the backup
+ },
+ "userLabels": { # User-provided labels, represented as a dictionary where each label is a
+ # single key value pair.
+ "a_key": "A String",
+ },
+ "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance should # The location preference settings. This allows the instance to be located as
+ # near as possible to either an App Engine app or Compute Engine zone for
+ # better performance. App Engine co-location is only applicable to First
+ # Generation instances.
+ # preferably be located, either in a specific Compute Engine zone, or
+ # co-located with an App Engine application. Note that if the preferred
+ # location is not available, the instance will be located as close as possible
+ # within the region. Only one location may be specified.
+ "followGaeApplication": "A String", # The AppEngine application to follow, it must be in the same region as the
+ # Cloud SQL instance.
+ "kind": "A String", # This is always <code>sql#locationPreference</code>.
+ "zone": "A String", # The preferred Compute Engine zone (e.g. us-central1-a, us-central1-b,
+ # etc.).
+ },
+ "kind": "A String", # This is always <code>sql#settings</code>.
+ "replicationType": "A String", # The type of replication this instance uses. This can be either
+ # <code>ASYNCHRONOUS</code> or <code>SYNCHRONOUS</code>. This property is
+ # only applicable to First Generation instances.
+ "activationPolicy": "A String", # The activation policy specifies when the instance is activated; it is
+ # applicable only when the instance state is <code>RUNNABLE</code>. Valid
+ # values: <br><code>ALWAYS</code>: The instance is on, and remains so even in
+ # the absence of connection requests. <br><code>NEVER</code>: The instance is
+ # off; it is not activated, even if a connection request arrives.
+ # <br><code>ON_DEMAND</code>: First Generation instances only. The instance
+ # responds to incoming requests, and turns itself off when not in use.
+ # Instances with <code>PER_USE</code> pricing turn off after 15 minutes of
+ # inactivity. Instances with <code>PER_PACKAGE</code> pricing turn off after
+ # 12 hours of inactivity.
+ },
+ "replicaNames": [ # The replicas of the instance.
+ "A String",
+ ],
+ "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance.
+ # Applies only to Second Generation instances.
+ "kind": "A String", # This is always <code>sql#diskEncryptionConfiguration</code>.
+ "kmsKeyName": "A String", # Resource name of KMS key for disk encryption
+ },
+ "rootPassword": "A String", # Initial root password. Use only on creation.
+ "scheduledMaintenance": { # Any scheduled maintenancce for this instance. # The start time of any upcoming scheduled maintenance for this instance.
+ "canReschedule": True or False, # If the scheduled maintenance can be rescheduled.
+ "canDefer": True or False,
+ "startTime": "A String", # The start time of any upcoming scheduled maintenance for this instance.
+ },
+ "etag": "A String", # This field is deprecated and will be removed from a future version of the
+ # API. Use the <code>settings.settingsVersion</code> field instead.
+ "serverCaCert": { # SslCerts Resource # SSL configuration.
+ "selfLink": "A String", # The URI of this resource.
+ "expirationTime": "A String", # The time when the certificate expires in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "sha1Fingerprint": "A String", # Sha1 Fingerprint.
+ "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
+ "cert": "A String", # PEM representation.
+ "kind": "A String", # This is always <code>sql#sslCert</code>.
+ "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
+ "createTime": "A String", # The time when the certificate was created in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>
+ "instance": "A String", # Name of the database instance.
+ },
+ "maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
+ "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
+ "masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup.
+ "instanceType": "A String", # The instance type. This can be one of the following.
+ # <br><code>CLOUD_SQL_INSTANCE</code>: A Cloud SQL instance that is not
+ # replicating from a master. <br><code>ON_PREMISES_INSTANCE</code>: An
+ # instance running on the
+ # customer's premises. <br><code>READ_REPLICA_INSTANCE</code>: A Cloud SQL
+ # instance configured as a read-replica.
+ "gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This
+ # value could be different from the zone that was specified when the instance
+ # was created if the instance has failed over to its secondary zone.
+ "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been
+ # deprecated. Users should use the
+ # "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud
+ # Monitoring API instead. Please see <a
+ # href="https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ">this
+ # announcement</a> for details.
+ "replicaConfiguration": { # Read-replica configuration for connecting to the master. # Configuration specific to failover replicas and read replicas.
+ "kind": "A String", # This is always <code>sql#replicaConfiguration</code>.
+ "mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # 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 <code>master.info</code>
+ # in the data directory.
+ "kind": "A String", # This is always <code>sql#mysqlReplicaConfiguration</code>.
+ "password": "A String", # The password for the replication connection.
+ "verifyServerCertificate": True or False, # Whether or not to check the master's Common Name value in the certificate
+ # that it sends during the SSL handshake.
+ "clientKey": "A String", # PEM representation of the slave's private key. The corresponsing public key
+ # is encoded in the client's certificate.
+ "sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption.
+ "masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats.
+ "connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds.
+ "dumpFilePath": "A String", # Path to a SQL dump file in Google Cloud Storage from which the slave
+ # instance is to be created. The URI is in the form gs:
+ # //bucketName/fileName. Compressed gzip files (.gz) are also supported.
+ # // Dumps should have the binlog co-ordinates from which replication should
+ # // begin. This can be accomplished by setting --master-data to 1 when using
+ # // mysqldump.
+ "clientCertificate": "A String", # PEM representation of the slave's x509 certificate.
+ "username": "A String", # The username for the replication connection.
+ "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
+ },
+ "failoverTarget": True or False, # Specifies if the replica is the failover target. If the field is set to
+ # <code>true</code> 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. <p>Only one replica can be specified as failover
+ # target, and the replica has to be in different zone with the master
+ # instance.
+ },
+ "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.
+ "failoverReplica": { # The name and status of the failover replica. This property is applicable
+ # only to Second Generation instances.
+ "available": True or False, # The availability status of the failover replica. A false status indicates
+ # that the failover replica is out of sync. The master can only failover to
+ # the failover replica when the status is true.
+ "name": "A String", # The name of the failover replica. If specified at instance creation, a
+ # failover replica is created for the instance. The name
+ # doesn't include the project ID. This property is applicable only to
+ # Second Generation instances.
+ },
+ "ipAddresses": [ # The assigned IP addresses for the instance.
+ { # Database instance IP Mapping.
+ "timeToRetire": "A String", # The due time for this IP to be retired in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>. This field is only available when
+ # the IP is scheduled to be retired.
+ "type": "A String", # The type of this IP address. A <code>PRIMARY</code> address is a public
+ # address that can accept incoming connections. A <code>PRIVATE</code>
+ # address is a private address that can accept incoming connections. An
+ # <code>OUTGOING</code> address is the source address of connections
+ # originating from the instance, if supported.
+ "ipAddress": "A String", # The IP address assigned.
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="import_">import_(project, instance, body=None, x__xgafv=None)</code>
+ <pre>Imports data into a Cloud SQL instance from a SQL dump or CSV file in
+Cloud Storage.
+
+Args:
+ project: string, Project ID of the project that contains the instance. (required)
+ instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Database instance import request.
+ "importContext": { # Database instance import context. # Contains details about the import operation.
+ "csvImportOptions": { # Options for importing data as CSV.
+ "columns": [ # The columns to which CSV data is imported. If not specified, all columns
+ # of the database table are loaded with CSV data.
+ "A String",
+ ],
+ "table": "A String", # The table to which CSV data is imported.
+ },
+ "kind": "A String", # This is always <code>sql#importContext</code>.
+ "database": "A String", # The target database for the import. If <code>fileType</code> is
+ # <code>SQL</code>, this field is required only if the import file does not
+ # specify a database, and is overridden by any database specification in the
+ # import file. If <code>fileType</code> is <code>CSV</code>, one database
+ # must be specified.
+ "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
+ "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
+ "encryptionOptions": {
+ "pvkPassword": "A String", # Password that encrypts the private key
+ "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form
+ # <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
+ # form <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ },
+ },
+ "uri": "A String", # Path to the import file in Cloud Storage, in the form
+ # <code>gs:
+ # //bucketName/fileName</code>. Compressed gzip files (.gz) are supported
+ # // when <code>fileType</code> is <code>SQL</code>. The instance must have
+ # // write permissions to the bucket and read access to the file.
+ "fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ },
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource.&nbsp;For successful operations that return an
+ # Operation resource, only the fields relevant to the operation are populated
+ # in the resource.
+ "user": "A String", # The email address of the user who initiated this operation.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "targetLink": "A String",
+ "operationType": "A String", # The type of the operation. Valid values are <code>CREATE</code>,
+ # <code>DELETE</code>, <code>UPDATE</code>, <code>RESTART</code>,
+ # <code>IMPORT</code>, <code>EXPORT</code>, <code>BACKUP_VOLUME</code>,
+ # <code>RESTORE_VOLUME</code>, <code>CREATE_USER</code>,
+ # <code>DELETE_USER</code>, <code>CREATE_DATABASE</code>,
+ # <code>DELETE_DATABASE</code> .
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
+ # populated.
+ "errors": [ # The list of errors encountered while processing this operation.
+ { # Database instance operation error.
+ "code": "A String", # Identifies the specific error that occurred.
+ "message": "A String", # Additional information about the error encountered.
+ "kind": "A String", # This is always <code>sql#operationError</code>.
+ },
+ ],
+ "kind": "A String", # This is always <code>sql#operationErrors</code>.
+ },
+ "kind": "A String", # This is always <code>sql#operation</code>.
+ "importContext": { # Database instance import context. # The context for import operation, if applicable.
+ "csvImportOptions": { # Options for importing data as CSV.
+ "columns": [ # The columns to which CSV data is imported. If not specified, all columns
+ # of the database table are loaded with CSV data.
+ "A String",
+ ],
+ "table": "A String", # The table to which CSV data is imported.
+ },
+ "kind": "A String", # This is always <code>sql#importContext</code>.
+ "database": "A String", # The target database for the import. If <code>fileType</code> is
+ # <code>SQL</code>, this field is required only if the import file does not
+ # specify a database, and is overridden by any database specification in the
+ # import file. If <code>fileType</code> is <code>CSV</code>, one database
+ # must be specified.
+ "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
+ "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
+ "encryptionOptions": {
+ "pvkPassword": "A String", # Password that encrypts the private key
+ "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form
+ # <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
+ # form <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ },
+ },
+ "uri": "A String", # Path to the import file in Cloud Storage, in the form
+ # <code>gs:
+ # //bucketName/fileName</code>. Compressed gzip files (.gz) are supported
+ # // when <code>fileType</code> is <code>SQL</code>. The instance must have
+ # // write permissions to the bucket and read access to the file.
+ "fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ },
+ "status": "A String", # The status of an operation. Valid values are <code>PENDING</code>,
+ # <code>RUNNING</code>, <code>DONE</code>,
+ # <code>SQL_OPERATION_STATUS_UNSPECIFIED</code>.
+ "name": "A String", # An identifier that uniquely identifies the operation. You can use this
+ # identifier to retrieve the Operations resource that has information about
+ # the operation.
+ "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+ "databases": [ # Databases to be exported. <br /> <b>MySQL instances:</b> If
+ # <code>fileType</code> is <code>SQL</code> and no database is specified, all
+ # databases are exported, except for the <code>mysql</code> system database.
+ # If <code>fileType</code> is <code>CSV</code>, you can specify one database,
+ # either by using this property or by using the
+ # <code>csvExportOptions.selectQuery</code> property, which takes precedence
+ # over this property. <br /> <b>PostgreSQL instances:</b> You must specify
+ # one database to be exported. If <code>fileType</code> is <code>CSV</code>,
+ # this database must match the one specified in the
+ # <code>csvExportOptions.selectQuery</code> property.
+ "A String",
+ ],
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "tables": [ # Tables to export, or that were exported, from the specified database. If
+ # you specify tables, specify one and only one database. For PostgreSQL
+ # instances, you can specify only one table.
+ "A String",
+ ],
+ "schemaOnly": True or False, # Export only schemas.
+ "mysqlExportOptions": { # Options for exporting from MySQL.
+ "masterData": 42, # Option to include SQL statement required to set up replication.
+ # If set to <code>1</code>, the dump file includes
+ # a CHANGE MASTER TO statement with the binary log coordinates.
+ # If set to <code>2</code>, the CHANGE MASTER TO statement is written as
+ # a SQL comment, and has no effect.
+ # All other values are ignored.
+ },
+ },
+ "fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ "uri": "A String", # The path to the file in Google Cloud Storage where the export will be
+ # stored. The URI is in the form <code>gs:
+ # //bucketName/fileName</code>. If the file already exists, the requests
+ # // succeeds, but the operation fails. If <code>fileType</code> is
+ # // <code>SQL</code> and the filename ends with .gz, the contents are
+ # // compressed.
+ "csvExportOptions": { # Options for exporting data as CSV.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "kind": "A String", # This is always <code>sql#exportContext</code>.
+ },
+ "targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "startTime": "A String", # The time this operation actually started in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, body=None, x__xgafv=None)</code>
+ <pre>Creates a new Cloud SQL instance.
+
+Args:
+ project: string, Project ID of the project to which the newly created Cloud SQL instances
+should belong. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A Cloud SQL instance resource.
+ "ipv6Address": "A String", # The IPv6 address assigned to the instance. This property is applicable only
+ # to First Generation instances.
+ "selfLink": "A String", # The URI of this resource.
+ "diskEncryptionStatus": { # Disk encryption status for an instance. # Disk encryption status specific to an instance.
+ # Applies only to Second Generation instances.
+ "kmsKeyVersionName": "A String", # KMS key version used to encrypt the Cloud SQL instance resource
+ "kind": "A String", # This is always <code>sql#diskEncryptionStatus</code>.
+ },
+ "kind": "A String", # This is always <code>sql#instance</code>.
+ "region": "A String", # The geographical region. Can be <code>us-central</code>
+ # (<code>FIRST_GEN</code> instances only), <code>us-central1</code>
+ # (<code>SECOND_GEN</code> instances only), <code>asia-east1</code> or
+ # <code>europe-west1</code>. Defaults to <code>us-central</code> or
+ # <code>us-central1</code> depending on the instance type (First Generation
+ # or Second Generation). The region can not be changed after instance
+ # creation.
+ "state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the
+ # following. <br><code>RUNNABLE</code>: The instance is running, or is ready
+ # to run when accessed. <br><code>SUSPENDED</code>: The instance is not
+ # available, for example due to problems with billing.
+ # <br><code>PENDING_CREATE</code>: The instance is being created.
+ # <br><code>MAINTENANCE</code>: The instance is down for maintenance.
+ # <br><code>FAILED</code>: The instance creation failed.
+ # <br><code>UNKNOWN_STATE</code>: The state of the instance is unknown.
+ "backendType": "A String", # <code>FIRST_GEN</code>: First Generation instance. MySQL only. <br
+ # /><code>SECOND_GEN</code>: Second Generation instance or PostgreSQL
+ # instance. <br /><code>EXTERNAL</code>: A database server that is not
+ # managed by Google. <br>This property is read-only; use the
+ # <code>tier</code> property in the <code>settings</code> object to determine
+ # the database type and Second or First Generation.
+ "onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances.
+ "hostPort": "A String", # The host and port of the on-premises instance in host:port format
+ "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica.
+ "clientCertificate": "A String", # PEM representation of the slave's x509 certificate.
+ "username": "A String", # The username for connecting to on-premises instance.
+ "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
+ "kind": "A String", # This is always <code>sql#onPremisesConfiguration</code>.
+ "password": "A String", # The password for connecting to on-premises instance.
+ "clientKey": "A String", # PEM representation of the slave's private key. The corresponsing public key
+ # is encoded in the client's certificate.
+ },
+ "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google
+ # apps domain is prefixed if applicable.
+ "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance. This property
+ # is applicable only to Second Generation instances.
+ "databaseVersion": "A String", # The database engine type and version. The <code>databaseVersion</code>
+ # field can not be changed after instance creation. MySQL Second Generation
+ # instances: <code>MYSQL_5_7</code> (default) or <code>MYSQL_5_6</code>.
+ # PostgreSQL instances: <code>POSTGRES_9_6</code> (default) or
+ # <code>POSTGRES_11 Beta</code> MySQL First Generation
+ # instances: <code>MYSQL_5_6</code> (default) or <code>MYSQL_5_5</code>
+ "suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension.
+ "A String",
+ ],
+ "settings": { # Database instance settings. # The user settings.
+ "ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the
+ # instance IP and manage which external networks can connect to the instance.
+ # The IPv4 address cannot be disabled for Second Generation instances.
+ "privateNetwork": "A String", # The resource link for the VPC network from which the Cloud SQL instance is
+ # accessible for private IP. For example,
+ # <code>/projects/myProject/global/networks/default</code>. This setting can
+ # be updated, but it cannot be removed after it is set.
+ "ipv4Enabled": True or False, # Whether the instance should be assigned an IP address or not.
+ "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance
+ # using the IP. In <a
+ # href="http://en.wikipedia.org/wiki/CIDR_notation#CIDR_notation">CIDR
+ # notation</a>, also known as 'slash' notation (e.g.
+ # <code>192.168.100.0/24</code>).
+ { # An entry for an Access Control list.
+ "value": "A String", # The whitelisted value for the access control list.
+ "expirationTime": "A String", # The time when this access control entry expires in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "name": "A String", # Optional. A label to identify this entry.
+ "kind": "A String", # This is always <code>sql#aclEntry</code>.
+ },
+ ],
+ "requireSsl": True or False, # Whether SSL connections over IP should be enforced or not.
+ },
+ "availabilityType": "A String", # Availability type (PostgreSQL and MySQL instances only). Potential values:
+ # <br><code>ZONAL</code>: The instance serves data from only one zone.
+ # Outages in that zone affect data accessibility. <br><code>REGIONAL</code>:
+ # The instance can serve data from more than one zone in a region (it is
+ # highly available). <br>For more information, see <a
+ # href="https://cloud.google.com/sql/docs/postgres/high-availability">Overview
+ # of the High Availability Configuration</a>.
+ "settingsVersion": "A String", # The version of instance settings. This is a required field for update
+ # method to make sure concurrent updates are handled properly. During update,
+ # use the most recent settingsVersion value for this instance and do not try
+ # to update this value.
+ "databaseFlags": [ # The database flags passed to the instance at startup.
+ { # Database flags for Cloud SQL instances.
+ "value": "A String", # The value of the flag. Booleans should be set to <code>on</code> for true
+ # and <code>off</code> for false. This field must be omitted if the flag
+ # doesn't take a value.
+ "name": "A String", # The name of the flag. These flags are passed at instance startup, so
+ # include both server options and system variables for MySQL. Flags should be
+ # specified with underscores, not hyphens. For more information, see <a
+ # href="/sql/docs/mysql/flags">Configuring Database Flags</a> in the Cloud
+ # SQL documentation.
+ },
+ ],
+ "maintenanceWindow": { # Maintenance window. This specifies when a v2 Cloud SQL instance should # The maintenance window for this instance. This specifies when the instance
+ # can be restarted for maintenance purposes. Not used for First Generation
+ # instances.
+ # preferably be restarted for system maintenance purposes.
+ "updateTrack": "A String", # Maintenance timing setting: <code>canary</code> (Earlier) or
+ # <code>stable</code> (Later). <br /><a
+ # href="/sql/docs/db_path/instance-settings#maintenance-timing-2ndgen">
+ # Learn more</a>.
+ "hour": 42, # hour of day - 0 to 23.
+ "day": 42, # day of week (1-7), starting on Monday.
+ "kind": "A String", # This is always <code>sql#maintenanceWindow</code>.
+ },
+ "pricingPlan": "A String", # The pricing plan for this instance. This can be either <code>PER_USE</code>
+ # or <code>PACKAGE</code>. Only <code>PER_USE</code> is supported for Second
+ # Generation instances.
+ "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is
+ # true. Not used for First Generation instances.
+ "storageAutoResizeLimit": "A String", # The maximum size to which storage capacity can be automatically increased.
+ # The default value is 0, which specifies that there is no limit. Not used
+ # for First Generation instances.
+ "authorizedGaeApplications": [ # The App Engine app IDs that can access this instance. First Generation
+ # instances only.
+ "A String",
+ ],
+ "tier": "A String", # The tier (or machine type) for this instance, for example
+ # <code>db-n1-standard-1</code> (MySQL instances) or
+ # <code>db-custom-1-3840</code> (PostgreSQL instances). For MySQL instances,
+ # this property determines whether the instance is First or Second
+ # Generation. For more information, see <a
+ # href="/sql/docs/db_path/instance-settings">Instance Settings</a>.
+ "dataDiskSizeGb": "A String", # The size of data disk, in GB. The data disk size minimum is 10GB. Not used
+ # for First Generation instances.
+ "dataDiskType": "A String", # The type of data disk: <code>PD_SSD</code> (default) or
+ # <code>PD_HDD</code>. Not used for First Generation instances.
+ "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether
+ # replication is enabled or not.
+ "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether
+ # database flags for crash-safe replication are enabled. This property is
+ # only applicable to First Generation instances.
+ "backupConfiguration": { # Database instance backup configuration. # The daily backup configuration for the instance.
+ "pointInTimeRecoveryEnabled": True or False, # Reserved for future use.
+ "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24
+ # hour format - <code>HH:MM</code>.
+ "kind": "A String", # This is always <code>sql#backupConfiguration</code>.
+ "enabled": True or False, # Whether this configuration is enabled.
+ "binaryLogEnabled": True or False, # (MySQL only) Whether binary log is enabled. If backup configuration is
+ # disabled, binarylog must be disabled as well.
+ "replicationLogArchivingEnabled": True or False, # Reserved for future use.
+ "location": "A String", # Location of the backup
+ },
+ "userLabels": { # User-provided labels, represented as a dictionary where each label is a
+ # single key value pair.
+ "a_key": "A String",
+ },
+ "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance should # The location preference settings. This allows the instance to be located as
+ # near as possible to either an App Engine app or Compute Engine zone for
+ # better performance. App Engine co-location is only applicable to First
+ # Generation instances.
+ # preferably be located, either in a specific Compute Engine zone, or
+ # co-located with an App Engine application. Note that if the preferred
+ # location is not available, the instance will be located as close as possible
+ # within the region. Only one location may be specified.
+ "followGaeApplication": "A String", # The AppEngine application to follow, it must be in the same region as the
+ # Cloud SQL instance.
+ "kind": "A String", # This is always <code>sql#locationPreference</code>.
+ "zone": "A String", # The preferred Compute Engine zone (e.g. us-central1-a, us-central1-b,
+ # etc.).
+ },
+ "kind": "A String", # This is always <code>sql#settings</code>.
+ "replicationType": "A String", # The type of replication this instance uses. This can be either
+ # <code>ASYNCHRONOUS</code> or <code>SYNCHRONOUS</code>. This property is
+ # only applicable to First Generation instances.
+ "activationPolicy": "A String", # The activation policy specifies when the instance is activated; it is
+ # applicable only when the instance state is <code>RUNNABLE</code>. Valid
+ # values: <br><code>ALWAYS</code>: The instance is on, and remains so even in
+ # the absence of connection requests. <br><code>NEVER</code>: The instance is
+ # off; it is not activated, even if a connection request arrives.
+ # <br><code>ON_DEMAND</code>: First Generation instances only. The instance
+ # responds to incoming requests, and turns itself off when not in use.
+ # Instances with <code>PER_USE</code> pricing turn off after 15 minutes of
+ # inactivity. Instances with <code>PER_PACKAGE</code> pricing turn off after
+ # 12 hours of inactivity.
+ },
+ "replicaNames": [ # The replicas of the instance.
+ "A String",
+ ],
+ "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance.
+ # Applies only to Second Generation instances.
+ "kind": "A String", # This is always <code>sql#diskEncryptionConfiguration</code>.
+ "kmsKeyName": "A String", # Resource name of KMS key for disk encryption
+ },
+ "rootPassword": "A String", # Initial root password. Use only on creation.
+ "scheduledMaintenance": { # Any scheduled maintenancce for this instance. # The start time of any upcoming scheduled maintenance for this instance.
+ "canReschedule": True or False, # If the scheduled maintenance can be rescheduled.
+ "canDefer": True or False,
+ "startTime": "A String", # The start time of any upcoming scheduled maintenance for this instance.
+ },
+ "etag": "A String", # This field is deprecated and will be removed from a future version of the
+ # API. Use the <code>settings.settingsVersion</code> field instead.
+ "serverCaCert": { # SslCerts Resource # SSL configuration.
+ "selfLink": "A String", # The URI of this resource.
+ "expirationTime": "A String", # The time when the certificate expires in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "sha1Fingerprint": "A String", # Sha1 Fingerprint.
+ "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
+ "cert": "A String", # PEM representation.
+ "kind": "A String", # This is always <code>sql#sslCert</code>.
+ "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
+ "createTime": "A String", # The time when the certificate was created in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>
+ "instance": "A String", # Name of the database instance.
+ },
+ "maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
+ "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
+ "masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup.
+ "instanceType": "A String", # The instance type. This can be one of the following.
+ # <br><code>CLOUD_SQL_INSTANCE</code>: A Cloud SQL instance that is not
+ # replicating from a master. <br><code>ON_PREMISES_INSTANCE</code>: An
+ # instance running on the
+ # customer's premises. <br><code>READ_REPLICA_INSTANCE</code>: A Cloud SQL
+ # instance configured as a read-replica.
+ "gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This
+ # value could be different from the zone that was specified when the instance
+ # was created if the instance has failed over to its secondary zone.
+ "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been
+ # deprecated. Users should use the
+ # "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud
+ # Monitoring API instead. Please see <a
+ # href="https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ">this
+ # announcement</a> for details.
+ "replicaConfiguration": { # Read-replica configuration for connecting to the master. # Configuration specific to failover replicas and read replicas.
+ "kind": "A String", # This is always <code>sql#replicaConfiguration</code>.
+ "mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # 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 <code>master.info</code>
+ # in the data directory.
+ "kind": "A String", # This is always <code>sql#mysqlReplicaConfiguration</code>.
+ "password": "A String", # The password for the replication connection.
+ "verifyServerCertificate": True or False, # Whether or not to check the master's Common Name value in the certificate
+ # that it sends during the SSL handshake.
+ "clientKey": "A String", # PEM representation of the slave's private key. The corresponsing public key
+ # is encoded in the client's certificate.
+ "sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption.
+ "masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats.
+ "connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds.
+ "dumpFilePath": "A String", # Path to a SQL dump file in Google Cloud Storage from which the slave
+ # instance is to be created. The URI is in the form gs:
+ # //bucketName/fileName. Compressed gzip files (.gz) are also supported.
+ # // Dumps should have the binlog co-ordinates from which replication should
+ # // begin. This can be accomplished by setting --master-data to 1 when using
+ # // mysqldump.
+ "clientCertificate": "A String", # PEM representation of the slave's x509 certificate.
+ "username": "A String", # The username for the replication connection.
+ "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
+ },
+ "failoverTarget": True or False, # Specifies if the replica is the failover target. If the field is set to
+ # <code>true</code> 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. <p>Only one replica can be specified as failover
+ # target, and the replica has to be in different zone with the master
+ # instance.
+ },
+ "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.
+ "failoverReplica": { # The name and status of the failover replica. This property is applicable
+ # only to Second Generation instances.
+ "available": True or False, # The availability status of the failover replica. A false status indicates
+ # that the failover replica is out of sync. The master can only failover to
+ # the failover replica when the status is true.
+ "name": "A String", # The name of the failover replica. If specified at instance creation, a
+ # failover replica is created for the instance. The name
+ # doesn't include the project ID. This property is applicable only to
+ # Second Generation instances.
+ },
+ "ipAddresses": [ # The assigned IP addresses for the instance.
+ { # Database instance IP Mapping.
+ "timeToRetire": "A String", # The due time for this IP to be retired in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>. This field is only available when
+ # the IP is scheduled to be retired.
+ "type": "A String", # The type of this IP address. A <code>PRIMARY</code> address is a public
+ # address that can accept incoming connections. A <code>PRIVATE</code>
+ # address is a private address that can accept incoming connections. An
+ # <code>OUTGOING</code> address is the source address of connections
+ # originating from the instance, if supported.
+ "ipAddress": "A String", # The IP address assigned.
+ },
+ ],
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource.&nbsp;For successful operations that return an
+ # Operation resource, only the fields relevant to the operation are populated
+ # in the resource.
+ "user": "A String", # The email address of the user who initiated this operation.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "targetLink": "A String",
+ "operationType": "A String", # The type of the operation. Valid values are <code>CREATE</code>,
+ # <code>DELETE</code>, <code>UPDATE</code>, <code>RESTART</code>,
+ # <code>IMPORT</code>, <code>EXPORT</code>, <code>BACKUP_VOLUME</code>,
+ # <code>RESTORE_VOLUME</code>, <code>CREATE_USER</code>,
+ # <code>DELETE_USER</code>, <code>CREATE_DATABASE</code>,
+ # <code>DELETE_DATABASE</code> .
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
+ # populated.
+ "errors": [ # The list of errors encountered while processing this operation.
+ { # Database instance operation error.
+ "code": "A String", # Identifies the specific error that occurred.
+ "message": "A String", # Additional information about the error encountered.
+ "kind": "A String", # This is always <code>sql#operationError</code>.
+ },
+ ],
+ "kind": "A String", # This is always <code>sql#operationErrors</code>.
+ },
+ "kind": "A String", # This is always <code>sql#operation</code>.
+ "importContext": { # Database instance import context. # The context for import operation, if applicable.
+ "csvImportOptions": { # Options for importing data as CSV.
+ "columns": [ # The columns to which CSV data is imported. If not specified, all columns
+ # of the database table are loaded with CSV data.
+ "A String",
+ ],
+ "table": "A String", # The table to which CSV data is imported.
+ },
+ "kind": "A String", # This is always <code>sql#importContext</code>.
+ "database": "A String", # The target database for the import. If <code>fileType</code> is
+ # <code>SQL</code>, this field is required only if the import file does not
+ # specify a database, and is overridden by any database specification in the
+ # import file. If <code>fileType</code> is <code>CSV</code>, one database
+ # must be specified.
+ "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
+ "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
+ "encryptionOptions": {
+ "pvkPassword": "A String", # Password that encrypts the private key
+ "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form
+ # <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
+ # form <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ },
+ },
+ "uri": "A String", # Path to the import file in Cloud Storage, in the form
+ # <code>gs:
+ # //bucketName/fileName</code>. Compressed gzip files (.gz) are supported
+ # // when <code>fileType</code> is <code>SQL</code>. The instance must have
+ # // write permissions to the bucket and read access to the file.
+ "fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ },
+ "status": "A String", # The status of an operation. Valid values are <code>PENDING</code>,
+ # <code>RUNNING</code>, <code>DONE</code>,
+ # <code>SQL_OPERATION_STATUS_UNSPECIFIED</code>.
+ "name": "A String", # An identifier that uniquely identifies the operation. You can use this
+ # identifier to retrieve the Operations resource that has information about
+ # the operation.
+ "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+ "databases": [ # Databases to be exported. <br /> <b>MySQL instances:</b> If
+ # <code>fileType</code> is <code>SQL</code> and no database is specified, all
+ # databases are exported, except for the <code>mysql</code> system database.
+ # If <code>fileType</code> is <code>CSV</code>, you can specify one database,
+ # either by using this property or by using the
+ # <code>csvExportOptions.selectQuery</code> property, which takes precedence
+ # over this property. <br /> <b>PostgreSQL instances:</b> You must specify
+ # one database to be exported. If <code>fileType</code> is <code>CSV</code>,
+ # this database must match the one specified in the
+ # <code>csvExportOptions.selectQuery</code> property.
+ "A String",
+ ],
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "tables": [ # Tables to export, or that were exported, from the specified database. If
+ # you specify tables, specify one and only one database. For PostgreSQL
+ # instances, you can specify only one table.
+ "A String",
+ ],
+ "schemaOnly": True or False, # Export only schemas.
+ "mysqlExportOptions": { # Options for exporting from MySQL.
+ "masterData": 42, # Option to include SQL statement required to set up replication.
+ # If set to <code>1</code>, the dump file includes
+ # a CHANGE MASTER TO statement with the binary log coordinates.
+ # If set to <code>2</code>, the CHANGE MASTER TO statement is written as
+ # a SQL comment, and has no effect.
+ # All other values are ignored.
+ },
+ },
+ "fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ "uri": "A String", # The path to the file in Google Cloud Storage where the export will be
+ # stored. The URI is in the form <code>gs:
+ # //bucketName/fileName</code>. If the file already exists, the requests
+ # // succeeds, but the operation fails. If <code>fileType</code> is
+ # // <code>SQL</code> and the filename ends with .gz, the contents are
+ # // compressed.
+ "csvExportOptions": { # Options for exporting data as CSV.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "kind": "A String", # This is always <code>sql#exportContext</code>.
+ },
+ "targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "startTime": "A String", # The time this operation actually started in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, pageToken=None, maxResults=None, filter=None, x__xgafv=None)</code>
+ <pre>Lists instances under a given project.
+
+Args:
+ project: string, Project ID of the project for which to list Cloud SQL instances. (required)
+ pageToken: string, A previously-returned page token representing part of the larger set of
+results to view.
+ maxResults: integer, The maximum number of results to return per response.
+ filter: string, A filter expression that filters resources listed in the response.
+The expression is in the form of field:value. For example,
+'instanceType:CLOUD_SQL_INSTANCE'. Fields can be nested as needed as per
+their JSON representation, such as 'settings.userLabels.auto_start:true'.
+
+Multiple filter queries are space-separated. For example.
+'state:RUNNABLE instanceType:CLOUD_SQL_INSTANCE'. By default, each
+expression is an AND expression. However, you can include AND and OR
+expressions explicitly.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Database instances list response.
+ "kind": "A String", # This is always <code>sql#instancesList</code>.
+ "items": [ # List of database instance resources.
+ { # A Cloud SQL instance resource.
+ "ipv6Address": "A String", # The IPv6 address assigned to the instance. This property is applicable only
+ # to First Generation instances.
+ "selfLink": "A String", # The URI of this resource.
+ "diskEncryptionStatus": { # Disk encryption status for an instance. # Disk encryption status specific to an instance.
+ # Applies only to Second Generation instances.
+ "kmsKeyVersionName": "A String", # KMS key version used to encrypt the Cloud SQL instance resource
+ "kind": "A String", # This is always <code>sql#diskEncryptionStatus</code>.
+ },
+ "kind": "A String", # This is always <code>sql#instance</code>.
+ "region": "A String", # The geographical region. Can be <code>us-central</code>
+ # (<code>FIRST_GEN</code> instances only), <code>us-central1</code>
+ # (<code>SECOND_GEN</code> instances only), <code>asia-east1</code> or
+ # <code>europe-west1</code>. Defaults to <code>us-central</code> or
+ # <code>us-central1</code> depending on the instance type (First Generation
+ # or Second Generation). The region can not be changed after instance
+ # creation.
+ "state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the
+ # following. <br><code>RUNNABLE</code>: The instance is running, or is ready
+ # to run when accessed. <br><code>SUSPENDED</code>: The instance is not
+ # available, for example due to problems with billing.
+ # <br><code>PENDING_CREATE</code>: The instance is being created.
+ # <br><code>MAINTENANCE</code>: The instance is down for maintenance.
+ # <br><code>FAILED</code>: The instance creation failed.
+ # <br><code>UNKNOWN_STATE</code>: The state of the instance is unknown.
+ "backendType": "A String", # <code>FIRST_GEN</code>: First Generation instance. MySQL only. <br
+ # /><code>SECOND_GEN</code>: Second Generation instance or PostgreSQL
+ # instance. <br /><code>EXTERNAL</code>: A database server that is not
+ # managed by Google. <br>This property is read-only; use the
+ # <code>tier</code> property in the <code>settings</code> object to determine
+ # the database type and Second or First Generation.
+ "onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances.
+ "hostPort": "A String", # The host and port of the on-premises instance in host:port format
+ "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica.
+ "clientCertificate": "A String", # PEM representation of the slave's x509 certificate.
+ "username": "A String", # The username for connecting to on-premises instance.
+ "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
+ "kind": "A String", # This is always <code>sql#onPremisesConfiguration</code>.
+ "password": "A String", # The password for connecting to on-premises instance.
+ "clientKey": "A String", # PEM representation of the slave's private key. The corresponsing public key
+ # is encoded in the client's certificate.
+ },
+ "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google
+ # apps domain is prefixed if applicable.
+ "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance. This property
+ # is applicable only to Second Generation instances.
+ "databaseVersion": "A String", # The database engine type and version. The <code>databaseVersion</code>
+ # field can not be changed after instance creation. MySQL Second Generation
+ # instances: <code>MYSQL_5_7</code> (default) or <code>MYSQL_5_6</code>.
+ # PostgreSQL instances: <code>POSTGRES_9_6</code> (default) or
+ # <code>POSTGRES_11 Beta</code> MySQL First Generation
+ # instances: <code>MYSQL_5_6</code> (default) or <code>MYSQL_5_5</code>
+ "suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension.
+ "A String",
+ ],
+ "settings": { # Database instance settings. # The user settings.
+ "ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the
+ # instance IP and manage which external networks can connect to the instance.
+ # The IPv4 address cannot be disabled for Second Generation instances.
+ "privateNetwork": "A String", # The resource link for the VPC network from which the Cloud SQL instance is
+ # accessible for private IP. For example,
+ # <code>/projects/myProject/global/networks/default</code>. This setting can
+ # be updated, but it cannot be removed after it is set.
+ "ipv4Enabled": True or False, # Whether the instance should be assigned an IP address or not.
+ "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance
+ # using the IP. In <a
+ # href="http://en.wikipedia.org/wiki/CIDR_notation#CIDR_notation">CIDR
+ # notation</a>, also known as 'slash' notation (e.g.
+ # <code>192.168.100.0/24</code>).
+ { # An entry for an Access Control list.
+ "value": "A String", # The whitelisted value for the access control list.
+ "expirationTime": "A String", # The time when this access control entry expires in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "name": "A String", # Optional. A label to identify this entry.
+ "kind": "A String", # This is always <code>sql#aclEntry</code>.
+ },
+ ],
+ "requireSsl": True or False, # Whether SSL connections over IP should be enforced or not.
+ },
+ "availabilityType": "A String", # Availability type (PostgreSQL and MySQL instances only). Potential values:
+ # <br><code>ZONAL</code>: The instance serves data from only one zone.
+ # Outages in that zone affect data accessibility. <br><code>REGIONAL</code>:
+ # The instance can serve data from more than one zone in a region (it is
+ # highly available). <br>For more information, see <a
+ # href="https://cloud.google.com/sql/docs/postgres/high-availability">Overview
+ # of the High Availability Configuration</a>.
+ "settingsVersion": "A String", # The version of instance settings. This is a required field for update
+ # method to make sure concurrent updates are handled properly. During update,
+ # use the most recent settingsVersion value for this instance and do not try
+ # to update this value.
+ "databaseFlags": [ # The database flags passed to the instance at startup.
+ { # Database flags for Cloud SQL instances.
+ "value": "A String", # The value of the flag. Booleans should be set to <code>on</code> for true
+ # and <code>off</code> for false. This field must be omitted if the flag
+ # doesn't take a value.
+ "name": "A String", # The name of the flag. These flags are passed at instance startup, so
+ # include both server options and system variables for MySQL. Flags should be
+ # specified with underscores, not hyphens. For more information, see <a
+ # href="/sql/docs/mysql/flags">Configuring Database Flags</a> in the Cloud
+ # SQL documentation.
+ },
+ ],
+ "maintenanceWindow": { # Maintenance window. This specifies when a v2 Cloud SQL instance should # The maintenance window for this instance. This specifies when the instance
+ # can be restarted for maintenance purposes. Not used for First Generation
+ # instances.
+ # preferably be restarted for system maintenance purposes.
+ "updateTrack": "A String", # Maintenance timing setting: <code>canary</code> (Earlier) or
+ # <code>stable</code> (Later). <br /><a
+ # href="/sql/docs/db_path/instance-settings#maintenance-timing-2ndgen">
+ # Learn more</a>.
+ "hour": 42, # hour of day - 0 to 23.
+ "day": 42, # day of week (1-7), starting on Monday.
+ "kind": "A String", # This is always <code>sql#maintenanceWindow</code>.
+ },
+ "pricingPlan": "A String", # The pricing plan for this instance. This can be either <code>PER_USE</code>
+ # or <code>PACKAGE</code>. Only <code>PER_USE</code> is supported for Second
+ # Generation instances.
+ "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is
+ # true. Not used for First Generation instances.
+ "storageAutoResizeLimit": "A String", # The maximum size to which storage capacity can be automatically increased.
+ # The default value is 0, which specifies that there is no limit. Not used
+ # for First Generation instances.
+ "authorizedGaeApplications": [ # The App Engine app IDs that can access this instance. First Generation
+ # instances only.
+ "A String",
+ ],
+ "tier": "A String", # The tier (or machine type) for this instance, for example
+ # <code>db-n1-standard-1</code> (MySQL instances) or
+ # <code>db-custom-1-3840</code> (PostgreSQL instances). For MySQL instances,
+ # this property determines whether the instance is First or Second
+ # Generation. For more information, see <a
+ # href="/sql/docs/db_path/instance-settings">Instance Settings</a>.
+ "dataDiskSizeGb": "A String", # The size of data disk, in GB. The data disk size minimum is 10GB. Not used
+ # for First Generation instances.
+ "dataDiskType": "A String", # The type of data disk: <code>PD_SSD</code> (default) or
+ # <code>PD_HDD</code>. Not used for First Generation instances.
+ "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether
+ # replication is enabled or not.
+ "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether
+ # database flags for crash-safe replication are enabled. This property is
+ # only applicable to First Generation instances.
+ "backupConfiguration": { # Database instance backup configuration. # The daily backup configuration for the instance.
+ "pointInTimeRecoveryEnabled": True or False, # Reserved for future use.
+ "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24
+ # hour format - <code>HH:MM</code>.
+ "kind": "A String", # This is always <code>sql#backupConfiguration</code>.
+ "enabled": True or False, # Whether this configuration is enabled.
+ "binaryLogEnabled": True or False, # (MySQL only) Whether binary log is enabled. If backup configuration is
+ # disabled, binarylog must be disabled as well.
+ "replicationLogArchivingEnabled": True or False, # Reserved for future use.
+ "location": "A String", # Location of the backup
+ },
+ "userLabels": { # User-provided labels, represented as a dictionary where each label is a
+ # single key value pair.
+ "a_key": "A String",
+ },
+ "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance should # The location preference settings. This allows the instance to be located as
+ # near as possible to either an App Engine app or Compute Engine zone for
+ # better performance. App Engine co-location is only applicable to First
+ # Generation instances.
+ # preferably be located, either in a specific Compute Engine zone, or
+ # co-located with an App Engine application. Note that if the preferred
+ # location is not available, the instance will be located as close as possible
+ # within the region. Only one location may be specified.
+ "followGaeApplication": "A String", # The AppEngine application to follow, it must be in the same region as the
+ # Cloud SQL instance.
+ "kind": "A String", # This is always <code>sql#locationPreference</code>.
+ "zone": "A String", # The preferred Compute Engine zone (e.g. us-central1-a, us-central1-b,
+ # etc.).
+ },
+ "kind": "A String", # This is always <code>sql#settings</code>.
+ "replicationType": "A String", # The type of replication this instance uses. This can be either
+ # <code>ASYNCHRONOUS</code> or <code>SYNCHRONOUS</code>. This property is
+ # only applicable to First Generation instances.
+ "activationPolicy": "A String", # The activation policy specifies when the instance is activated; it is
+ # applicable only when the instance state is <code>RUNNABLE</code>. Valid
+ # values: <br><code>ALWAYS</code>: The instance is on, and remains so even in
+ # the absence of connection requests. <br><code>NEVER</code>: The instance is
+ # off; it is not activated, even if a connection request arrives.
+ # <br><code>ON_DEMAND</code>: First Generation instances only. The instance
+ # responds to incoming requests, and turns itself off when not in use.
+ # Instances with <code>PER_USE</code> pricing turn off after 15 minutes of
+ # inactivity. Instances with <code>PER_PACKAGE</code> pricing turn off after
+ # 12 hours of inactivity.
+ },
+ "replicaNames": [ # The replicas of the instance.
+ "A String",
+ ],
+ "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance.
+ # Applies only to Second Generation instances.
+ "kind": "A String", # This is always <code>sql#diskEncryptionConfiguration</code>.
+ "kmsKeyName": "A String", # Resource name of KMS key for disk encryption
+ },
+ "rootPassword": "A String", # Initial root password. Use only on creation.
+ "scheduledMaintenance": { # Any scheduled maintenancce for this instance. # The start time of any upcoming scheduled maintenance for this instance.
+ "canReschedule": True or False, # If the scheduled maintenance can be rescheduled.
+ "canDefer": True or False,
+ "startTime": "A String", # The start time of any upcoming scheduled maintenance for this instance.
+ },
+ "etag": "A String", # This field is deprecated and will be removed from a future version of the
+ # API. Use the <code>settings.settingsVersion</code> field instead.
+ "serverCaCert": { # SslCerts Resource # SSL configuration.
+ "selfLink": "A String", # The URI of this resource.
+ "expirationTime": "A String", # The time when the certificate expires in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "sha1Fingerprint": "A String", # Sha1 Fingerprint.
+ "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
+ "cert": "A String", # PEM representation.
+ "kind": "A String", # This is always <code>sql#sslCert</code>.
+ "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
+ "createTime": "A String", # The time when the certificate was created in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>
+ "instance": "A String", # Name of the database instance.
+ },
+ "maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
+ "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
+ "masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup.
+ "instanceType": "A String", # The instance type. This can be one of the following.
+ # <br><code>CLOUD_SQL_INSTANCE</code>: A Cloud SQL instance that is not
+ # replicating from a master. <br><code>ON_PREMISES_INSTANCE</code>: An
+ # instance running on the
+ # customer's premises. <br><code>READ_REPLICA_INSTANCE</code>: A Cloud SQL
+ # instance configured as a read-replica.
+ "gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This
+ # value could be different from the zone that was specified when the instance
+ # was created if the instance has failed over to its secondary zone.
+ "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been
+ # deprecated. Users should use the
+ # "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud
+ # Monitoring API instead. Please see <a
+ # href="https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ">this
+ # announcement</a> for details.
+ "replicaConfiguration": { # Read-replica configuration for connecting to the master. # Configuration specific to failover replicas and read replicas.
+ "kind": "A String", # This is always <code>sql#replicaConfiguration</code>.
+ "mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # 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 <code>master.info</code>
+ # in the data directory.
+ "kind": "A String", # This is always <code>sql#mysqlReplicaConfiguration</code>.
+ "password": "A String", # The password for the replication connection.
+ "verifyServerCertificate": True or False, # Whether or not to check the master's Common Name value in the certificate
+ # that it sends during the SSL handshake.
+ "clientKey": "A String", # PEM representation of the slave's private key. The corresponsing public key
+ # is encoded in the client's certificate.
+ "sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption.
+ "masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats.
+ "connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds.
+ "dumpFilePath": "A String", # Path to a SQL dump file in Google Cloud Storage from which the slave
+ # instance is to be created. The URI is in the form gs:
+ # //bucketName/fileName. Compressed gzip files (.gz) are also supported.
+ # // Dumps should have the binlog co-ordinates from which replication should
+ # // begin. This can be accomplished by setting --master-data to 1 when using
+ # // mysqldump.
+ "clientCertificate": "A String", # PEM representation of the slave's x509 certificate.
+ "username": "A String", # The username for the replication connection.
+ "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
+ },
+ "failoverTarget": True or False, # Specifies if the replica is the failover target. If the field is set to
+ # <code>true</code> 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. <p>Only one replica can be specified as failover
+ # target, and the replica has to be in different zone with the master
+ # instance.
+ },
+ "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.
+ "failoverReplica": { # The name and status of the failover replica. This property is applicable
+ # only to Second Generation instances.
+ "available": True or False, # The availability status of the failover replica. A false status indicates
+ # that the failover replica is out of sync. The master can only failover to
+ # the failover replica when the status is true.
+ "name": "A String", # The name of the failover replica. If specified at instance creation, a
+ # failover replica is created for the instance. The name
+ # doesn't include the project ID. This property is applicable only to
+ # Second Generation instances.
+ },
+ "ipAddresses": [ # The assigned IP addresses for the instance.
+ { # Database instance IP Mapping.
+ "timeToRetire": "A String", # The due time for this IP to be retired in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>. This field is only available when
+ # the IP is scheduled to be retired.
+ "type": "A String", # The type of this IP address. A <code>PRIMARY</code> address is a public
+ # address that can accept incoming connections. A <code>PRIVATE</code>
+ # address is a private address that can accept incoming connections. An
+ # <code>OUTGOING</code> address is the source address of connections
+ # originating from the instance, if supported.
+ "ipAddress": "A String", # The IP address assigned.
+ },
+ ],
+ },
+ ],
+ "warnings": [ # List of warnings that occurred while handling the request.
+ { # An Admin API warning message.
+ "code": "A String", # Code to uniquely identify the warning type.
+ "message": "A String", # The warning message.
+ },
+ ],
+ "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide
+ # this value in a subsequent request to return the next page of results.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="listServerCas">listServerCas(project, instance, x__xgafv=None)</code>
+ <pre>Lists all of the trusted Certificate Authorities (CAs) for the specified
+instance. There can be up to three CAs listed: the CA that was used to sign
+the certificate that is currently in use, a CA that has been added but not
+yet used to sign a certificate, and a CA used to sign a certificate that
+has previously rotated out.
+
+Args:
+ project: string, Project ID of the project that contains the instance. (required)
+ instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Instances ListServerCas response.
+ "activeVersion": "A String",
+ "kind": "A String", # This is always <code>sql#instancesListServerCas</code>.
+ "certs": [ # List of server CA certificates for the instance.
+ { # SslCerts Resource
+ "selfLink": "A String", # The URI of this resource.
+ "expirationTime": "A String", # The time when the certificate expires in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "sha1Fingerprint": "A String", # Sha1 Fingerprint.
+ "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
+ "cert": "A String", # PEM representation.
+ "kind": "A String", # This is always <code>sql#sslCert</code>.
+ "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
+ "createTime": "A String", # The time when the certificate was created in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>
+ "instance": "A String", # Name of the database instance.
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
+ <pre>Retrieves the next page of results.
+
+Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+ </pre>
+</div>
+
+<div class="method">
+ <code class="details" id="patch">patch(project, instance, body=None, x__xgafv=None)</code>
+ <pre>Updates settings of a Cloud SQL instance.
+This method supports patch semantics.
+
+Args:
+ project: string, Project ID of the project that contains the instance. (required)
+ instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A Cloud SQL instance resource.
+ "ipv6Address": "A String", # The IPv6 address assigned to the instance. This property is applicable only
+ # to First Generation instances.
+ "selfLink": "A String", # The URI of this resource.
+ "diskEncryptionStatus": { # Disk encryption status for an instance. # Disk encryption status specific to an instance.
+ # Applies only to Second Generation instances.
+ "kmsKeyVersionName": "A String", # KMS key version used to encrypt the Cloud SQL instance resource
+ "kind": "A String", # This is always <code>sql#diskEncryptionStatus</code>.
+ },
+ "kind": "A String", # This is always <code>sql#instance</code>.
+ "region": "A String", # The geographical region. Can be <code>us-central</code>
+ # (<code>FIRST_GEN</code> instances only), <code>us-central1</code>
+ # (<code>SECOND_GEN</code> instances only), <code>asia-east1</code> or
+ # <code>europe-west1</code>. Defaults to <code>us-central</code> or
+ # <code>us-central1</code> depending on the instance type (First Generation
+ # or Second Generation). The region can not be changed after instance
+ # creation.
+ "state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the
+ # following. <br><code>RUNNABLE</code>: The instance is running, or is ready
+ # to run when accessed. <br><code>SUSPENDED</code>: The instance is not
+ # available, for example due to problems with billing.
+ # <br><code>PENDING_CREATE</code>: The instance is being created.
+ # <br><code>MAINTENANCE</code>: The instance is down for maintenance.
+ # <br><code>FAILED</code>: The instance creation failed.
+ # <br><code>UNKNOWN_STATE</code>: The state of the instance is unknown.
+ "backendType": "A String", # <code>FIRST_GEN</code>: First Generation instance. MySQL only. <br
+ # /><code>SECOND_GEN</code>: Second Generation instance or PostgreSQL
+ # instance. <br /><code>EXTERNAL</code>: A database server that is not
+ # managed by Google. <br>This property is read-only; use the
+ # <code>tier</code> property in the <code>settings</code> object to determine
+ # the database type and Second or First Generation.
+ "onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances.
+ "hostPort": "A String", # The host and port of the on-premises instance in host:port format
+ "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica.
+ "clientCertificate": "A String", # PEM representation of the slave's x509 certificate.
+ "username": "A String", # The username for connecting to on-premises instance.
+ "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
+ "kind": "A String", # This is always <code>sql#onPremisesConfiguration</code>.
+ "password": "A String", # The password for connecting to on-premises instance.
+ "clientKey": "A String", # PEM representation of the slave's private key. The corresponsing public key
+ # is encoded in the client's certificate.
+ },
+ "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google
+ # apps domain is prefixed if applicable.
+ "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance. This property
+ # is applicable only to Second Generation instances.
+ "databaseVersion": "A String", # The database engine type and version. The <code>databaseVersion</code>
+ # field can not be changed after instance creation. MySQL Second Generation
+ # instances: <code>MYSQL_5_7</code> (default) or <code>MYSQL_5_6</code>.
+ # PostgreSQL instances: <code>POSTGRES_9_6</code> (default) or
+ # <code>POSTGRES_11 Beta</code> MySQL First Generation
+ # instances: <code>MYSQL_5_6</code> (default) or <code>MYSQL_5_5</code>
+ "suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension.
+ "A String",
+ ],
+ "settings": { # Database instance settings. # The user settings.
+ "ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the
+ # instance IP and manage which external networks can connect to the instance.
+ # The IPv4 address cannot be disabled for Second Generation instances.
+ "privateNetwork": "A String", # The resource link for the VPC network from which the Cloud SQL instance is
+ # accessible for private IP. For example,
+ # <code>/projects/myProject/global/networks/default</code>. This setting can
+ # be updated, but it cannot be removed after it is set.
+ "ipv4Enabled": True or False, # Whether the instance should be assigned an IP address or not.
+ "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance
+ # using the IP. In <a
+ # href="http://en.wikipedia.org/wiki/CIDR_notation#CIDR_notation">CIDR
+ # notation</a>, also known as 'slash' notation (e.g.
+ # <code>192.168.100.0/24</code>).
+ { # An entry for an Access Control list.
+ "value": "A String", # The whitelisted value for the access control list.
+ "expirationTime": "A String", # The time when this access control entry expires in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "name": "A String", # Optional. A label to identify this entry.
+ "kind": "A String", # This is always <code>sql#aclEntry</code>.
+ },
+ ],
+ "requireSsl": True or False, # Whether SSL connections over IP should be enforced or not.
+ },
+ "availabilityType": "A String", # Availability type (PostgreSQL and MySQL instances only). Potential values:
+ # <br><code>ZONAL</code>: The instance serves data from only one zone.
+ # Outages in that zone affect data accessibility. <br><code>REGIONAL</code>:
+ # The instance can serve data from more than one zone in a region (it is
+ # highly available). <br>For more information, see <a
+ # href="https://cloud.google.com/sql/docs/postgres/high-availability">Overview
+ # of the High Availability Configuration</a>.
+ "settingsVersion": "A String", # The version of instance settings. This is a required field for update
+ # method to make sure concurrent updates are handled properly. During update,
+ # use the most recent settingsVersion value for this instance and do not try
+ # to update this value.
+ "databaseFlags": [ # The database flags passed to the instance at startup.
+ { # Database flags for Cloud SQL instances.
+ "value": "A String", # The value of the flag. Booleans should be set to <code>on</code> for true
+ # and <code>off</code> for false. This field must be omitted if the flag
+ # doesn't take a value.
+ "name": "A String", # The name of the flag. These flags are passed at instance startup, so
+ # include both server options and system variables for MySQL. Flags should be
+ # specified with underscores, not hyphens. For more information, see <a
+ # href="/sql/docs/mysql/flags">Configuring Database Flags</a> in the Cloud
+ # SQL documentation.
+ },
+ ],
+ "maintenanceWindow": { # Maintenance window. This specifies when a v2 Cloud SQL instance should # The maintenance window for this instance. This specifies when the instance
+ # can be restarted for maintenance purposes. Not used for First Generation
+ # instances.
+ # preferably be restarted for system maintenance purposes.
+ "updateTrack": "A String", # Maintenance timing setting: <code>canary</code> (Earlier) or
+ # <code>stable</code> (Later). <br /><a
+ # href="/sql/docs/db_path/instance-settings#maintenance-timing-2ndgen">
+ # Learn more</a>.
+ "hour": 42, # hour of day - 0 to 23.
+ "day": 42, # day of week (1-7), starting on Monday.
+ "kind": "A String", # This is always <code>sql#maintenanceWindow</code>.
+ },
+ "pricingPlan": "A String", # The pricing plan for this instance. This can be either <code>PER_USE</code>
+ # or <code>PACKAGE</code>. Only <code>PER_USE</code> is supported for Second
+ # Generation instances.
+ "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is
+ # true. Not used for First Generation instances.
+ "storageAutoResizeLimit": "A String", # The maximum size to which storage capacity can be automatically increased.
+ # The default value is 0, which specifies that there is no limit. Not used
+ # for First Generation instances.
+ "authorizedGaeApplications": [ # The App Engine app IDs that can access this instance. First Generation
+ # instances only.
+ "A String",
+ ],
+ "tier": "A String", # The tier (or machine type) for this instance, for example
+ # <code>db-n1-standard-1</code> (MySQL instances) or
+ # <code>db-custom-1-3840</code> (PostgreSQL instances). For MySQL instances,
+ # this property determines whether the instance is First or Second
+ # Generation. For more information, see <a
+ # href="/sql/docs/db_path/instance-settings">Instance Settings</a>.
+ "dataDiskSizeGb": "A String", # The size of data disk, in GB. The data disk size minimum is 10GB. Not used
+ # for First Generation instances.
+ "dataDiskType": "A String", # The type of data disk: <code>PD_SSD</code> (default) or
+ # <code>PD_HDD</code>. Not used for First Generation instances.
+ "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether
+ # replication is enabled or not.
+ "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether
+ # database flags for crash-safe replication are enabled. This property is
+ # only applicable to First Generation instances.
+ "backupConfiguration": { # Database instance backup configuration. # The daily backup configuration for the instance.
+ "pointInTimeRecoveryEnabled": True or False, # Reserved for future use.
+ "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24
+ # hour format - <code>HH:MM</code>.
+ "kind": "A String", # This is always <code>sql#backupConfiguration</code>.
+ "enabled": True or False, # Whether this configuration is enabled.
+ "binaryLogEnabled": True or False, # (MySQL only) Whether binary log is enabled. If backup configuration is
+ # disabled, binarylog must be disabled as well.
+ "replicationLogArchivingEnabled": True or False, # Reserved for future use.
+ "location": "A String", # Location of the backup
+ },
+ "userLabels": { # User-provided labels, represented as a dictionary where each label is a
+ # single key value pair.
+ "a_key": "A String",
+ },
+ "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance should # The location preference settings. This allows the instance to be located as
+ # near as possible to either an App Engine app or Compute Engine zone for
+ # better performance. App Engine co-location is only applicable to First
+ # Generation instances.
+ # preferably be located, either in a specific Compute Engine zone, or
+ # co-located with an App Engine application. Note that if the preferred
+ # location is not available, the instance will be located as close as possible
+ # within the region. Only one location may be specified.
+ "followGaeApplication": "A String", # The AppEngine application to follow, it must be in the same region as the
+ # Cloud SQL instance.
+ "kind": "A String", # This is always <code>sql#locationPreference</code>.
+ "zone": "A String", # The preferred Compute Engine zone (e.g. us-central1-a, us-central1-b,
+ # etc.).
+ },
+ "kind": "A String", # This is always <code>sql#settings</code>.
+ "replicationType": "A String", # The type of replication this instance uses. This can be either
+ # <code>ASYNCHRONOUS</code> or <code>SYNCHRONOUS</code>. This property is
+ # only applicable to First Generation instances.
+ "activationPolicy": "A String", # The activation policy specifies when the instance is activated; it is
+ # applicable only when the instance state is <code>RUNNABLE</code>. Valid
+ # values: <br><code>ALWAYS</code>: The instance is on, and remains so even in
+ # the absence of connection requests. <br><code>NEVER</code>: The instance is
+ # off; it is not activated, even if a connection request arrives.
+ # <br><code>ON_DEMAND</code>: First Generation instances only. The instance
+ # responds to incoming requests, and turns itself off when not in use.
+ # Instances with <code>PER_USE</code> pricing turn off after 15 minutes of
+ # inactivity. Instances with <code>PER_PACKAGE</code> pricing turn off after
+ # 12 hours of inactivity.
+ },
+ "replicaNames": [ # The replicas of the instance.
+ "A String",
+ ],
+ "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance.
+ # Applies only to Second Generation instances.
+ "kind": "A String", # This is always <code>sql#diskEncryptionConfiguration</code>.
+ "kmsKeyName": "A String", # Resource name of KMS key for disk encryption
+ },
+ "rootPassword": "A String", # Initial root password. Use only on creation.
+ "scheduledMaintenance": { # Any scheduled maintenancce for this instance. # The start time of any upcoming scheduled maintenance for this instance.
+ "canReschedule": True or False, # If the scheduled maintenance can be rescheduled.
+ "canDefer": True or False,
+ "startTime": "A String", # The start time of any upcoming scheduled maintenance for this instance.
+ },
+ "etag": "A String", # This field is deprecated and will be removed from a future version of the
+ # API. Use the <code>settings.settingsVersion</code> field instead.
+ "serverCaCert": { # SslCerts Resource # SSL configuration.
+ "selfLink": "A String", # The URI of this resource.
+ "expirationTime": "A String", # The time when the certificate expires in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "sha1Fingerprint": "A String", # Sha1 Fingerprint.
+ "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
+ "cert": "A String", # PEM representation.
+ "kind": "A String", # This is always <code>sql#sslCert</code>.
+ "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
+ "createTime": "A String", # The time when the certificate was created in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>
+ "instance": "A String", # Name of the database instance.
+ },
+ "maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
+ "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
+ "masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup.
+ "instanceType": "A String", # The instance type. This can be one of the following.
+ # <br><code>CLOUD_SQL_INSTANCE</code>: A Cloud SQL instance that is not
+ # replicating from a master. <br><code>ON_PREMISES_INSTANCE</code>: An
+ # instance running on the
+ # customer's premises. <br><code>READ_REPLICA_INSTANCE</code>: A Cloud SQL
+ # instance configured as a read-replica.
+ "gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This
+ # value could be different from the zone that was specified when the instance
+ # was created if the instance has failed over to its secondary zone.
+ "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been
+ # deprecated. Users should use the
+ # "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud
+ # Monitoring API instead. Please see <a
+ # href="https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ">this
+ # announcement</a> for details.
+ "replicaConfiguration": { # Read-replica configuration for connecting to the master. # Configuration specific to failover replicas and read replicas.
+ "kind": "A String", # This is always <code>sql#replicaConfiguration</code>.
+ "mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # 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 <code>master.info</code>
+ # in the data directory.
+ "kind": "A String", # This is always <code>sql#mysqlReplicaConfiguration</code>.
+ "password": "A String", # The password for the replication connection.
+ "verifyServerCertificate": True or False, # Whether or not to check the master's Common Name value in the certificate
+ # that it sends during the SSL handshake.
+ "clientKey": "A String", # PEM representation of the slave's private key. The corresponsing public key
+ # is encoded in the client's certificate.
+ "sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption.
+ "masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats.
+ "connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds.
+ "dumpFilePath": "A String", # Path to a SQL dump file in Google Cloud Storage from which the slave
+ # instance is to be created. The URI is in the form gs:
+ # //bucketName/fileName. Compressed gzip files (.gz) are also supported.
+ # // Dumps should have the binlog co-ordinates from which replication should
+ # // begin. This can be accomplished by setting --master-data to 1 when using
+ # // mysqldump.
+ "clientCertificate": "A String", # PEM representation of the slave's x509 certificate.
+ "username": "A String", # The username for the replication connection.
+ "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
+ },
+ "failoverTarget": True or False, # Specifies if the replica is the failover target. If the field is set to
+ # <code>true</code> 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. <p>Only one replica can be specified as failover
+ # target, and the replica has to be in different zone with the master
+ # instance.
+ },
+ "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.
+ "failoverReplica": { # The name and status of the failover replica. This property is applicable
+ # only to Second Generation instances.
+ "available": True or False, # The availability status of the failover replica. A false status indicates
+ # that the failover replica is out of sync. The master can only failover to
+ # the failover replica when the status is true.
+ "name": "A String", # The name of the failover replica. If specified at instance creation, a
+ # failover replica is created for the instance. The name
+ # doesn't include the project ID. This property is applicable only to
+ # Second Generation instances.
+ },
+ "ipAddresses": [ # The assigned IP addresses for the instance.
+ { # Database instance IP Mapping.
+ "timeToRetire": "A String", # The due time for this IP to be retired in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>. This field is only available when
+ # the IP is scheduled to be retired.
+ "type": "A String", # The type of this IP address. A <code>PRIMARY</code> address is a public
+ # address that can accept incoming connections. A <code>PRIVATE</code>
+ # address is a private address that can accept incoming connections. An
+ # <code>OUTGOING</code> address is the source address of connections
+ # originating from the instance, if supported.
+ "ipAddress": "A String", # The IP address assigned.
+ },
+ ],
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource.&nbsp;For successful operations that return an
+ # Operation resource, only the fields relevant to the operation are populated
+ # in the resource.
+ "user": "A String", # The email address of the user who initiated this operation.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "targetLink": "A String",
+ "operationType": "A String", # The type of the operation. Valid values are <code>CREATE</code>,
+ # <code>DELETE</code>, <code>UPDATE</code>, <code>RESTART</code>,
+ # <code>IMPORT</code>, <code>EXPORT</code>, <code>BACKUP_VOLUME</code>,
+ # <code>RESTORE_VOLUME</code>, <code>CREATE_USER</code>,
+ # <code>DELETE_USER</code>, <code>CREATE_DATABASE</code>,
+ # <code>DELETE_DATABASE</code> .
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
+ # populated.
+ "errors": [ # The list of errors encountered while processing this operation.
+ { # Database instance operation error.
+ "code": "A String", # Identifies the specific error that occurred.
+ "message": "A String", # Additional information about the error encountered.
+ "kind": "A String", # This is always <code>sql#operationError</code>.
+ },
+ ],
+ "kind": "A String", # This is always <code>sql#operationErrors</code>.
+ },
+ "kind": "A String", # This is always <code>sql#operation</code>.
+ "importContext": { # Database instance import context. # The context for import operation, if applicable.
+ "csvImportOptions": { # Options for importing data as CSV.
+ "columns": [ # The columns to which CSV data is imported. If not specified, all columns
+ # of the database table are loaded with CSV data.
+ "A String",
+ ],
+ "table": "A String", # The table to which CSV data is imported.
+ },
+ "kind": "A String", # This is always <code>sql#importContext</code>.
+ "database": "A String", # The target database for the import. If <code>fileType</code> is
+ # <code>SQL</code>, this field is required only if the import file does not
+ # specify a database, and is overridden by any database specification in the
+ # import file. If <code>fileType</code> is <code>CSV</code>, one database
+ # must be specified.
+ "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
+ "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
+ "encryptionOptions": {
+ "pvkPassword": "A String", # Password that encrypts the private key
+ "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form
+ # <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
+ # form <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ },
+ },
+ "uri": "A String", # Path to the import file in Cloud Storage, in the form
+ # <code>gs:
+ # //bucketName/fileName</code>. Compressed gzip files (.gz) are supported
+ # // when <code>fileType</code> is <code>SQL</code>. The instance must have
+ # // write permissions to the bucket and read access to the file.
+ "fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ },
+ "status": "A String", # The status of an operation. Valid values are <code>PENDING</code>,
+ # <code>RUNNING</code>, <code>DONE</code>,
+ # <code>SQL_OPERATION_STATUS_UNSPECIFIED</code>.
+ "name": "A String", # An identifier that uniquely identifies the operation. You can use this
+ # identifier to retrieve the Operations resource that has information about
+ # the operation.
+ "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+ "databases": [ # Databases to be exported. <br /> <b>MySQL instances:</b> If
+ # <code>fileType</code> is <code>SQL</code> and no database is specified, all
+ # databases are exported, except for the <code>mysql</code> system database.
+ # If <code>fileType</code> is <code>CSV</code>, you can specify one database,
+ # either by using this property or by using the
+ # <code>csvExportOptions.selectQuery</code> property, which takes precedence
+ # over this property. <br /> <b>PostgreSQL instances:</b> You must specify
+ # one database to be exported. If <code>fileType</code> is <code>CSV</code>,
+ # this database must match the one specified in the
+ # <code>csvExportOptions.selectQuery</code> property.
+ "A String",
+ ],
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "tables": [ # Tables to export, or that were exported, from the specified database. If
+ # you specify tables, specify one and only one database. For PostgreSQL
+ # instances, you can specify only one table.
+ "A String",
+ ],
+ "schemaOnly": True or False, # Export only schemas.
+ "mysqlExportOptions": { # Options for exporting from MySQL.
+ "masterData": 42, # Option to include SQL statement required to set up replication.
+ # If set to <code>1</code>, the dump file includes
+ # a CHANGE MASTER TO statement with the binary log coordinates.
+ # If set to <code>2</code>, the CHANGE MASTER TO statement is written as
+ # a SQL comment, and has no effect.
+ # All other values are ignored.
+ },
+ },
+ "fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ "uri": "A String", # The path to the file in Google Cloud Storage where the export will be
+ # stored. The URI is in the form <code>gs:
+ # //bucketName/fileName</code>. If the file already exists, the requests
+ # // succeeds, but the operation fails. If <code>fileType</code> is
+ # // <code>SQL</code> and the filename ends with .gz, the contents are
+ # // compressed.
+ "csvExportOptions": { # Options for exporting data as CSV.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "kind": "A String", # This is always <code>sql#exportContext</code>.
+ },
+ "targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "startTime": "A String", # The time this operation actually started in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="promoteReplica">promoteReplica(project, instance, x__xgafv=None)</code>
+ <pre>Promotes the read replica instance to be a stand-alone Cloud SQL instance.
+Using this operation might cause your instance to restart.
+
+Args:
+ project: string, ID of the project that contains the read replica. (required)
+ instance: string, Cloud SQL read replica instance name. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource.&nbsp;For successful operations that return an
+ # Operation resource, only the fields relevant to the operation are populated
+ # in the resource.
+ "user": "A String", # The email address of the user who initiated this operation.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "targetLink": "A String",
+ "operationType": "A String", # The type of the operation. Valid values are <code>CREATE</code>,
+ # <code>DELETE</code>, <code>UPDATE</code>, <code>RESTART</code>,
+ # <code>IMPORT</code>, <code>EXPORT</code>, <code>BACKUP_VOLUME</code>,
+ # <code>RESTORE_VOLUME</code>, <code>CREATE_USER</code>,
+ # <code>DELETE_USER</code>, <code>CREATE_DATABASE</code>,
+ # <code>DELETE_DATABASE</code> .
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
+ # populated.
+ "errors": [ # The list of errors encountered while processing this operation.
+ { # Database instance operation error.
+ "code": "A String", # Identifies the specific error that occurred.
+ "message": "A String", # Additional information about the error encountered.
+ "kind": "A String", # This is always <code>sql#operationError</code>.
+ },
+ ],
+ "kind": "A String", # This is always <code>sql#operationErrors</code>.
+ },
+ "kind": "A String", # This is always <code>sql#operation</code>.
+ "importContext": { # Database instance import context. # The context for import operation, if applicable.
+ "csvImportOptions": { # Options for importing data as CSV.
+ "columns": [ # The columns to which CSV data is imported. If not specified, all columns
+ # of the database table are loaded with CSV data.
+ "A String",
+ ],
+ "table": "A String", # The table to which CSV data is imported.
+ },
+ "kind": "A String", # This is always <code>sql#importContext</code>.
+ "database": "A String", # The target database for the import. If <code>fileType</code> is
+ # <code>SQL</code>, this field is required only if the import file does not
+ # specify a database, and is overridden by any database specification in the
+ # import file. If <code>fileType</code> is <code>CSV</code>, one database
+ # must be specified.
+ "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
+ "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
+ "encryptionOptions": {
+ "pvkPassword": "A String", # Password that encrypts the private key
+ "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form
+ # <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
+ # form <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ },
+ },
+ "uri": "A String", # Path to the import file in Cloud Storage, in the form
+ # <code>gs:
+ # //bucketName/fileName</code>. Compressed gzip files (.gz) are supported
+ # // when <code>fileType</code> is <code>SQL</code>. The instance must have
+ # // write permissions to the bucket and read access to the file.
+ "fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ },
+ "status": "A String", # The status of an operation. Valid values are <code>PENDING</code>,
+ # <code>RUNNING</code>, <code>DONE</code>,
+ # <code>SQL_OPERATION_STATUS_UNSPECIFIED</code>.
+ "name": "A String", # An identifier that uniquely identifies the operation. You can use this
+ # identifier to retrieve the Operations resource that has information about
+ # the operation.
+ "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+ "databases": [ # Databases to be exported. <br /> <b>MySQL instances:</b> If
+ # <code>fileType</code> is <code>SQL</code> and no database is specified, all
+ # databases are exported, except for the <code>mysql</code> system database.
+ # If <code>fileType</code> is <code>CSV</code>, you can specify one database,
+ # either by using this property or by using the
+ # <code>csvExportOptions.selectQuery</code> property, which takes precedence
+ # over this property. <br /> <b>PostgreSQL instances:</b> You must specify
+ # one database to be exported. If <code>fileType</code> is <code>CSV</code>,
+ # this database must match the one specified in the
+ # <code>csvExportOptions.selectQuery</code> property.
+ "A String",
+ ],
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "tables": [ # Tables to export, or that were exported, from the specified database. If
+ # you specify tables, specify one and only one database. For PostgreSQL
+ # instances, you can specify only one table.
+ "A String",
+ ],
+ "schemaOnly": True or False, # Export only schemas.
+ "mysqlExportOptions": { # Options for exporting from MySQL.
+ "masterData": 42, # Option to include SQL statement required to set up replication.
+ # If set to <code>1</code>, the dump file includes
+ # a CHANGE MASTER TO statement with the binary log coordinates.
+ # If set to <code>2</code>, the CHANGE MASTER TO statement is written as
+ # a SQL comment, and has no effect.
+ # All other values are ignored.
+ },
+ },
+ "fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ "uri": "A String", # The path to the file in Google Cloud Storage where the export will be
+ # stored. The URI is in the form <code>gs:
+ # //bucketName/fileName</code>. If the file already exists, the requests
+ # // succeeds, but the operation fails. If <code>fileType</code> is
+ # // <code>SQL</code> and the filename ends with .gz, the contents are
+ # // compressed.
+ "csvExportOptions": { # Options for exporting data as CSV.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "kind": "A String", # This is always <code>sql#exportContext</code>.
+ },
+ "targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "startTime": "A String", # The time this operation actually started in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="resetSslConfig">resetSslConfig(project, instance, x__xgafv=None)</code>
+ <pre>Deletes all client certificates and generates a new server SSL certificate
+for the instance.
+
+Args:
+ project: string, Project ID of the project that contains the instance. (required)
+ instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource.&nbsp;For successful operations that return an
+ # Operation resource, only the fields relevant to the operation are populated
+ # in the resource.
+ "user": "A String", # The email address of the user who initiated this operation.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "targetLink": "A String",
+ "operationType": "A String", # The type of the operation. Valid values are <code>CREATE</code>,
+ # <code>DELETE</code>, <code>UPDATE</code>, <code>RESTART</code>,
+ # <code>IMPORT</code>, <code>EXPORT</code>, <code>BACKUP_VOLUME</code>,
+ # <code>RESTORE_VOLUME</code>, <code>CREATE_USER</code>,
+ # <code>DELETE_USER</code>, <code>CREATE_DATABASE</code>,
+ # <code>DELETE_DATABASE</code> .
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
+ # populated.
+ "errors": [ # The list of errors encountered while processing this operation.
+ { # Database instance operation error.
+ "code": "A String", # Identifies the specific error that occurred.
+ "message": "A String", # Additional information about the error encountered.
+ "kind": "A String", # This is always <code>sql#operationError</code>.
+ },
+ ],
+ "kind": "A String", # This is always <code>sql#operationErrors</code>.
+ },
+ "kind": "A String", # This is always <code>sql#operation</code>.
+ "importContext": { # Database instance import context. # The context for import operation, if applicable.
+ "csvImportOptions": { # Options for importing data as CSV.
+ "columns": [ # The columns to which CSV data is imported. If not specified, all columns
+ # of the database table are loaded with CSV data.
+ "A String",
+ ],
+ "table": "A String", # The table to which CSV data is imported.
+ },
+ "kind": "A String", # This is always <code>sql#importContext</code>.
+ "database": "A String", # The target database for the import. If <code>fileType</code> is
+ # <code>SQL</code>, this field is required only if the import file does not
+ # specify a database, and is overridden by any database specification in the
+ # import file. If <code>fileType</code> is <code>CSV</code>, one database
+ # must be specified.
+ "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
+ "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
+ "encryptionOptions": {
+ "pvkPassword": "A String", # Password that encrypts the private key
+ "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form
+ # <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
+ # form <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ },
+ },
+ "uri": "A String", # Path to the import file in Cloud Storage, in the form
+ # <code>gs:
+ # //bucketName/fileName</code>. Compressed gzip files (.gz) are supported
+ # // when <code>fileType</code> is <code>SQL</code>. The instance must have
+ # // write permissions to the bucket and read access to the file.
+ "fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ },
+ "status": "A String", # The status of an operation. Valid values are <code>PENDING</code>,
+ # <code>RUNNING</code>, <code>DONE</code>,
+ # <code>SQL_OPERATION_STATUS_UNSPECIFIED</code>.
+ "name": "A String", # An identifier that uniquely identifies the operation. You can use this
+ # identifier to retrieve the Operations resource that has information about
+ # the operation.
+ "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+ "databases": [ # Databases to be exported. <br /> <b>MySQL instances:</b> If
+ # <code>fileType</code> is <code>SQL</code> and no database is specified, all
+ # databases are exported, except for the <code>mysql</code> system database.
+ # If <code>fileType</code> is <code>CSV</code>, you can specify one database,
+ # either by using this property or by using the
+ # <code>csvExportOptions.selectQuery</code> property, which takes precedence
+ # over this property. <br /> <b>PostgreSQL instances:</b> You must specify
+ # one database to be exported. If <code>fileType</code> is <code>CSV</code>,
+ # this database must match the one specified in the
+ # <code>csvExportOptions.selectQuery</code> property.
+ "A String",
+ ],
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "tables": [ # Tables to export, or that were exported, from the specified database. If
+ # you specify tables, specify one and only one database. For PostgreSQL
+ # instances, you can specify only one table.
+ "A String",
+ ],
+ "schemaOnly": True or False, # Export only schemas.
+ "mysqlExportOptions": { # Options for exporting from MySQL.
+ "masterData": 42, # Option to include SQL statement required to set up replication.
+ # If set to <code>1</code>, the dump file includes
+ # a CHANGE MASTER TO statement with the binary log coordinates.
+ # If set to <code>2</code>, the CHANGE MASTER TO statement is written as
+ # a SQL comment, and has no effect.
+ # All other values are ignored.
+ },
+ },
+ "fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ "uri": "A String", # The path to the file in Google Cloud Storage where the export will be
+ # stored. The URI is in the form <code>gs:
+ # //bucketName/fileName</code>. If the file already exists, the requests
+ # // succeeds, but the operation fails. If <code>fileType</code> is
+ # // <code>SQL</code> and the filename ends with .gz, the contents are
+ # // compressed.
+ "csvExportOptions": { # Options for exporting data as CSV.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "kind": "A String", # This is always <code>sql#exportContext</code>.
+ },
+ "targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "startTime": "A String", # The time this operation actually started in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="restart">restart(project, instance, x__xgafv=None)</code>
+ <pre>Restarts a Cloud SQL instance.
+
+Args:
+ project: string, Project ID of the project that contains the instance to be restarted. (required)
+ instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource.&nbsp;For successful operations that return an
+ # Operation resource, only the fields relevant to the operation are populated
+ # in the resource.
+ "user": "A String", # The email address of the user who initiated this operation.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "targetLink": "A String",
+ "operationType": "A String", # The type of the operation. Valid values are <code>CREATE</code>,
+ # <code>DELETE</code>, <code>UPDATE</code>, <code>RESTART</code>,
+ # <code>IMPORT</code>, <code>EXPORT</code>, <code>BACKUP_VOLUME</code>,
+ # <code>RESTORE_VOLUME</code>, <code>CREATE_USER</code>,
+ # <code>DELETE_USER</code>, <code>CREATE_DATABASE</code>,
+ # <code>DELETE_DATABASE</code> .
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
+ # populated.
+ "errors": [ # The list of errors encountered while processing this operation.
+ { # Database instance operation error.
+ "code": "A String", # Identifies the specific error that occurred.
+ "message": "A String", # Additional information about the error encountered.
+ "kind": "A String", # This is always <code>sql#operationError</code>.
+ },
+ ],
+ "kind": "A String", # This is always <code>sql#operationErrors</code>.
+ },
+ "kind": "A String", # This is always <code>sql#operation</code>.
+ "importContext": { # Database instance import context. # The context for import operation, if applicable.
+ "csvImportOptions": { # Options for importing data as CSV.
+ "columns": [ # The columns to which CSV data is imported. If not specified, all columns
+ # of the database table are loaded with CSV data.
+ "A String",
+ ],
+ "table": "A String", # The table to which CSV data is imported.
+ },
+ "kind": "A String", # This is always <code>sql#importContext</code>.
+ "database": "A String", # The target database for the import. If <code>fileType</code> is
+ # <code>SQL</code>, this field is required only if the import file does not
+ # specify a database, and is overridden by any database specification in the
+ # import file. If <code>fileType</code> is <code>CSV</code>, one database
+ # must be specified.
+ "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
+ "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
+ "encryptionOptions": {
+ "pvkPassword": "A String", # Password that encrypts the private key
+ "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form
+ # <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
+ # form <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ },
+ },
+ "uri": "A String", # Path to the import file in Cloud Storage, in the form
+ # <code>gs:
+ # //bucketName/fileName</code>. Compressed gzip files (.gz) are supported
+ # // when <code>fileType</code> is <code>SQL</code>. The instance must have
+ # // write permissions to the bucket and read access to the file.
+ "fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ },
+ "status": "A String", # The status of an operation. Valid values are <code>PENDING</code>,
+ # <code>RUNNING</code>, <code>DONE</code>,
+ # <code>SQL_OPERATION_STATUS_UNSPECIFIED</code>.
+ "name": "A String", # An identifier that uniquely identifies the operation. You can use this
+ # identifier to retrieve the Operations resource that has information about
+ # the operation.
+ "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+ "databases": [ # Databases to be exported. <br /> <b>MySQL instances:</b> If
+ # <code>fileType</code> is <code>SQL</code> and no database is specified, all
+ # databases are exported, except for the <code>mysql</code> system database.
+ # If <code>fileType</code> is <code>CSV</code>, you can specify one database,
+ # either by using this property or by using the
+ # <code>csvExportOptions.selectQuery</code> property, which takes precedence
+ # over this property. <br /> <b>PostgreSQL instances:</b> You must specify
+ # one database to be exported. If <code>fileType</code> is <code>CSV</code>,
+ # this database must match the one specified in the
+ # <code>csvExportOptions.selectQuery</code> property.
+ "A String",
+ ],
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "tables": [ # Tables to export, or that were exported, from the specified database. If
+ # you specify tables, specify one and only one database. For PostgreSQL
+ # instances, you can specify only one table.
+ "A String",
+ ],
+ "schemaOnly": True or False, # Export only schemas.
+ "mysqlExportOptions": { # Options for exporting from MySQL.
+ "masterData": 42, # Option to include SQL statement required to set up replication.
+ # If set to <code>1</code>, the dump file includes
+ # a CHANGE MASTER TO statement with the binary log coordinates.
+ # If set to <code>2</code>, the CHANGE MASTER TO statement is written as
+ # a SQL comment, and has no effect.
+ # All other values are ignored.
+ },
+ },
+ "fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ "uri": "A String", # The path to the file in Google Cloud Storage where the export will be
+ # stored. The URI is in the form <code>gs:
+ # //bucketName/fileName</code>. If the file already exists, the requests
+ # // succeeds, but the operation fails. If <code>fileType</code> is
+ # // <code>SQL</code> and the filename ends with .gz, the contents are
+ # // compressed.
+ "csvExportOptions": { # Options for exporting data as CSV.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "kind": "A String", # This is always <code>sql#exportContext</code>.
+ },
+ "targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "startTime": "A String", # The time this operation actually started in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="restoreBackup">restoreBackup(project, instance, body=None, x__xgafv=None)</code>
+ <pre>Restores a backup of a Cloud SQL instance. Using this operation might cause
+your instance to restart.
+
+Args:
+ project: string, Project ID of the project that contains the instance. (required)
+ instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Database instance restore backup request.
+ "restoreBackupContext": { # Database instance restore from backup context. # Parameters required to perform the restore backup operation.
+ # Backup context contains source instance id and project id.
+ "instanceId": "A String", # The ID of the instance that the backup was taken from.
+ "kind": "A String", # This is always <code>sql#restoreBackupContext</code>.
+ "project": "A String", # The full project ID of the source instance.
+ "backupRunId": "A String", # The ID of the backup run to restore from.
+ },
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource.&nbsp;For successful operations that return an
+ # Operation resource, only the fields relevant to the operation are populated
+ # in the resource.
+ "user": "A String", # The email address of the user who initiated this operation.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "targetLink": "A String",
+ "operationType": "A String", # The type of the operation. Valid values are <code>CREATE</code>,
+ # <code>DELETE</code>, <code>UPDATE</code>, <code>RESTART</code>,
+ # <code>IMPORT</code>, <code>EXPORT</code>, <code>BACKUP_VOLUME</code>,
+ # <code>RESTORE_VOLUME</code>, <code>CREATE_USER</code>,
+ # <code>DELETE_USER</code>, <code>CREATE_DATABASE</code>,
+ # <code>DELETE_DATABASE</code> .
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
+ # populated.
+ "errors": [ # The list of errors encountered while processing this operation.
+ { # Database instance operation error.
+ "code": "A String", # Identifies the specific error that occurred.
+ "message": "A String", # Additional information about the error encountered.
+ "kind": "A String", # This is always <code>sql#operationError</code>.
+ },
+ ],
+ "kind": "A String", # This is always <code>sql#operationErrors</code>.
+ },
+ "kind": "A String", # This is always <code>sql#operation</code>.
+ "importContext": { # Database instance import context. # The context for import operation, if applicable.
+ "csvImportOptions": { # Options for importing data as CSV.
+ "columns": [ # The columns to which CSV data is imported. If not specified, all columns
+ # of the database table are loaded with CSV data.
+ "A String",
+ ],
+ "table": "A String", # The table to which CSV data is imported.
+ },
+ "kind": "A String", # This is always <code>sql#importContext</code>.
+ "database": "A String", # The target database for the import. If <code>fileType</code> is
+ # <code>SQL</code>, this field is required only if the import file does not
+ # specify a database, and is overridden by any database specification in the
+ # import file. If <code>fileType</code> is <code>CSV</code>, one database
+ # must be specified.
+ "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
+ "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
+ "encryptionOptions": {
+ "pvkPassword": "A String", # Password that encrypts the private key
+ "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form
+ # <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
+ # form <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ },
+ },
+ "uri": "A String", # Path to the import file in Cloud Storage, in the form
+ # <code>gs:
+ # //bucketName/fileName</code>. Compressed gzip files (.gz) are supported
+ # // when <code>fileType</code> is <code>SQL</code>. The instance must have
+ # // write permissions to the bucket and read access to the file.
+ "fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ },
+ "status": "A String", # The status of an operation. Valid values are <code>PENDING</code>,
+ # <code>RUNNING</code>, <code>DONE</code>,
+ # <code>SQL_OPERATION_STATUS_UNSPECIFIED</code>.
+ "name": "A String", # An identifier that uniquely identifies the operation. You can use this
+ # identifier to retrieve the Operations resource that has information about
+ # the operation.
+ "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+ "databases": [ # Databases to be exported. <br /> <b>MySQL instances:</b> If
+ # <code>fileType</code> is <code>SQL</code> and no database is specified, all
+ # databases are exported, except for the <code>mysql</code> system database.
+ # If <code>fileType</code> is <code>CSV</code>, you can specify one database,
+ # either by using this property or by using the
+ # <code>csvExportOptions.selectQuery</code> property, which takes precedence
+ # over this property. <br /> <b>PostgreSQL instances:</b> You must specify
+ # one database to be exported. If <code>fileType</code> is <code>CSV</code>,
+ # this database must match the one specified in the
+ # <code>csvExportOptions.selectQuery</code> property.
+ "A String",
+ ],
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "tables": [ # Tables to export, or that were exported, from the specified database. If
+ # you specify tables, specify one and only one database. For PostgreSQL
+ # instances, you can specify only one table.
+ "A String",
+ ],
+ "schemaOnly": True or False, # Export only schemas.
+ "mysqlExportOptions": { # Options for exporting from MySQL.
+ "masterData": 42, # Option to include SQL statement required to set up replication.
+ # If set to <code>1</code>, the dump file includes
+ # a CHANGE MASTER TO statement with the binary log coordinates.
+ # If set to <code>2</code>, the CHANGE MASTER TO statement is written as
+ # a SQL comment, and has no effect.
+ # All other values are ignored.
+ },
+ },
+ "fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ "uri": "A String", # The path to the file in Google Cloud Storage where the export will be
+ # stored. The URI is in the form <code>gs:
+ # //bucketName/fileName</code>. If the file already exists, the requests
+ # // succeeds, but the operation fails. If <code>fileType</code> is
+ # // <code>SQL</code> and the filename ends with .gz, the contents are
+ # // compressed.
+ "csvExportOptions": { # Options for exporting data as CSV.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "kind": "A String", # This is always <code>sql#exportContext</code>.
+ },
+ "targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "startTime": "A String", # The time this operation actually started in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="rotateServerCa">rotateServerCa(project, instance, body=None, x__xgafv=None)</code>
+ <pre>Rotates the server certificate to one signed by the Certificate Authority
+(CA) version previously added with the addServerCA method.
+
+Args:
+ project: string, Project ID of the project that contains the instance. (required)
+ instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Rotate Server CA request.
+ "rotateServerCaContext": { # Instance rotate server CA context. # Contains details about the rotate server CA operation.
+ "kind": "A String", # This is always <code>sql#rotateServerCaContext</code>.
+ "nextVersion": "A String", # The fingerprint of the next version to be rotated to. If left unspecified,
+ # will be rotated to the most recently added server CA version.
+ },
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource.&nbsp;For successful operations that return an
+ # Operation resource, only the fields relevant to the operation are populated
+ # in the resource.
+ "user": "A String", # The email address of the user who initiated this operation.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "targetLink": "A String",
+ "operationType": "A String", # The type of the operation. Valid values are <code>CREATE</code>,
+ # <code>DELETE</code>, <code>UPDATE</code>, <code>RESTART</code>,
+ # <code>IMPORT</code>, <code>EXPORT</code>, <code>BACKUP_VOLUME</code>,
+ # <code>RESTORE_VOLUME</code>, <code>CREATE_USER</code>,
+ # <code>DELETE_USER</code>, <code>CREATE_DATABASE</code>,
+ # <code>DELETE_DATABASE</code> .
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
+ # populated.
+ "errors": [ # The list of errors encountered while processing this operation.
+ { # Database instance operation error.
+ "code": "A String", # Identifies the specific error that occurred.
+ "message": "A String", # Additional information about the error encountered.
+ "kind": "A String", # This is always <code>sql#operationError</code>.
+ },
+ ],
+ "kind": "A String", # This is always <code>sql#operationErrors</code>.
+ },
+ "kind": "A String", # This is always <code>sql#operation</code>.
+ "importContext": { # Database instance import context. # The context for import operation, if applicable.
+ "csvImportOptions": { # Options for importing data as CSV.
+ "columns": [ # The columns to which CSV data is imported. If not specified, all columns
+ # of the database table are loaded with CSV data.
+ "A String",
+ ],
+ "table": "A String", # The table to which CSV data is imported.
+ },
+ "kind": "A String", # This is always <code>sql#importContext</code>.
+ "database": "A String", # The target database for the import. If <code>fileType</code> is
+ # <code>SQL</code>, this field is required only if the import file does not
+ # specify a database, and is overridden by any database specification in the
+ # import file. If <code>fileType</code> is <code>CSV</code>, one database
+ # must be specified.
+ "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
+ "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
+ "encryptionOptions": {
+ "pvkPassword": "A String", # Password that encrypts the private key
+ "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form
+ # <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
+ # form <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ },
+ },
+ "uri": "A String", # Path to the import file in Cloud Storage, in the form
+ # <code>gs:
+ # //bucketName/fileName</code>. Compressed gzip files (.gz) are supported
+ # // when <code>fileType</code> is <code>SQL</code>. The instance must have
+ # // write permissions to the bucket and read access to the file.
+ "fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ },
+ "status": "A String", # The status of an operation. Valid values are <code>PENDING</code>,
+ # <code>RUNNING</code>, <code>DONE</code>,
+ # <code>SQL_OPERATION_STATUS_UNSPECIFIED</code>.
+ "name": "A String", # An identifier that uniquely identifies the operation. You can use this
+ # identifier to retrieve the Operations resource that has information about
+ # the operation.
+ "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+ "databases": [ # Databases to be exported. <br /> <b>MySQL instances:</b> If
+ # <code>fileType</code> is <code>SQL</code> and no database is specified, all
+ # databases are exported, except for the <code>mysql</code> system database.
+ # If <code>fileType</code> is <code>CSV</code>, you can specify one database,
+ # either by using this property or by using the
+ # <code>csvExportOptions.selectQuery</code> property, which takes precedence
+ # over this property. <br /> <b>PostgreSQL instances:</b> You must specify
+ # one database to be exported. If <code>fileType</code> is <code>CSV</code>,
+ # this database must match the one specified in the
+ # <code>csvExportOptions.selectQuery</code> property.
+ "A String",
+ ],
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "tables": [ # Tables to export, or that were exported, from the specified database. If
+ # you specify tables, specify one and only one database. For PostgreSQL
+ # instances, you can specify only one table.
+ "A String",
+ ],
+ "schemaOnly": True or False, # Export only schemas.
+ "mysqlExportOptions": { # Options for exporting from MySQL.
+ "masterData": 42, # Option to include SQL statement required to set up replication.
+ # If set to <code>1</code>, the dump file includes
+ # a CHANGE MASTER TO statement with the binary log coordinates.
+ # If set to <code>2</code>, the CHANGE MASTER TO statement is written as
+ # a SQL comment, and has no effect.
+ # All other values are ignored.
+ },
+ },
+ "fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ "uri": "A String", # The path to the file in Google Cloud Storage where the export will be
+ # stored. The URI is in the form <code>gs:
+ # //bucketName/fileName</code>. If the file already exists, the requests
+ # // succeeds, but the operation fails. If <code>fileType</code> is
+ # // <code>SQL</code> and the filename ends with .gz, the contents are
+ # // compressed.
+ "csvExportOptions": { # Options for exporting data as CSV.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "kind": "A String", # This is always <code>sql#exportContext</code>.
+ },
+ "targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "startTime": "A String", # The time this operation actually started in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="startReplica">startReplica(project, instance, x__xgafv=None)</code>
+ <pre>Starts the replication in the read replica instance.
+
+Args:
+ project: string, ID of the project that contains the read replica. (required)
+ instance: string, Cloud SQL read replica instance name. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource.&nbsp;For successful operations that return an
+ # Operation resource, only the fields relevant to the operation are populated
+ # in the resource.
+ "user": "A String", # The email address of the user who initiated this operation.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "targetLink": "A String",
+ "operationType": "A String", # The type of the operation. Valid values are <code>CREATE</code>,
+ # <code>DELETE</code>, <code>UPDATE</code>, <code>RESTART</code>,
+ # <code>IMPORT</code>, <code>EXPORT</code>, <code>BACKUP_VOLUME</code>,
+ # <code>RESTORE_VOLUME</code>, <code>CREATE_USER</code>,
+ # <code>DELETE_USER</code>, <code>CREATE_DATABASE</code>,
+ # <code>DELETE_DATABASE</code> .
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
+ # populated.
+ "errors": [ # The list of errors encountered while processing this operation.
+ { # Database instance operation error.
+ "code": "A String", # Identifies the specific error that occurred.
+ "message": "A String", # Additional information about the error encountered.
+ "kind": "A String", # This is always <code>sql#operationError</code>.
+ },
+ ],
+ "kind": "A String", # This is always <code>sql#operationErrors</code>.
+ },
+ "kind": "A String", # This is always <code>sql#operation</code>.
+ "importContext": { # Database instance import context. # The context for import operation, if applicable.
+ "csvImportOptions": { # Options for importing data as CSV.
+ "columns": [ # The columns to which CSV data is imported. If not specified, all columns
+ # of the database table are loaded with CSV data.
+ "A String",
+ ],
+ "table": "A String", # The table to which CSV data is imported.
+ },
+ "kind": "A String", # This is always <code>sql#importContext</code>.
+ "database": "A String", # The target database for the import. If <code>fileType</code> is
+ # <code>SQL</code>, this field is required only if the import file does not
+ # specify a database, and is overridden by any database specification in the
+ # import file. If <code>fileType</code> is <code>CSV</code>, one database
+ # must be specified.
+ "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
+ "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
+ "encryptionOptions": {
+ "pvkPassword": "A String", # Password that encrypts the private key
+ "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form
+ # <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
+ # form <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ },
+ },
+ "uri": "A String", # Path to the import file in Cloud Storage, in the form
+ # <code>gs:
+ # //bucketName/fileName</code>. Compressed gzip files (.gz) are supported
+ # // when <code>fileType</code> is <code>SQL</code>. The instance must have
+ # // write permissions to the bucket and read access to the file.
+ "fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ },
+ "status": "A String", # The status of an operation. Valid values are <code>PENDING</code>,
+ # <code>RUNNING</code>, <code>DONE</code>,
+ # <code>SQL_OPERATION_STATUS_UNSPECIFIED</code>.
+ "name": "A String", # An identifier that uniquely identifies the operation. You can use this
+ # identifier to retrieve the Operations resource that has information about
+ # the operation.
+ "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+ "databases": [ # Databases to be exported. <br /> <b>MySQL instances:</b> If
+ # <code>fileType</code> is <code>SQL</code> and no database is specified, all
+ # databases are exported, except for the <code>mysql</code> system database.
+ # If <code>fileType</code> is <code>CSV</code>, you can specify one database,
+ # either by using this property or by using the
+ # <code>csvExportOptions.selectQuery</code> property, which takes precedence
+ # over this property. <br /> <b>PostgreSQL instances:</b> You must specify
+ # one database to be exported. If <code>fileType</code> is <code>CSV</code>,
+ # this database must match the one specified in the
+ # <code>csvExportOptions.selectQuery</code> property.
+ "A String",
+ ],
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "tables": [ # Tables to export, or that were exported, from the specified database. If
+ # you specify tables, specify one and only one database. For PostgreSQL
+ # instances, you can specify only one table.
+ "A String",
+ ],
+ "schemaOnly": True or False, # Export only schemas.
+ "mysqlExportOptions": { # Options for exporting from MySQL.
+ "masterData": 42, # Option to include SQL statement required to set up replication.
+ # If set to <code>1</code>, the dump file includes
+ # a CHANGE MASTER TO statement with the binary log coordinates.
+ # If set to <code>2</code>, the CHANGE MASTER TO statement is written as
+ # a SQL comment, and has no effect.
+ # All other values are ignored.
+ },
+ },
+ "fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ "uri": "A String", # The path to the file in Google Cloud Storage where the export will be
+ # stored. The URI is in the form <code>gs:
+ # //bucketName/fileName</code>. If the file already exists, the requests
+ # // succeeds, but the operation fails. If <code>fileType</code> is
+ # // <code>SQL</code> and the filename ends with .gz, the contents are
+ # // compressed.
+ "csvExportOptions": { # Options for exporting data as CSV.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "kind": "A String", # This is always <code>sql#exportContext</code>.
+ },
+ "targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "startTime": "A String", # The time this operation actually started in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="stopReplica">stopReplica(project, instance, x__xgafv=None)</code>
+ <pre>Stops the replication in the read replica instance.
+
+Args:
+ project: string, ID of the project that contains the read replica. (required)
+ instance: string, Cloud SQL read replica instance name. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource.&nbsp;For successful operations that return an
+ # Operation resource, only the fields relevant to the operation are populated
+ # in the resource.
+ "user": "A String", # The email address of the user who initiated this operation.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "targetLink": "A String",
+ "operationType": "A String", # The type of the operation. Valid values are <code>CREATE</code>,
+ # <code>DELETE</code>, <code>UPDATE</code>, <code>RESTART</code>,
+ # <code>IMPORT</code>, <code>EXPORT</code>, <code>BACKUP_VOLUME</code>,
+ # <code>RESTORE_VOLUME</code>, <code>CREATE_USER</code>,
+ # <code>DELETE_USER</code>, <code>CREATE_DATABASE</code>,
+ # <code>DELETE_DATABASE</code> .
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
+ # populated.
+ "errors": [ # The list of errors encountered while processing this operation.
+ { # Database instance operation error.
+ "code": "A String", # Identifies the specific error that occurred.
+ "message": "A String", # Additional information about the error encountered.
+ "kind": "A String", # This is always <code>sql#operationError</code>.
+ },
+ ],
+ "kind": "A String", # This is always <code>sql#operationErrors</code>.
+ },
+ "kind": "A String", # This is always <code>sql#operation</code>.
+ "importContext": { # Database instance import context. # The context for import operation, if applicable.
+ "csvImportOptions": { # Options for importing data as CSV.
+ "columns": [ # The columns to which CSV data is imported. If not specified, all columns
+ # of the database table are loaded with CSV data.
+ "A String",
+ ],
+ "table": "A String", # The table to which CSV data is imported.
+ },
+ "kind": "A String", # This is always <code>sql#importContext</code>.
+ "database": "A String", # The target database for the import. If <code>fileType</code> is
+ # <code>SQL</code>, this field is required only if the import file does not
+ # specify a database, and is overridden by any database specification in the
+ # import file. If <code>fileType</code> is <code>CSV</code>, one database
+ # must be specified.
+ "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
+ "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
+ "encryptionOptions": {
+ "pvkPassword": "A String", # Password that encrypts the private key
+ "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form
+ # <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
+ # form <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ },
+ },
+ "uri": "A String", # Path to the import file in Cloud Storage, in the form
+ # <code>gs:
+ # //bucketName/fileName</code>. Compressed gzip files (.gz) are supported
+ # // when <code>fileType</code> is <code>SQL</code>. The instance must have
+ # // write permissions to the bucket and read access to the file.
+ "fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ },
+ "status": "A String", # The status of an operation. Valid values are <code>PENDING</code>,
+ # <code>RUNNING</code>, <code>DONE</code>,
+ # <code>SQL_OPERATION_STATUS_UNSPECIFIED</code>.
+ "name": "A String", # An identifier that uniquely identifies the operation. You can use this
+ # identifier to retrieve the Operations resource that has information about
+ # the operation.
+ "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+ "databases": [ # Databases to be exported. <br /> <b>MySQL instances:</b> If
+ # <code>fileType</code> is <code>SQL</code> and no database is specified, all
+ # databases are exported, except for the <code>mysql</code> system database.
+ # If <code>fileType</code> is <code>CSV</code>, you can specify one database,
+ # either by using this property or by using the
+ # <code>csvExportOptions.selectQuery</code> property, which takes precedence
+ # over this property. <br /> <b>PostgreSQL instances:</b> You must specify
+ # one database to be exported. If <code>fileType</code> is <code>CSV</code>,
+ # this database must match the one specified in the
+ # <code>csvExportOptions.selectQuery</code> property.
+ "A String",
+ ],
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "tables": [ # Tables to export, or that were exported, from the specified database. If
+ # you specify tables, specify one and only one database. For PostgreSQL
+ # instances, you can specify only one table.
+ "A String",
+ ],
+ "schemaOnly": True or False, # Export only schemas.
+ "mysqlExportOptions": { # Options for exporting from MySQL.
+ "masterData": 42, # Option to include SQL statement required to set up replication.
+ # If set to <code>1</code>, the dump file includes
+ # a CHANGE MASTER TO statement with the binary log coordinates.
+ # If set to <code>2</code>, the CHANGE MASTER TO statement is written as
+ # a SQL comment, and has no effect.
+ # All other values are ignored.
+ },
+ },
+ "fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ "uri": "A String", # The path to the file in Google Cloud Storage where the export will be
+ # stored. The URI is in the form <code>gs:
+ # //bucketName/fileName</code>. If the file already exists, the requests
+ # // succeeds, but the operation fails. If <code>fileType</code> is
+ # // <code>SQL</code> and the filename ends with .gz, the contents are
+ # // compressed.
+ "csvExportOptions": { # Options for exporting data as CSV.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "kind": "A String", # This is always <code>sql#exportContext</code>.
+ },
+ "targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "startTime": "A String", # The time this operation actually started in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="truncateLog">truncateLog(project, instance, body=None, x__xgafv=None)</code>
+ <pre>Truncate MySQL general and slow query log tables
+
+Args:
+ project: string, Project ID of the Cloud SQL project. (required)
+ instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Instance truncate log request.
+ "truncateLogContext": { # Database Instance truncate log context. # Contains details about the truncate log operation.
+ "logType": "A String", # The type of log to truncate. Valid values are
+ # <code>MYSQL_GENERAL_TABLE</code> and <code>MYSQL_SLOW_TABLE</code>.
+ "kind": "A String", # This is always <code>sql#truncateLogContext</code>.
+ },
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource.&nbsp;For successful operations that return an
+ # Operation resource, only the fields relevant to the operation are populated
+ # in the resource.
+ "user": "A String", # The email address of the user who initiated this operation.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "targetLink": "A String",
+ "operationType": "A String", # The type of the operation. Valid values are <code>CREATE</code>,
+ # <code>DELETE</code>, <code>UPDATE</code>, <code>RESTART</code>,
+ # <code>IMPORT</code>, <code>EXPORT</code>, <code>BACKUP_VOLUME</code>,
+ # <code>RESTORE_VOLUME</code>, <code>CREATE_USER</code>,
+ # <code>DELETE_USER</code>, <code>CREATE_DATABASE</code>,
+ # <code>DELETE_DATABASE</code> .
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
+ # populated.
+ "errors": [ # The list of errors encountered while processing this operation.
+ { # Database instance operation error.
+ "code": "A String", # Identifies the specific error that occurred.
+ "message": "A String", # Additional information about the error encountered.
+ "kind": "A String", # This is always <code>sql#operationError</code>.
+ },
+ ],
+ "kind": "A String", # This is always <code>sql#operationErrors</code>.
+ },
+ "kind": "A String", # This is always <code>sql#operation</code>.
+ "importContext": { # Database instance import context. # The context for import operation, if applicable.
+ "csvImportOptions": { # Options for importing data as CSV.
+ "columns": [ # The columns to which CSV data is imported. If not specified, all columns
+ # of the database table are loaded with CSV data.
+ "A String",
+ ],
+ "table": "A String", # The table to which CSV data is imported.
+ },
+ "kind": "A String", # This is always <code>sql#importContext</code>.
+ "database": "A String", # The target database for the import. If <code>fileType</code> is
+ # <code>SQL</code>, this field is required only if the import file does not
+ # specify a database, and is overridden by any database specification in the
+ # import file. If <code>fileType</code> is <code>CSV</code>, one database
+ # must be specified.
+ "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
+ "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
+ "encryptionOptions": {
+ "pvkPassword": "A String", # Password that encrypts the private key
+ "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form
+ # <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
+ # form <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ },
+ },
+ "uri": "A String", # Path to the import file in Cloud Storage, in the form
+ # <code>gs:
+ # //bucketName/fileName</code>. Compressed gzip files (.gz) are supported
+ # // when <code>fileType</code> is <code>SQL</code>. The instance must have
+ # // write permissions to the bucket and read access to the file.
+ "fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ },
+ "status": "A String", # The status of an operation. Valid values are <code>PENDING</code>,
+ # <code>RUNNING</code>, <code>DONE</code>,
+ # <code>SQL_OPERATION_STATUS_UNSPECIFIED</code>.
+ "name": "A String", # An identifier that uniquely identifies the operation. You can use this
+ # identifier to retrieve the Operations resource that has information about
+ # the operation.
+ "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+ "databases": [ # Databases to be exported. <br /> <b>MySQL instances:</b> If
+ # <code>fileType</code> is <code>SQL</code> and no database is specified, all
+ # databases are exported, except for the <code>mysql</code> system database.
+ # If <code>fileType</code> is <code>CSV</code>, you can specify one database,
+ # either by using this property or by using the
+ # <code>csvExportOptions.selectQuery</code> property, which takes precedence
+ # over this property. <br /> <b>PostgreSQL instances:</b> You must specify
+ # one database to be exported. If <code>fileType</code> is <code>CSV</code>,
+ # this database must match the one specified in the
+ # <code>csvExportOptions.selectQuery</code> property.
+ "A String",
+ ],
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "tables": [ # Tables to export, or that were exported, from the specified database. If
+ # you specify tables, specify one and only one database. For PostgreSQL
+ # instances, you can specify only one table.
+ "A String",
+ ],
+ "schemaOnly": True or False, # Export only schemas.
+ "mysqlExportOptions": { # Options for exporting from MySQL.
+ "masterData": 42, # Option to include SQL statement required to set up replication.
+ # If set to <code>1</code>, the dump file includes
+ # a CHANGE MASTER TO statement with the binary log coordinates.
+ # If set to <code>2</code>, the CHANGE MASTER TO statement is written as
+ # a SQL comment, and has no effect.
+ # All other values are ignored.
+ },
+ },
+ "fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ "uri": "A String", # The path to the file in Google Cloud Storage where the export will be
+ # stored. The URI is in the form <code>gs:
+ # //bucketName/fileName</code>. If the file already exists, the requests
+ # // succeeds, but the operation fails. If <code>fileType</code> is
+ # // <code>SQL</code> and the filename ends with .gz, the contents are
+ # // compressed.
+ "csvExportOptions": { # Options for exporting data as CSV.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "kind": "A String", # This is always <code>sql#exportContext</code>.
+ },
+ "targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "startTime": "A String", # The time this operation actually started in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(project, instance, body=None, x__xgafv=None)</code>
+ <pre>Updates settings of a Cloud SQL instance. Using this operation might cause
+your instance to restart.
+
+Args:
+ project: string, Project ID of the project that contains the instance. (required)
+ instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A Cloud SQL instance resource.
+ "ipv6Address": "A String", # The IPv6 address assigned to the instance. This property is applicable only
+ # to First Generation instances.
+ "selfLink": "A String", # The URI of this resource.
+ "diskEncryptionStatus": { # Disk encryption status for an instance. # Disk encryption status specific to an instance.
+ # Applies only to Second Generation instances.
+ "kmsKeyVersionName": "A String", # KMS key version used to encrypt the Cloud SQL instance resource
+ "kind": "A String", # This is always <code>sql#diskEncryptionStatus</code>.
+ },
+ "kind": "A String", # This is always <code>sql#instance</code>.
+ "region": "A String", # The geographical region. Can be <code>us-central</code>
+ # (<code>FIRST_GEN</code> instances only), <code>us-central1</code>
+ # (<code>SECOND_GEN</code> instances only), <code>asia-east1</code> or
+ # <code>europe-west1</code>. Defaults to <code>us-central</code> or
+ # <code>us-central1</code> depending on the instance type (First Generation
+ # or Second Generation). The region can not be changed after instance
+ # creation.
+ "state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the
+ # following. <br><code>RUNNABLE</code>: The instance is running, or is ready
+ # to run when accessed. <br><code>SUSPENDED</code>: The instance is not
+ # available, for example due to problems with billing.
+ # <br><code>PENDING_CREATE</code>: The instance is being created.
+ # <br><code>MAINTENANCE</code>: The instance is down for maintenance.
+ # <br><code>FAILED</code>: The instance creation failed.
+ # <br><code>UNKNOWN_STATE</code>: The state of the instance is unknown.
+ "backendType": "A String", # <code>FIRST_GEN</code>: First Generation instance. MySQL only. <br
+ # /><code>SECOND_GEN</code>: Second Generation instance or PostgreSQL
+ # instance. <br /><code>EXTERNAL</code>: A database server that is not
+ # managed by Google. <br>This property is read-only; use the
+ # <code>tier</code> property in the <code>settings</code> object to determine
+ # the database type and Second or First Generation.
+ "onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances.
+ "hostPort": "A String", # The host and port of the on-premises instance in host:port format
+ "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica.
+ "clientCertificate": "A String", # PEM representation of the slave's x509 certificate.
+ "username": "A String", # The username for connecting to on-premises instance.
+ "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
+ "kind": "A String", # This is always <code>sql#onPremisesConfiguration</code>.
+ "password": "A String", # The password for connecting to on-premises instance.
+ "clientKey": "A String", # PEM representation of the slave's private key. The corresponsing public key
+ # is encoded in the client's certificate.
+ },
+ "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google
+ # apps domain is prefixed if applicable.
+ "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance. This property
+ # is applicable only to Second Generation instances.
+ "databaseVersion": "A String", # The database engine type and version. The <code>databaseVersion</code>
+ # field can not be changed after instance creation. MySQL Second Generation
+ # instances: <code>MYSQL_5_7</code> (default) or <code>MYSQL_5_6</code>.
+ # PostgreSQL instances: <code>POSTGRES_9_6</code> (default) or
+ # <code>POSTGRES_11 Beta</code> MySQL First Generation
+ # instances: <code>MYSQL_5_6</code> (default) or <code>MYSQL_5_5</code>
+ "suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension.
+ "A String",
+ ],
+ "settings": { # Database instance settings. # The user settings.
+ "ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the
+ # instance IP and manage which external networks can connect to the instance.
+ # The IPv4 address cannot be disabled for Second Generation instances.
+ "privateNetwork": "A String", # The resource link for the VPC network from which the Cloud SQL instance is
+ # accessible for private IP. For example,
+ # <code>/projects/myProject/global/networks/default</code>. This setting can
+ # be updated, but it cannot be removed after it is set.
+ "ipv4Enabled": True or False, # Whether the instance should be assigned an IP address or not.
+ "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance
+ # using the IP. In <a
+ # href="http://en.wikipedia.org/wiki/CIDR_notation#CIDR_notation">CIDR
+ # notation</a>, also known as 'slash' notation (e.g.
+ # <code>192.168.100.0/24</code>).
+ { # An entry for an Access Control list.
+ "value": "A String", # The whitelisted value for the access control list.
+ "expirationTime": "A String", # The time when this access control entry expires in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "name": "A String", # Optional. A label to identify this entry.
+ "kind": "A String", # This is always <code>sql#aclEntry</code>.
+ },
+ ],
+ "requireSsl": True or False, # Whether SSL connections over IP should be enforced or not.
+ },
+ "availabilityType": "A String", # Availability type (PostgreSQL and MySQL instances only). Potential values:
+ # <br><code>ZONAL</code>: The instance serves data from only one zone.
+ # Outages in that zone affect data accessibility. <br><code>REGIONAL</code>:
+ # The instance can serve data from more than one zone in a region (it is
+ # highly available). <br>For more information, see <a
+ # href="https://cloud.google.com/sql/docs/postgres/high-availability">Overview
+ # of the High Availability Configuration</a>.
+ "settingsVersion": "A String", # The version of instance settings. This is a required field for update
+ # method to make sure concurrent updates are handled properly. During update,
+ # use the most recent settingsVersion value for this instance and do not try
+ # to update this value.
+ "databaseFlags": [ # The database flags passed to the instance at startup.
+ { # Database flags for Cloud SQL instances.
+ "value": "A String", # The value of the flag. Booleans should be set to <code>on</code> for true
+ # and <code>off</code> for false. This field must be omitted if the flag
+ # doesn't take a value.
+ "name": "A String", # The name of the flag. These flags are passed at instance startup, so
+ # include both server options and system variables for MySQL. Flags should be
+ # specified with underscores, not hyphens. For more information, see <a
+ # href="/sql/docs/mysql/flags">Configuring Database Flags</a> in the Cloud
+ # SQL documentation.
+ },
+ ],
+ "maintenanceWindow": { # Maintenance window. This specifies when a v2 Cloud SQL instance should # The maintenance window for this instance. This specifies when the instance
+ # can be restarted for maintenance purposes. Not used for First Generation
+ # instances.
+ # preferably be restarted for system maintenance purposes.
+ "updateTrack": "A String", # Maintenance timing setting: <code>canary</code> (Earlier) or
+ # <code>stable</code> (Later). <br /><a
+ # href="/sql/docs/db_path/instance-settings#maintenance-timing-2ndgen">
+ # Learn more</a>.
+ "hour": 42, # hour of day - 0 to 23.
+ "day": 42, # day of week (1-7), starting on Monday.
+ "kind": "A String", # This is always <code>sql#maintenanceWindow</code>.
+ },
+ "pricingPlan": "A String", # The pricing plan for this instance. This can be either <code>PER_USE</code>
+ # or <code>PACKAGE</code>. Only <code>PER_USE</code> is supported for Second
+ # Generation instances.
+ "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is
+ # true. Not used for First Generation instances.
+ "storageAutoResizeLimit": "A String", # The maximum size to which storage capacity can be automatically increased.
+ # The default value is 0, which specifies that there is no limit. Not used
+ # for First Generation instances.
+ "authorizedGaeApplications": [ # The App Engine app IDs that can access this instance. First Generation
+ # instances only.
+ "A String",
+ ],
+ "tier": "A String", # The tier (or machine type) for this instance, for example
+ # <code>db-n1-standard-1</code> (MySQL instances) or
+ # <code>db-custom-1-3840</code> (PostgreSQL instances). For MySQL instances,
+ # this property determines whether the instance is First or Second
+ # Generation. For more information, see <a
+ # href="/sql/docs/db_path/instance-settings">Instance Settings</a>.
+ "dataDiskSizeGb": "A String", # The size of data disk, in GB. The data disk size minimum is 10GB. Not used
+ # for First Generation instances.
+ "dataDiskType": "A String", # The type of data disk: <code>PD_SSD</code> (default) or
+ # <code>PD_HDD</code>. Not used for First Generation instances.
+ "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether
+ # replication is enabled or not.
+ "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether
+ # database flags for crash-safe replication are enabled. This property is
+ # only applicable to First Generation instances.
+ "backupConfiguration": { # Database instance backup configuration. # The daily backup configuration for the instance.
+ "pointInTimeRecoveryEnabled": True or False, # Reserved for future use.
+ "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24
+ # hour format - <code>HH:MM</code>.
+ "kind": "A String", # This is always <code>sql#backupConfiguration</code>.
+ "enabled": True or False, # Whether this configuration is enabled.
+ "binaryLogEnabled": True or False, # (MySQL only) Whether binary log is enabled. If backup configuration is
+ # disabled, binarylog must be disabled as well.
+ "replicationLogArchivingEnabled": True or False, # Reserved for future use.
+ "location": "A String", # Location of the backup
+ },
+ "userLabels": { # User-provided labels, represented as a dictionary where each label is a
+ # single key value pair.
+ "a_key": "A String",
+ },
+ "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance should # The location preference settings. This allows the instance to be located as
+ # near as possible to either an App Engine app or Compute Engine zone for
+ # better performance. App Engine co-location is only applicable to First
+ # Generation instances.
+ # preferably be located, either in a specific Compute Engine zone, or
+ # co-located with an App Engine application. Note that if the preferred
+ # location is not available, the instance will be located as close as possible
+ # within the region. Only one location may be specified.
+ "followGaeApplication": "A String", # The AppEngine application to follow, it must be in the same region as the
+ # Cloud SQL instance.
+ "kind": "A String", # This is always <code>sql#locationPreference</code>.
+ "zone": "A String", # The preferred Compute Engine zone (e.g. us-central1-a, us-central1-b,
+ # etc.).
+ },
+ "kind": "A String", # This is always <code>sql#settings</code>.
+ "replicationType": "A String", # The type of replication this instance uses. This can be either
+ # <code>ASYNCHRONOUS</code> or <code>SYNCHRONOUS</code>. This property is
+ # only applicable to First Generation instances.
+ "activationPolicy": "A String", # The activation policy specifies when the instance is activated; it is
+ # applicable only when the instance state is <code>RUNNABLE</code>. Valid
+ # values: <br><code>ALWAYS</code>: The instance is on, and remains so even in
+ # the absence of connection requests. <br><code>NEVER</code>: The instance is
+ # off; it is not activated, even if a connection request arrives.
+ # <br><code>ON_DEMAND</code>: First Generation instances only. The instance
+ # responds to incoming requests, and turns itself off when not in use.
+ # Instances with <code>PER_USE</code> pricing turn off after 15 minutes of
+ # inactivity. Instances with <code>PER_PACKAGE</code> pricing turn off after
+ # 12 hours of inactivity.
+ },
+ "replicaNames": [ # The replicas of the instance.
+ "A String",
+ ],
+ "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance.
+ # Applies only to Second Generation instances.
+ "kind": "A String", # This is always <code>sql#diskEncryptionConfiguration</code>.
+ "kmsKeyName": "A String", # Resource name of KMS key for disk encryption
+ },
+ "rootPassword": "A String", # Initial root password. Use only on creation.
+ "scheduledMaintenance": { # Any scheduled maintenancce for this instance. # The start time of any upcoming scheduled maintenance for this instance.
+ "canReschedule": True or False, # If the scheduled maintenance can be rescheduled.
+ "canDefer": True or False,
+ "startTime": "A String", # The start time of any upcoming scheduled maintenance for this instance.
+ },
+ "etag": "A String", # This field is deprecated and will be removed from a future version of the
+ # API. Use the <code>settings.settingsVersion</code> field instead.
+ "serverCaCert": { # SslCerts Resource # SSL configuration.
+ "selfLink": "A String", # The URI of this resource.
+ "expirationTime": "A String", # The time when the certificate expires in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "sha1Fingerprint": "A String", # Sha1 Fingerprint.
+ "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
+ "cert": "A String", # PEM representation.
+ "kind": "A String", # This is always <code>sql#sslCert</code>.
+ "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
+ "createTime": "A String", # The time when the certificate was created in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>
+ "instance": "A String", # Name of the database instance.
+ },
+ "maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
+ "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
+ "masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup.
+ "instanceType": "A String", # The instance type. This can be one of the following.
+ # <br><code>CLOUD_SQL_INSTANCE</code>: A Cloud SQL instance that is not
+ # replicating from a master. <br><code>ON_PREMISES_INSTANCE</code>: An
+ # instance running on the
+ # customer's premises. <br><code>READ_REPLICA_INSTANCE</code>: A Cloud SQL
+ # instance configured as a read-replica.
+ "gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This
+ # value could be different from the zone that was specified when the instance
+ # was created if the instance has failed over to its secondary zone.
+ "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been
+ # deprecated. Users should use the
+ # "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud
+ # Monitoring API instead. Please see <a
+ # href="https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ">this
+ # announcement</a> for details.
+ "replicaConfiguration": { # Read-replica configuration for connecting to the master. # Configuration specific to failover replicas and read replicas.
+ "kind": "A String", # This is always <code>sql#replicaConfiguration</code>.
+ "mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # 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 <code>master.info</code>
+ # in the data directory.
+ "kind": "A String", # This is always <code>sql#mysqlReplicaConfiguration</code>.
+ "password": "A String", # The password for the replication connection.
+ "verifyServerCertificate": True or False, # Whether or not to check the master's Common Name value in the certificate
+ # that it sends during the SSL handshake.
+ "clientKey": "A String", # PEM representation of the slave's private key. The corresponsing public key
+ # is encoded in the client's certificate.
+ "sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption.
+ "masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats.
+ "connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds.
+ "dumpFilePath": "A String", # Path to a SQL dump file in Google Cloud Storage from which the slave
+ # instance is to be created. The URI is in the form gs:
+ # //bucketName/fileName. Compressed gzip files (.gz) are also supported.
+ # // Dumps should have the binlog co-ordinates from which replication should
+ # // begin. This can be accomplished by setting --master-data to 1 when using
+ # // mysqldump.
+ "clientCertificate": "A String", # PEM representation of the slave's x509 certificate.
+ "username": "A String", # The username for the replication connection.
+ "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
+ },
+ "failoverTarget": True or False, # Specifies if the replica is the failover target. If the field is set to
+ # <code>true</code> 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. <p>Only one replica can be specified as failover
+ # target, and the replica has to be in different zone with the master
+ # instance.
+ },
+ "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.
+ "failoverReplica": { # The name and status of the failover replica. This property is applicable
+ # only to Second Generation instances.
+ "available": True or False, # The availability status of the failover replica. A false status indicates
+ # that the failover replica is out of sync. The master can only failover to
+ # the failover replica when the status is true.
+ "name": "A String", # The name of the failover replica. If specified at instance creation, a
+ # failover replica is created for the instance. The name
+ # doesn't include the project ID. This property is applicable only to
+ # Second Generation instances.
+ },
+ "ipAddresses": [ # The assigned IP addresses for the instance.
+ { # Database instance IP Mapping.
+ "timeToRetire": "A String", # The due time for this IP to be retired in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>. This field is only available when
+ # the IP is scheduled to be retired.
+ "type": "A String", # The type of this IP address. A <code>PRIMARY</code> address is a public
+ # address that can accept incoming connections. A <code>PRIVATE</code>
+ # address is a private address that can accept incoming connections. An
+ # <code>OUTGOING</code> address is the source address of connections
+ # originating from the instance, if supported.
+ "ipAddress": "A String", # The IP address assigned.
+ },
+ ],
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Operation resource.&nbsp;For successful operations that return an
+ # Operation resource, only the fields relevant to the operation are populated
+ # in the resource.
+ "user": "A String", # The email address of the user who initiated this operation.
+ "targetProject": "A String", # The project ID of the target instance related to this operation.
+ "selfLink": "A String", # The URI of this resource.
+ "targetLink": "A String",
+ "operationType": "A String", # The type of the operation. Valid values are <code>CREATE</code>,
+ # <code>DELETE</code>, <code>UPDATE</code>, <code>RESTART</code>,
+ # <code>IMPORT</code>, <code>EXPORT</code>, <code>BACKUP_VOLUME</code>,
+ # <code>RESTORE_VOLUME</code>, <code>CREATE_USER</code>,
+ # <code>DELETE_USER</code>, <code>CREATE_DATABASE</code>,
+ # <code>DELETE_DATABASE</code> .
+ "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be
+ # populated.
+ "errors": [ # The list of errors encountered while processing this operation.
+ { # Database instance operation error.
+ "code": "A String", # Identifies the specific error that occurred.
+ "message": "A String", # Additional information about the error encountered.
+ "kind": "A String", # This is always <code>sql#operationError</code>.
+ },
+ ],
+ "kind": "A String", # This is always <code>sql#operationErrors</code>.
+ },
+ "kind": "A String", # This is always <code>sql#operation</code>.
+ "importContext": { # Database instance import context. # The context for import operation, if applicable.
+ "csvImportOptions": { # Options for importing data as CSV.
+ "columns": [ # The columns to which CSV data is imported. If not specified, all columns
+ # of the database table are loaded with CSV data.
+ "A String",
+ ],
+ "table": "A String", # The table to which CSV data is imported.
+ },
+ "kind": "A String", # This is always <code>sql#importContext</code>.
+ "database": "A String", # The target database for the import. If <code>fileType</code> is
+ # <code>SQL</code>, this field is required only if the import file does not
+ # specify a database, and is overridden by any database specification in the
+ # import file. If <code>fileType</code> is <code>CSV</code>, one database
+ # must be specified.
+ "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
+ "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
+ "encryptionOptions": {
+ "pvkPassword": "A String", # Password that encrypts the private key
+ "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form
+ # <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the
+ # form <code>gs://bucketName/fileName</code>. The instance must have
+ # write permissions to the bucket and read access to the file.
+ },
+ },
+ "uri": "A String", # Path to the import file in Cloud Storage, in the form
+ # <code>gs:
+ # //bucketName/fileName</code>. Compressed gzip files (.gz) are supported
+ # // when <code>fileType</code> is <code>SQL</code>. The instance must have
+ # // write permissions to the bucket and read access to the file.
+ "fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ },
+ "status": "A String", # The status of an operation. Valid values are <code>PENDING</code>,
+ # <code>RUNNING</code>, <code>DONE</code>,
+ # <code>SQL_OPERATION_STATUS_UNSPECIFIED</code>.
+ "name": "A String", # An identifier that uniquely identifies the operation. You can use this
+ # identifier to retrieve the Operations resource that has information about
+ # the operation.
+ "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+ "databases": [ # Databases to be exported. <br /> <b>MySQL instances:</b> If
+ # <code>fileType</code> is <code>SQL</code> and no database is specified, all
+ # databases are exported, except for the <code>mysql</code> system database.
+ # If <code>fileType</code> is <code>CSV</code>, you can specify one database,
+ # either by using this property or by using the
+ # <code>csvExportOptions.selectQuery</code> property, which takes precedence
+ # over this property. <br /> <b>PostgreSQL instances:</b> You must specify
+ # one database to be exported. If <code>fileType</code> is <code>CSV</code>,
+ # this database must match the one specified in the
+ # <code>csvExportOptions.selectQuery</code> property.
+ "A String",
+ ],
+ "sqlExportOptions": { # Options for exporting data as SQL statements.
+ "tables": [ # Tables to export, or that were exported, from the specified database. If
+ # you specify tables, specify one and only one database. For PostgreSQL
+ # instances, you can specify only one table.
+ "A String",
+ ],
+ "schemaOnly": True or False, # Export only schemas.
+ "mysqlExportOptions": { # Options for exporting from MySQL.
+ "masterData": 42, # Option to include SQL statement required to set up replication.
+ # If set to <code>1</code>, the dump file includes
+ # a CHANGE MASTER TO statement with the binary log coordinates.
+ # If set to <code>2</code>, the CHANGE MASTER TO statement is written as
+ # a SQL comment, and has no effect.
+ # All other values are ignored.
+ },
+ },
+ "fileType": "A String", # The file type for the specified uri. <br><code>SQL</code>: The file
+ # contains SQL statements. <br><code>CSV</code>: The file contains CSV data.
+ "uri": "A String", # The path to the file in Google Cloud Storage where the export will be
+ # stored. The URI is in the form <code>gs:
+ # //bucketName/fileName</code>. If the file already exists, the requests
+ # // succeeds, but the operation fails. If <code>fileType</code> is
+ # // <code>SQL</code> and the filename ends with .gz, the contents are
+ # // compressed.
+ "csvExportOptions": { # Options for exporting data as CSV.
+ "selectQuery": "A String", # The select query used to extract the data.
+ },
+ "kind": "A String", # This is always <code>sql#exportContext</code>.
+ },
+ "targetId": "A String", # Name of the database instance related to this operation.
+ "endTime": "A String", # The time this operation finished in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "startTime": "A String", # The time this operation actually started in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ "insertTime": "A String", # The time this operation was enqueued in UTC timezone in <a
+ # href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example
+ # <code>2012-11-15T16:19:00.094Z</code>.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file