- Resource: Operation
- SqlOperationStatus
- OperationErrors
- SqlOperationType
- ImportContext
- SqlFileType
- ExportContext
- BackupContext
- Methods
Resource: Operation
An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
JSON representation |
---|
{ "kind": string, "targetLink": string, "status": enum ( |
Fields | |
---|---|
kind |
This is always |
targetLink |
|
status |
The status of an operation. |
user |
The email address of the user who initiated this operation. |
insertTime |
The time this operation was enqueued in UTC timezone in RFC 3339 format, for example A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
startTime |
The time this operation actually started in UTC timezone in RFC 3339 format, for example A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
endTime |
The time this operation finished in UTC timezone in RFC 3339 format, for example A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
error |
If errors occurred during processing of this operation, this field will be populated. |
operationType |
The type of the operation. Valid values are: * |
importContext |
The context for import operation, if applicable. |
exportContext |
The context for export operation, if applicable. |
backupContext |
The context for backup operation, if applicable. |
name |
An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. |
targetId |
Name of the database instance related to this operation. |
selfLink |
The URI of this resource. |
targetProject |
The project ID of the target instance related to this operation. |
SqlOperationStatus
The status of an operation.
Enums | |
---|---|
SQL_OPERATION_STATUS_UNSPECIFIED |
The state of the operation is unknown. |
PENDING |
The operation has been queued, but has not started yet. |
RUNNING |
The operation is running. |
DONE |
The operation completed. |
OperationErrors
Database instance operation errors list wrapper.
JSON representation |
---|
{
"kind": string,
"errors": [
{
object ( |
Fields | |
---|---|
kind |
This is always |
errors[] |
The list of errors encountered while processing this operation. |
SqlOperationType
The type of Cloud SQL operation.
Enums | |
---|---|
SQL_OPERATION_TYPE_UNSPECIFIED |
Unknown operation type. |
IMPORT |
Imports data into a Cloud SQL instance. |
EXPORT |
Exports data from a Cloud SQL instance to a Cloud Storage bucket. |
CREATE |
Creates a new Cloud SQL instance. |
UPDATE |
Updates the settings of a Cloud SQL instance. |
DELETE |
Deletes a Cloud SQL instance. |
RESTART |
Restarts the Cloud SQL instance. |
BACKUP |
|
SNAPSHOT |
|
BACKUP_VOLUME |
Performs instance backup. |
DELETE_VOLUME |
Deletes an instance backup. |
RESTORE_VOLUME |
Restores an instance backup. |
INJECT_USER |
Injects a privileged user in mysql for MOB instances. |
CLONE |
Clones a Cloud SQL instance. |
STOP_REPLICA |
Stops replication on a Cloud SQL read replica instance. |
START_REPLICA |
Starts replication on a Cloud SQL read replica instance. |
PROMOTE_REPLICA |
Promotes a Cloud SQL replica instance. |
CREATE_REPLICA |
Creates a Cloud SQL replica instance. |
CREATE_USER |
Creates a new user in a Cloud SQL instance. |
DELETE_USER |
Deletes a user from a Cloud SQL instance. |
UPDATE_USER |
Updates an existing user in a Cloud SQL instance. |
CREATE_DATABASE |
Creates a database in the Cloud SQL instance. |
DELETE_DATABASE |
Deletes a database in the Cloud SQL instance. |
UPDATE_DATABASE |
Updates a database in the Cloud SQL instance. |
FAILOVER |
Performs failover of an HA-enabled Cloud SQL failover replica. |
DELETE_BACKUP |
Deletes the backup taken by a backup run. |
RECREATE_REPLICA |
|
TRUNCATE_LOG |
Truncates a general or slow log table in MySQL. |
DEMOTE_MASTER |
Demotes the stand-alone instance to be a Cloud SQL read replica for an external database server. |
MAINTENANCE |
Indicates that the instance is currently in maintenance. Maintenance typically causes the instance to be unavailable for 1-3 minutes. |
ENABLE_PRIVATE_IP |
This field is deprecated, and will be removed in future version of API. |
DEFER_MAINTENANCE |
|
CREATE_CLONE |
Creates clone instance. |
RESCHEDULE_MAINTENANCE |
Reschedule maintenance to another time. |
START_EXTERNAL_SYNC |
Starts external sync of a Cloud SQL EM replica to an external primary instance. |
LOG_CLEANUP |
Recovers logs from an instance's old data disk. |
AUTO_RESTART |
Performs auto-restart of an HA-enabled Cloud SQL database for auto recovery. |
SWITCHOVER |
Switches the roles of the primary and replica pair. The target instance should be the replica. |
RECONFIGURE_OLD_PRIMARY |
Reconfigures old primary after a promote replica operation. Effect of a promote operation to the old primary is executed in this operation, asynchronously from the promote replica operation executed to the replica. |
CLUSTER_MAINTENANCE |
Indicates that the instance, its read replicas, and its cascading replicas are in maintenance. Maintenance typically gets initiated on groups of replicas first, followed by the primary instance. For each instance, maintenance typically causes the instance to be unavailable for 1-3 minutes. |
SELF_SERVICE_MAINTENANCE |
Indicates that the instance (and any of its replicas) are currently in maintenance. This is initiated as a self-service request by using SSM. Maintenance typically causes the instance to be unavailable for 1-3 minutes. |
SWITCHOVER_TO_REPLICA |
Switches a primary instance to a replica. This operation runs as part of a switchover operation to the original primary instance. |
ImportContext
Database instance import context.
JSON representation |
---|
{
"uri": string,
"database": string,
"kind": string,
"fileType": enum ( |
Fields | |
---|---|
uri |
Path to the import file in Cloud Storage, in the form |
database |
The target database for the import. If |
kind |
This is always |
fileType |
The file type for the specified uri.`SQL |
csvImportOptions |
Options for importing data as CSV. |
csvImportOptions.table |
The table to which CSV data is imported. |
csvImportOptions.columns[] |
The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. |
csvImportOptions.escapeCharacter |
Specifies the character that should appear before a data character that needs to be escaped. |
csvImportOptions.quoteCharacter |
Specifies the quoting character to be used when a data value is quoted. |
csvImportOptions.fieldsTerminatedBy |
Specifies the character that separates columns within each row (line) of the file. |
csvImportOptions.linesTerminatedBy |
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. |
importUser |
The PostgreSQL user for this import operation. PostgreSQL instances only. |
bakImportOptions |
Import parameters specific to SQL Server .BAK files |
bakImportOptions.encryptionOptions |
|
bakImportOptions.encryptionOptions.certPath |
Path to the Certificate (.cer) in Cloud Storage, in the form |
bakImportOptions.encryptionOptions.pvkPath |
Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form |
bakImportOptions.encryptionOptions.pvkPassword |
Password that encrypts the private key |
bakImportOptions.striped |
Whether or not the backup set being restored is striped. Applies only to Cloud SQL for SQL Server. |
sqlImportOptions |
Optional. Options for importing data from SQL statements. |
sqlImportOptions.threads |
Optional. The number of threads to use for parallel import. |
sqlImportOptions.parallel |
Optional. Whether or not the import should be parallel. |
SqlFileType
Enums | |
---|---|
SQL_FILE_TYPE_UNSPECIFIED |
Unknown file type. |
SQL |
File containing SQL statements. |
CSV |
File in CSV format. |
BAK |
ExportContext
Database instance export context.
JSON representation |
---|
{
"uri": string,
"databases": [
string
],
"kind": string,
"sqlExportOptions": {
"tables": [
string
],
"schemaOnly": boolean,
"mysqlExportOptions": {
"masterData": integer
},
"threads": integer,
"parallel": boolean
},
"csvExportOptions": {
"selectQuery": string,
"escapeCharacter": string,
"quoteCharacter": string,
"fieldsTerminatedBy": string,
"linesTerminatedBy": string
},
"fileType": enum ( |
Fields | |
---|---|
uri |
The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form |
databases[] |
Databases to be exported. |
kind |
This is always |
sqlExportOptions |
Options for exporting data as SQL statements. |
sqlExportOptions.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. |
sqlExportOptions.schemaOnly |
Export only schemas. |
sqlExportOptions.mysqlExportOptions |
|
sqlExportOptions.mysqlExportOptions.masterData |
Option to include SQL statement required to set up replication. If set to |
sqlExportOptions.threads |
Optional. The number of threads to use for parallel export. |
sqlExportOptions.parallel |
Optional. Whether or not the export should be parallel. |
csvExportOptions |
Options for exporting data as CSV. |
csvExportOptions.selectQuery |
The select query used to extract the data. |
csvExportOptions.escapeCharacter |
Specifies the character that should appear before a data character that needs to be escaped. |
csvExportOptions.quoteCharacter |
Specifies the quoting character to be used when a data value is quoted. |
csvExportOptions.fieldsTerminatedBy |
Specifies the character that separates columns within each row (line) of the file. |
csvExportOptions.linesTerminatedBy |
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. |
fileType |
The file type for the specified uri. |
offload |
Option for export offload. |
bakExportOptions |
Options for exporting data as BAK files. |
bakExportOptions.striped |
Whether or not the export should be striped. |
bakExportOptions.stripeCount |
Option for specifying how many stripes to use for the export. If blank, and the value of the striped field is true, the number of stripes is automatically chosen. |
BackupContext
Backup context.
JSON representation |
---|
{ "backupId": string, "kind": string } |
Fields | |
---|---|
backupId |
The identifier of the backup. |
kind |
This is always |
Methods |
|
---|---|
|
Cancels an instance operation that has been performed on an instance. |
|
Retrieves an instance operation that has been performed on an instance. |
|
Lists all instance operations that have been performed on the given Cloud SQL instance in the reverse chronological order of the start time. |