| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="redis_v1.html">Google Cloud Memorystore for Redis API</a> . <a href="redis_v1.projects.html">projects</a> . <a href="redis_v1.projects.locations.html">locations</a> . <a href="redis_v1.projects.locations.backupCollections.html">backupCollections</a> . <a href="redis_v1.projects.locations.backupCollections.backups.html">backups</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes a specific backup.</p> |
| <p class="toc_element"> |
| <code><a href="#export">export(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Exports a specific backup to a customer target Cloud Storage URI.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets the details of a specific backup.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists all backups owned by a backup collection.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, requestId=None, x__xgafv=None)</code> |
| <pre>Deletes a specific backup. |
| |
| Args: |
| name: string, Required. Redis backup resource name using the form: `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}/backups/{backup_id}` (required) |
| requestId: string, Optional. Idempotent request UUID. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a network API call. |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| }, |
| "metadata": { # { `createTime`: The time the operation was created. `endTime`: The time the operation finished running. `target`: Server-defined resource path for the target of the operation. `verb`: Name of the verb executed by the operation. `statusDetail`: Human-readable status of the operation, if any. `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. `apiVersion`: API version used to start the operation. } |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="export">export(name, body=None, x__xgafv=None)</code> |
| <pre>Exports a specific backup to a customer target Cloud Storage URI. |
| |
| Args: |
| name: string, Required. Redis backup resource name using the form: `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}/backups/{backup_id}` (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request for [ExportBackup]. |
| "gcsBucket": "A String", # Google Cloud Storage bucket, like "my-bucket". |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a network API call. |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| }, |
| "metadata": { # { `createTime`: The time the operation was created. `endTime`: The time the operation finished running. `target`: Server-defined resource path for the target of the operation. `verb`: Name of the verb executed by the operation. `statusDetail`: Human-readable status of the operation, if any. `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. `apiVersion`: API version used to start the operation. } |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Gets the details of a specific backup. |
| |
| Args: |
| name: string, Required. Redis backup resource name using the form: `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}/backups/{backup_id}` (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Backup of a cluster. |
| "backupFiles": [ # Output only. List of backup files of the backup. |
| { # Backup is consisted of multiple backup files. |
| "createTime": "A String", # Output only. The time when the backup file was created. |
| "fileName": "A String", # Output only. e.g: .rdb |
| "sizeBytes": "A String", # Output only. Size of the backup file in bytes. |
| }, |
| ], |
| "backupType": "A String", # Output only. Type of the backup. |
| "cluster": "A String", # Output only. Cluster resource path of this backup. |
| "clusterUid": "A String", # Output only. Cluster uid of this backup. |
| "createTime": "A String", # Output only. The time when the backup was created. |
| "encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. Encryption information of the backup. |
| "encryptionType": "A String", # Output only. Type of encryption. |
| "kmsKeyPrimaryState": "A String", # Output only. The state of the primary version of the KMS key perceived by the system. This field is not populated in backups. |
| "kmsKeyVersions": [ # Output only. KMS key versions that are being used to protect the data at-rest. |
| "A String", |
| ], |
| "lastUpdateTime": "A String", # Output only. The most recent time when the encryption info was updated. |
| }, |
| "engineVersion": "A String", # Output only. redis-7.2, valkey-7.5 |
| "expireTime": "A String", # Output only. The time when the backup will expire. |
| "name": "A String", # Identifier. Full resource path of the backup. the last part of the name is the backup id with the following format: [YYYYMMDDHHMMSS]_[Shorted Cluster UID] OR customer specified while backup cluster. Example: 20240515123000_1234 |
| "nodeType": "A String", # Output only. Node type of the cluster. |
| "replicaCount": 42, # Output only. Number of replicas for the cluster. |
| "shardCount": 42, # Output only. Number of shards for the cluster. |
| "state": "A String", # Output only. State of the backup. |
| "totalSizeBytes": "A String", # Output only. Total size of the backup in bytes. |
| "uid": "A String", # Output only. System assigned unique identifier of the backup. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Lists all backups owned by a backup collection. |
| |
| Args: |
| parent: string, Required. The resource name of the backupCollection using the form: `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}` (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 [ListBackups]. |
| "backups": [ # A list of backups in the project. |
| { # Backup of a cluster. |
| "backupFiles": [ # Output only. List of backup files of the backup. |
| { # Backup is consisted of multiple backup files. |
| "createTime": "A String", # Output only. The time when the backup file was created. |
| "fileName": "A String", # Output only. e.g: .rdb |
| "sizeBytes": "A String", # Output only. Size of the backup file in bytes. |
| }, |
| ], |
| "backupType": "A String", # Output only. Type of the backup. |
| "cluster": "A String", # Output only. Cluster resource path of this backup. |
| "clusterUid": "A String", # Output only. Cluster uid of this backup. |
| "createTime": "A String", # Output only. The time when the backup was created. |
| "encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. Encryption information of the backup. |
| "encryptionType": "A String", # Output only. Type of encryption. |
| "kmsKeyPrimaryState": "A String", # Output only. The state of the primary version of the KMS key perceived by the system. This field is not populated in backups. |
| "kmsKeyVersions": [ # Output only. KMS key versions that are being used to protect the data at-rest. |
| "A String", |
| ], |
| "lastUpdateTime": "A String", # Output only. The most recent time when the encryption info was updated. |
| }, |
| "engineVersion": "A String", # Output only. redis-7.2, valkey-7.5 |
| "expireTime": "A String", # Output only. The time when the backup will expire. |
| "name": "A String", # Identifier. Full resource path of the backup. the last part of the name is the backup id with the following format: [YYYYMMDDHHMMSS]_[Shorted Cluster UID] OR customer specified while backup cluster. Example: 20240515123000_1234 |
| "nodeType": "A String", # Output only. Node type of the cluster. |
| "replicaCount": 42, # Output only. Number of replicas for the cluster. |
| "shardCount": 42, # Output only. Number of shards for the cluster. |
| "state": "A String", # Output only. State of the backup. |
| "totalSizeBytes": "A String", # Output only. Total size of the backup in bytes. |
| "uid": "A String", # Output only. System assigned unique identifier of the backup. |
| }, |
| ], |
| "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list. |
| "unreachable": [ # Backups that could not be reached. |
| "A String", |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next()</code> |
| <pre>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. |
| </pre> |
| </div> |
| |
| </body></html> |
