Cloud Firestore API . projects . locations . backups

close()

Close httplib2 connections.

delete(name, x__xgafv=None)

Deletes a backup.

Args:
  name: string, Required. Name of the backup to delete. format is `projects/{project}/locations/{location}/backups/{backup}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

get(name, x__xgafv=None)

Gets information about a backup.

Args:
  name: string, Required. Name of the backup to fetch. Format is `projects/{project}/locations/{location}/backups/{backup}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A Backup of a Cloud Firestore Database. The backup contains all documents and index configurations for the given database at a specific point in time.
  "database": "A String", # Output only. Name of the Firestore database that the backup is from. Format is `projects/{project}/databases/{database}`.
  "databaseUid": "A String", # Output only. The system-generated UUID4 for the Firestore database that the backup is from.
  "expireTime": "A String", # Output only. The timestamp at which this backup expires.
  "name": "A String", # Output only. The unique resource name of the Backup. Format is `projects/{project}/locations/{location}/backups/{backup}`.
  "snapshotTime": "A String", # Output only. The backup contains an externally consistent copy of the database at this time.
  "state": "A String", # Output only. The current state of the backup.
  "stats": { # Backup specific statistics. # Output only. Statistics about the backup. This data only becomes available after the backup is fully materialized to secondary storage. This field will be empty till then.
    "documentCount": "A String", # Output only. The total number of documents contained in the backup.
    "indexCount": "A String", # Output only. The total number of index entries contained in the backup.
    "sizeBytes": "A String", # Output only. Summation of the size of all documents and index entries in the backup, measured in bytes.
  },
}

list(parent, filter=None, x__xgafv=None)

Lists all the backups.

Args:
  parent: string, Required. The location to list backups from. Format is `projects/{project}/locations/{location}`. Use `{location} = '-'` to list backups from all locations for the given project. This allows listing backups from a single location or from all locations. (required)
  filter: string, An expression that filters the list of returned backups. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the Backup are eligible for filtering: * `database_uid` (supports `=` only)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response for FirestoreAdmin.ListBackups.
  "backups": [ # List of all backups for the project.
    { # A Backup of a Cloud Firestore Database. The backup contains all documents and index configurations for the given database at a specific point in time.
      "database": "A String", # Output only. Name of the Firestore database that the backup is from. Format is `projects/{project}/databases/{database}`.
      "databaseUid": "A String", # Output only. The system-generated UUID4 for the Firestore database that the backup is from.
      "expireTime": "A String", # Output only. The timestamp at which this backup expires.
      "name": "A String", # Output only. The unique resource name of the Backup. Format is `projects/{project}/locations/{location}/backups/{backup}`.
      "snapshotTime": "A String", # Output only. The backup contains an externally consistent copy of the database at this time.
      "state": "A String", # Output only. The current state of the backup.
      "stats": { # Backup specific statistics. # Output only. Statistics about the backup. This data only becomes available after the backup is fully materialized to secondary storage. This field will be empty till then.
        "documentCount": "A String", # Output only. The total number of documents contained in the backup.
        "indexCount": "A String", # Output only. The total number of index entries contained in the backup.
        "sizeBytes": "A String", # Output only. Summation of the size of all documents and index entries in the backup, measured in bytes.
      },
    },
  ],
  "unreachable": [ # List of locations that existing backups were not able to be fetched from. Instead of failing the entire requests when a single location is unreachable, this response returns a partial result set and list of locations unable to be reached here. The request can be retried against a single location to get a concrete error.
    "A String",
  ],
}