| <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="file_v1beta1.html">Cloud Filestore API</a> . <a href="file_v1beta1.projects.html">projects</a> . <a href="file_v1beta1.projects.locations.html">locations</a> . <a href="file_v1beta1.projects.locations.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="#create">create(parent, backupId=None, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a backup.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes a backup.</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, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists all backups in a project for either a specified location or for all locations.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates the settings of a specific backup.</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="create">create(parent, backupId=None, body=None, x__xgafv=None)</code> |
| <pre>Creates a backup. |
| |
| Args: |
| parent: string, Required. The backup's project and location, in the format `projects/{project_id}/locations/{location}`. In Cloud Filestore, backup locations map to GCP regions, for example **us-west1**. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A Cloud Filestore backup. |
| "capacityGb": "A String", # Output only. Capacity of the source file share when the backup was created. |
| "createTime": "A String", # Output only. The time when the backup was created. |
| "description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected. |
| "downloadBytes": "A String", # Output only. Amount of bytes that will be downloaded if the backup is restored |
| "labels": { # Resource labels to represent user provided metadata. |
| "a_key": "A String", |
| }, |
| "name": "A String", # Output only. The resource name of the backup, in the format `projects/{project_id}/locations/{location_id}/backups/{backup_id}`. |
| "satisfiesPzs": True or False, # Output only. Reserved for future use. |
| "sourceFileShare": "A String", # Name of the file share in the source Cloud Filestore instance that the backup is created from. |
| "sourceInstance": "A String", # The resource name of the source Cloud Filestore instance, in the format `projects/{project_id}/locations/{location_id}/instances/{instance_id}`, used to create this backup. |
| "sourceInstanceTier": "A String", # Output only. The service tier of the source Cloud Filestore instance that this backup is created from. |
| "state": "A String", # Output only. The backup state. |
| "storageBytes": "A String", # Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion. |
| } |
| |
| backupId: string, Required. The ID to use for the backup. The ID must be unique within the specified project and location. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. |
| 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": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| "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 response of the operation in case of success. 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="delete">delete(name, x__xgafv=None)</code> |
| <pre>Deletes a backup. |
| |
| Args: |
| name: string, Required. The backup resource name, in the format `projects/{project_id}/locations/{location}/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: |
| |
| { # 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": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| "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 response of the operation in case of success. 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. The backup resource name, in the format `projects/{project_id}/locations/{location}/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: |
| |
| { # A Cloud Filestore backup. |
| "capacityGb": "A String", # Output only. Capacity of the source file share when the backup was created. |
| "createTime": "A String", # Output only. The time when the backup was created. |
| "description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected. |
| "downloadBytes": "A String", # Output only. Amount of bytes that will be downloaded if the backup is restored |
| "labels": { # Resource labels to represent user provided metadata. |
| "a_key": "A String", |
| }, |
| "name": "A String", # Output only. The resource name of the backup, in the format `projects/{project_id}/locations/{location_id}/backups/{backup_id}`. |
| "satisfiesPzs": True or False, # Output only. Reserved for future use. |
| "sourceFileShare": "A String", # Name of the file share in the source Cloud Filestore instance that the backup is created from. |
| "sourceInstance": "A String", # The resource name of the source Cloud Filestore instance, in the format `projects/{project_id}/locations/{location_id}/instances/{instance_id}`, used to create this backup. |
| "sourceInstanceTier": "A String", # Output only. The service tier of the source Cloud Filestore instance that this backup is created from. |
| "state": "A String", # Output only. The backup state. |
| "storageBytes": "A String", # Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Lists all backups in a project for either a specified location or for all locations. |
| |
| Args: |
| parent: string, Required. The project and location for which to retrieve backup information, in the format `projects/{project_id}/locations/{location}`. In Cloud Filestore, backup locations map to GCP regions, for example **us-west1**. To retrieve backup information for all locations, use "-" for the `{location}` value. (required) |
| filter: string, List filter. |
| orderBy: string, Sort results. Supported values are "name", "name desc" or "" (unsorted). |
| pageSize: integer, The maximum number of items to return. |
| pageToken: string, The next_page_token value to use if there are additional results to retrieve for this list request. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # ListBackupsResponse is the result of ListBackupsRequest. |
| "backups": [ # A list of backups in the project for the specified location. If the `{location}` value in the request is "-", the response contains a list of backups from all locations. If any location is unreachable, the response will only return backups in reachable locations and the "unreachable" field will be populated with a list of unreachable locations. |
| { # A Cloud Filestore backup. |
| "capacityGb": "A String", # Output only. Capacity of the source file share when the backup was created. |
| "createTime": "A String", # Output only. The time when the backup was created. |
| "description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected. |
| "downloadBytes": "A String", # Output only. Amount of bytes that will be downloaded if the backup is restored |
| "labels": { # Resource labels to represent user provided metadata. |
| "a_key": "A String", |
| }, |
| "name": "A String", # Output only. The resource name of the backup, in the format `projects/{project_id}/locations/{location_id}/backups/{backup_id}`. |
| "satisfiesPzs": True or False, # Output only. Reserved for future use. |
| "sourceFileShare": "A String", # Name of the file share in the source Cloud Filestore instance that the backup is created from. |
| "sourceInstance": "A String", # The resource name of the source Cloud Filestore instance, in the format `projects/{project_id}/locations/{location_id}/instances/{instance_id}`, used to create this backup. |
| "sourceInstanceTier": "A String", # Output only. The service tier of the source Cloud Filestore instance that this backup is created from. |
| "state": "A String", # Output only. The backup state. |
| "storageBytes": "A String", # Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion. |
| }, |
| ], |
| "nextPageToken": "A String", # The token you can use to retrieve the next page of results. Not returned if there are no more results in the list. |
| "unreachable": [ # Locations that could not be reached. |
| "A String", |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</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> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| <pre>Updates the settings of a specific backup. |
| |
| Args: |
| name: string, Output only. The resource name of the backup, in the format `projects/{project_id}/locations/{location_id}/backups/{backup_id}`. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A Cloud Filestore backup. |
| "capacityGb": "A String", # Output only. Capacity of the source file share when the backup was created. |
| "createTime": "A String", # Output only. The time when the backup was created. |
| "description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected. |
| "downloadBytes": "A String", # Output only. Amount of bytes that will be downloaded if the backup is restored |
| "labels": { # Resource labels to represent user provided metadata. |
| "a_key": "A String", |
| }, |
| "name": "A String", # Output only. The resource name of the backup, in the format `projects/{project_id}/locations/{location_id}/backups/{backup_id}`. |
| "satisfiesPzs": True or False, # Output only. Reserved for future use. |
| "sourceFileShare": "A String", # Name of the file share in the source Cloud Filestore instance that the backup is created from. |
| "sourceInstance": "A String", # The resource name of the source Cloud Filestore instance, in the format `projects/{project_id}/locations/{location_id}/instances/{instance_id}`, used to create this backup. |
| "sourceInstanceTier": "A String", # Output only. The service tier of the source Cloud Filestore instance that this backup is created from. |
| "state": "A String", # Output only. The backup state. |
| "storageBytes": "A String", # Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion. |
| } |
| |
| updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field. |
| 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": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| "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 response of the operation in case of success. 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> |
| |
| </body></html> |
