Google Cloud Memorystore for Redis API . projects . locations . backupCollections

Instance Methods

backups()

Returns the backups Resource.

close()

Close httplib2 connections.

get(name, x__xgafv=None)

Get a backup collection.

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists all backup collections owned by a consumer project in either the specified location (region) or all locations. If `location_id` is specified as `-` (wildcard), then all regions available to the project are queried, and the results are aggregated.

list_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
get(name, x__xgafv=None)
Get a backup collection.

Args:
  name: string, Required. Redis backupCollection resource name using the form: `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}` where `location_id` refers to a GCP region. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # BackupCollection of a cluster.
  "cluster": "A String", # Output only. The full resource path of the cluster the backup collection belongs to. Example: projects/{project}/locations/{location}/clusters/{cluster}
  "clusterUid": "A String", # Output only. The cluster uid of the backup collection.
  "name": "A String", # Identifier. Full resource path of the backup collection.
  "uid": "A String", # Output only. System assigned unique identifier of the backup collection.
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists all backup collections owned by a consumer project in either the specified location (region) or all locations. If `location_id` is specified as `-` (wildcard), then all regions available to the project are queried, and the results are aggregated.

Args:
  parent: string, Required. The resource name of the backupCollection location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region. (required)
  pageSize: integer, Optional. The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's `next_page_token` to determine if there are more clusters left to be queried.
  pageToken: string, Optional. The `next_page_token` value returned from a previous [ListBackupCollections] request, if any.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for [ListBackupCollections].
  "backupCollections": [ # A list of backupCollections in the project. If the `location_id` in the parent field of the request is "-", all regions available to the project are queried, and the results aggregated. If in such an aggregated query a location is unavailable, a placeholder backupCollection entry is included in the response with the `name` field set to a value of the form `projects/{project_id}/locations/{location_id}/backupCollections/`- and the `status` field set to ERROR and `status_message` field set to "location not available for ListBackupCollections".
    { # BackupCollection of a cluster.
      "cluster": "A String", # Output only. The full resource path of the cluster the backup collection belongs to. Example: projects/{project}/locations/{location}/clusters/{cluster}
      "clusterUid": "A String", # Output only. The cluster uid of the backup collection.
      "name": "A String", # Identifier. Full resource path of the backup collection.
      "uid": "A String", # Output only. System assigned unique identifier of the backup collection.
    },
  ],
  "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
  "unreachable": [ # Locations that could not be reached.
    "A String",
  ],
}
list_next()
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.