Cloud SQL Admin API . projects . instances

Instance Methods

close()

Close httplib2 connections.

rescheduleMaintenance(project, instance, body=None, x__xgafv=None)

Reschedules the maintenance on the given instance.

startExternalSync(project, instance, syncMode=None, x__xgafv=None)

Start External primary instance migration.

verifyExternalSyncSettings(project, instance, syncMode=None, verifyConnectionOnly=None, x__xgafv=None)

Verify External primary instance external sync settings.

Method Details

close()
Close httplib2 connections.
rescheduleMaintenance(project, instance, body=None, x__xgafv=None)
Reschedules the maintenance on the given instance.

Args:
  project: string, 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:

{ # Reschedule options for maintenance windows.
    "reschedule": { # Required. The type of the reschedule the user wants.
      "rescheduleType": "A String", # Required. The type of the reschedule.
      "scheduleTime": "A String", # Optional. Timestamp when the maintenance shall be rescheduled to if reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
    },
  }

  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.
    "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
    "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
      "kind": "A String", # This is always *sql#operationErrors*.
      "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 *sql#operationError*.
        },
      ],
    },
    "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
    "targetLink": "A String",
    "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.
      "offload": True or False, # Option for export offload.
      "csvExportOptions": { # Options for exporting data as CSV.
        "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.
        "A String",
      ],
      "kind": "A String", # This is always *sql#exportContext*.
      "sqlExportOptions": { # Options for exporting data as SQL statements.
        "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",
        ],
        "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. If set to *2*, 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. *SQL*: The file contains SQL statements. *CSV*: 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 *gs: //bucketName/fileName*. If the file already exists, the requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
    },
    "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*
    "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
    "selfLink": "A String", # The URI of this resource.
    "kind": "A String", # This is always *sql#operation*.
    "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
    "targetProject": "A String", # The project ID of the target instance related to this operation.
    "importContext": { # Database instance import context. # The context for import operation, if applicable.
      "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.
      "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
      "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.
      },
      "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.
      "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
      "kind": "A String", # This is always *sql#importContext*.
      "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.
        },
      },
    },
    "user": "A String", # The email address of the user who initiated this operation.
    "targetId": "A String", # Name of the database instance related to this operation.
  }
startExternalSync(project, instance, syncMode=None, x__xgafv=None)
Start External primary instance migration.

Args:
  project: string, ID of the project that contains the instance. (required)
  instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
  syncMode: string, External sync mode
    Allowed values
      EXTERNAL_SYNC_MODE_UNSPECIFIED - Unknown external sync mode, will be defaulted to ONLINE mode
      ONLINE - Online external sync will set up replication after initial data external sync
      OFFLINE - Offline external sync only dumps and loads a one-time snapshot of the primary instance's 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. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
    "status": "A String", # The status of an operation. Valid values are: *PENDING* *RUNNING* *DONE* *SQL_OPERATION_STATUS_UNSPECIFIED*
    "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
      "kind": "A String", # This is always *sql#operationErrors*.
      "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 *sql#operationError*.
        },
      ],
    },
    "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
    "targetLink": "A String",
    "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.
      "offload": True or False, # Option for export offload.
      "csvExportOptions": { # Options for exporting data as CSV.
        "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.
        "A String",
      ],
      "kind": "A String", # This is always *sql#exportContext*.
      "sqlExportOptions": { # Options for exporting data as SQL statements.
        "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",
        ],
        "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. If set to *2*, 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. *SQL*: The file contains SQL statements. *CSV*: 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 *gs: //bucketName/fileName*. If the file already exists, the requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.
    },
    "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*
    "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
    "selfLink": "A String", # The URI of this resource.
    "kind": "A String", # This is always *sql#operation*.
    "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.
    "targetProject": "A String", # The project ID of the target instance related to this operation.
    "importContext": { # Database instance import context. # The context for import operation, if applicable.
      "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.
      "fileType": "A String", # The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.
      "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.
      },
      "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.
      "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
      "kind": "A String", # This is always *sql#importContext*.
      "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.
        },
      },
    },
    "user": "A String", # The email address of the user who initiated this operation.
    "targetId": "A String", # Name of the database instance related to this operation.
  }
verifyExternalSyncSettings(project, instance, syncMode=None, verifyConnectionOnly=None, x__xgafv=None)
Verify External primary instance external sync settings.

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)
  syncMode: string, External sync mode
    Allowed values
      EXTERNAL_SYNC_MODE_UNSPECIFIED - Unknown external sync mode, will be defaulted to ONLINE mode
      ONLINE - Online external sync will set up replication after initial data external sync
      OFFLINE - Offline external sync only dumps and loads a one-time snapshot of the primary instance's data
  verifyConnectionOnly: boolean, Flag to enable verifying connection only
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Instance verify external sync settings response.
    "errors": [ # List of migration violations.
      { # External primary instance migration setting error.
        "kind": "A String", # This is always *sql#migrationSettingError*.
        "type": "A String", # Identifies the specific error that occurred.
        "detail": "A String", # Additional information about the error encountered.
      },
    ],
    "kind": "A String", # This is always *sql#migrationSettingErrorList*.
  }