Cloud SQL Administration API . backupRuns

Instance Methods

get(project, instance, id)

Retrieves a resource containing information about a backup run.

list(project, instance, maxResults=None, pageToken=None)

Lists all backup runs associated with a given instance and configuration in the reverse chronological order of the enqueued time.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(project, instance, id)
Retrieves a resource containing information about a backup run.

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)
  id: string, The ID of this Backup Run. (required)

Returns:
  An object of the form:

    { # A database instance backup run resource.
    "status": "A String", # The status of this run.
    "kind": "sql#backupRun", # This is always sql#backupRun.
    "windowStartTime": "A String", # The start time of the backup window during which this the backup was attempted in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "enqueuedTime": "A String", # The time the run was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "instance": "A String", # Name of the database instance.
    "startTime": "A String", # The time the backup operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "error": { # Database instance operation error. # Information about why the backup operation failed. This is only present if the run has the FAILED status.
      "kind": "sql#operationError", # This is always sql#operationError.
      "code": "A String", # Identifies the specific error that occurred.
      "message": "A String", # Additional information about the error encountered.
    },
    "endTime": "A String", # The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
    "id": "A String", # A unique identifier for this backup run. Note that this is unique only within the scope of a particular Cloud SQL instance.
    "selfLink": "A String", # The URI of this resource.
  }
list(project, instance, maxResults=None, pageToken=None)
Lists all backup runs associated with a given instance and configuration in the reverse chronological order of the enqueued 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. (required)
  maxResults: integer, Maximum number of backup runs per response.
  pageToken: string, A previously-returned page token representing part of the larger set of results to view.

Returns:
  An object of the form:

    { # Backup run list results.
    "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.
    "items": [ # A list of backup runs in reverse chronological order of the enqueued time.
      { # A database instance backup run resource.
        "status": "A String", # The status of this run.
        "kind": "sql#backupRun", # This is always sql#backupRun.
        "windowStartTime": "A String", # The start time of the backup window during which this the backup was attempted in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
        "enqueuedTime": "A String", # The time the run was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
        "instance": "A String", # Name of the database instance.
        "startTime": "A String", # The time the backup operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
        "error": { # Database instance operation error. # Information about why the backup operation failed. This is only present if the run has the FAILED status.
          "kind": "sql#operationError", # This is always sql#operationError.
          "code": "A String", # Identifies the specific error that occurred.
          "message": "A String", # Additional information about the error encountered.
        },
        "endTime": "A String", # The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
        "id": "A String", # A unique identifier for this backup run. Note that this is unique only within the scope of a particular Cloud SQL instance.
        "selfLink": "A String", # The URI of this resource.
      },
    ],
    "kind": "sql#backupRunsList", # This is always sql#backupRunsList.
  }
list_next(previous_request, previous_response)
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.