| <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="sqladmin_v1.html">Cloud SQL Admin API</a> . <a href="sqladmin_v1.operations.html">operations</a></h1> | |
| <h2>Instance Methods</h2> | |
| <p class="toc_element"> | |
| <code><a href="#close">close()</a></code></p> | |
| <p class="firstline">Close httplib2 connections.</p> | |
| <p class="toc_element"> | |
| <code><a href="#get">get(project, operation, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Retrieves an instance operation that has been performed on an instance.</p> | |
| <p class="toc_element"> | |
| <code><a href="#list">list(project, instance=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Lists all instance operations that have been performed on the given Cloud SQL instance in the reverse chronological order of the start time.</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> | |
| <h3>Method Details</h3> | |
| <div class="method"> | |
| <code class="details" id="close">close()</code> | |
| <pre>Close httplib2 connections.</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="get">get(project, operation, x__xgafv=None)</code> | |
| <pre>Retrieves an instance operation that has been performed on an instance. | |
| Args: | |
| project: string, Project ID of the project that contains the instance. (required) | |
| operation: string, Instance operation 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. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. | |
| "backupContext": { # Backup context. # The context for backup operation, if applicable. | |
| "backupId": "A String", # The identifier of the backup. | |
| "kind": "A String", # This is always **sql#backupContext**. | |
| }, | |
| "endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. | |
| "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. | |
| "kind": "A String", # This is always **sql#operationError**. | |
| "message": "A String", # Additional information about the error encountered. | |
| }, | |
| ], | |
| "kind": "A String", # This is always **sql#operationErrors**. | |
| }, | |
| "exportContext": { # Database instance export context. # The context for export operation, if applicable. | |
| "csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only. | |
| "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. | |
| "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. | |
| "linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values. | |
| "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. | |
| "selectQuery": "A String", # The select query used to extract the data. | |
| }, | |
| "databases": [ # Databases to be exported. **MySQL instances:** If **fileType** is **SQL** and no database is specified, all databases are exported, except for the **mysql** system database. If **fileType** is **CSV**, you can specify one database, either by using this property or by using the **csvExportOptions.selectQuery** property, which takes precedence over this property. **PostgreSQL instances:** You must specify one database to be exported. If **fileType** is **CSV**, this database must match the one specified in the **csvExportOptions.selectQuery** property. **SQL Server instances:** You must specify one database to be exported, and the **fileType** must be **BAK**. | |
| "A String", | |
| ], | |
| "fileType": "A String", # The file type for the specified uri. | |
| "kind": "A String", # This is always **sql#exportContext**. | |
| "offload": True or False, # Option for export offload. | |
| "sqlExportOptions": { # Options for exporting data as SQL statements. | |
| "mysqlExportOptions": { # Options for exporting from MySQL. | |
| "masterData": 42, # Option to include SQL statement required to set up replication. If set to **1**, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to **2**, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than **1**, --set-gtid-purged is set to OFF. | |
| }, | |
| "schemaOnly": True or False, # Export only schemas. | |
| "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", | |
| ], | |
| }, | |
| "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form **gs://bucketName/fileName**. If the file already exists, the request succeeds, but the operation fails. If **fileType** is **SQL** and the filename ends with .gz, the contents are compressed. | |
| }, | |
| "importContext": { # Database instance import context. # The context for import operation, if applicable. | |
| "bakImportOptions": { # Import parameters specific to SQL Server .BAK files | |
| "encryptionOptions": { | |
| "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. | |
| "pvkPassword": "A String", # Password that encrypts the private key | |
| "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. | |
| }, | |
| }, | |
| "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", | |
| ], | |
| "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. | |
| "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. | |
| "linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values. | |
| "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. | |
| "table": "A String", # The table to which CSV data is imported. | |
| }, | |
| "database": "A String", # The target database for the import. If **fileType** is **SQL**, 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 **fileType** is **CSV**, one database must be specified. | |
| "fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data. | |
| "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. | |
| "kind": "A String", # This is always **sql#importContext**. | |
| "uri": "A String", # Path to the import file in Cloud Storage, in the form **gs://bucketName/fileName**. Compressed gzip files (.gz) are supported when **fileType** is **SQL**. The instance must have write permissions to the bucket and read access to the file. | |
| }, | |
| "insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. | |
| "kind": "A String", # This is always **sql#operation**. | |
| "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. | |
| "operationType": "A String", # The type of the operation. Valid values are: * **CREATE** * **DELETE** * **UPDATE** * **RESTART** * **IMPORT** * **EXPORT** * **BACKUP_VOLUME** * **RESTORE_VOLUME** * **CREATE_USER** * **DELETE_USER** * **CREATE_DATABASE** * **DELETE_DATABASE** | |
| "selfLink": "A String", # The URI of this resource. | |
| "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. | |
| "status": "A String", # The status of an operation. | |
| "targetId": "A String", # Name of the database instance related to this operation. | |
| "targetLink": "A String", | |
| "targetProject": "A String", # The project ID of the target instance related to this operation. | |
| "user": "A String", # The email address of the user who initiated this operation. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="list">list(project, instance=None, maxResults=None, pageToken=None, x__xgafv=None)</code> | |
| <pre>Lists all instance operations that have been performed on the given Cloud SQL instance in the reverse chronological order of the start time. | |
| 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. | |
| maxResults: integer, Maximum number of operations per response. | |
| pageToken: string, A previously-returned page token representing part of the larger set of results to view. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Operations list response. | |
| "items": [ # List of operation resources. | |
| { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. | |
| "backupContext": { # Backup context. # The context for backup operation, if applicable. | |
| "backupId": "A String", # The identifier of the backup. | |
| "kind": "A String", # This is always **sql#backupContext**. | |
| }, | |
| "endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. | |
| "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. | |
| "kind": "A String", # This is always **sql#operationError**. | |
| "message": "A String", # Additional information about the error encountered. | |
| }, | |
| ], | |
| "kind": "A String", # This is always **sql#operationErrors**. | |
| }, | |
| "exportContext": { # Database instance export context. # The context for export operation, if applicable. | |
| "csvExportOptions": { # Options for exporting data as CSV. **MySQL** and **PostgreSQL** instances only. | |
| "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. | |
| "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. | |
| "linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values. | |
| "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. | |
| "selectQuery": "A String", # The select query used to extract the data. | |
| }, | |
| "databases": [ # Databases to be exported. **MySQL instances:** If **fileType** is **SQL** and no database is specified, all databases are exported, except for the **mysql** system database. If **fileType** is **CSV**, you can specify one database, either by using this property or by using the **csvExportOptions.selectQuery** property, which takes precedence over this property. **PostgreSQL instances:** You must specify one database to be exported. If **fileType** is **CSV**, this database must match the one specified in the **csvExportOptions.selectQuery** property. **SQL Server instances:** You must specify one database to be exported, and the **fileType** must be **BAK**. | |
| "A String", | |
| ], | |
| "fileType": "A String", # The file type for the specified uri. | |
| "kind": "A String", # This is always **sql#exportContext**. | |
| "offload": True or False, # Option for export offload. | |
| "sqlExportOptions": { # Options for exporting data as SQL statements. | |
| "mysqlExportOptions": { # Options for exporting from MySQL. | |
| "masterData": 42, # Option to include SQL statement required to set up replication. If set to **1**, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to **2**, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than **1**, --set-gtid-purged is set to OFF. | |
| }, | |
| "schemaOnly": True or False, # Export only schemas. | |
| "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", | |
| ], | |
| }, | |
| "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form **gs://bucketName/fileName**. If the file already exists, the request succeeds, but the operation fails. If **fileType** is **SQL** and the filename ends with .gz, the contents are compressed. | |
| }, | |
| "importContext": { # Database instance import context. # The context for import operation, if applicable. | |
| "bakImportOptions": { # Import parameters specific to SQL Server .BAK files | |
| "encryptionOptions": { | |
| "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. | |
| "pvkPassword": "A String", # Password that encrypts the private key | |
| "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form **gs://bucketName/fileName**. The instance must have write permissions to the bucket and read access to the file. | |
| }, | |
| }, | |
| "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", | |
| ], | |
| "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped. | |
| "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file. | |
| "linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values. | |
| "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted. | |
| "table": "A String", # The table to which CSV data is imported. | |
| }, | |
| "database": "A String", # The target database for the import. If **fileType** is **SQL**, 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 **fileType** is **CSV**, one database must be specified. | |
| "fileType": "A String", # The file type for the specified uri. **SQL**: The file contains SQL statements. **CSV**: The file contains CSV data. | |
| "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only. | |
| "kind": "A String", # This is always **sql#importContext**. | |
| "uri": "A String", # Path to the import file in Cloud Storage, in the form **gs://bucketName/fileName**. Compressed gzip files (.gz) are supported when **fileType** is **SQL**. The instance must have write permissions to the bucket and read access to the file. | |
| }, | |
| "insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. | |
| "kind": "A String", # This is always **sql#operation**. | |
| "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. | |
| "operationType": "A String", # The type of the operation. Valid values are: * **CREATE** * **DELETE** * **UPDATE** * **RESTART** * **IMPORT** * **EXPORT** * **BACKUP_VOLUME** * **RESTORE_VOLUME** * **CREATE_USER** * **DELETE_USER** * **CREATE_DATABASE** * **DELETE_DATABASE** | |
| "selfLink": "A String", # The URI of this resource. | |
| "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. | |
| "status": "A String", # The status of an operation. | |
| "targetId": "A String", # Name of the database instance related to this operation. | |
| "targetLink": "A String", | |
| "targetProject": "A String", # The project ID of the target instance related to this operation. | |
| "user": "A String", # The email address of the user who initiated this operation. | |
| }, | |
| ], | |
| "kind": "A String", # This is always **sql#operationsList**. | |
| "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="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> | |
| </body></html> |