1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="file_v1.html">Cloud Filestore API</a> . <a href="file_v1.projects.html">projects</a> . <a href="file_v1.projects.locations.html">locations</a> . <a href="file_v1.projects.locations.backups.html">backups</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(parent, backupId=None, body=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Creates a backup.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Deletes a backup.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 88<p class="firstline">Gets the details of a specific backup.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Lists all backups in a project for either a specified location or for all locations.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<p class="toc_element"> 96 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Updates the settings of a specific backup.</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="close">close()</code> 101 <pre>Close httplib2 connections.</pre> 102</div> 103 104<div class="method"> 105 <code class="details" id="create">create(parent, backupId=None, body=None, x__xgafv=None)</code> 106 <pre>Creates a backup. 107 108Args: 109 parent: string, Required. The backup's project and location, in the format `projects/{project_number}/locations/{location}`. In Cloud Filestore, backup locations map to GCP regions, for example **us-west1**. (required) 110 body: object, The request body. 111 The object takes the form of: 112 113{ # A Cloud Filestore backup. 114 "capacityGb": "A String", # Output only. Capacity of the source file share when the backup was created. 115 "createTime": "A String", # Output only. The time when the backup was created. 116 "description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected. 117 "downloadBytes": "A String", # Output only. Amount of bytes that will be downloaded if the backup is restored. This may be different than storage bytes, since sequential backups of the same disk will share storage. 118 "labels": { # Resource labels to represent user provided metadata. 119 "a_key": "A String", 120 }, 121 "name": "A String", # Output only. The resource name of the backup, in the format `projects/{project_number}/locations/{location_id}/backups/{backup_id}`. 122 "satisfiesPzs": True or False, # Output only. Reserved for future use. 123 "sourceFileShare": "A String", # Name of the file share in the source Cloud Filestore instance that the backup is created from. 124 "sourceInstance": "A String", # The resource name of the source Cloud Filestore instance, in the format `projects/{project_number}/locations/{location_id}/instances/{instance_id}`, used to create this backup. 125 "sourceInstanceTier": "A String", # Output only. The service tier of the source Cloud Filestore instance that this backup is created from. 126 "state": "A String", # Output only. The backup state. 127 "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. 128} 129 130 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. Values that do not match this pattern will trigger an INVALID_ARGUMENT error. 131 x__xgafv: string, V1 error format. 132 Allowed values 133 1 - v1 error format 134 2 - v2 error format 135 136Returns: 137 An object of the form: 138 139 { # This resource represents a long-running operation that is the result of a network API call. 140 "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. 141 "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. 142 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 143 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 144 { 145 "a_key": "", # Properties of the object. Contains field @type with type URL. 146 }, 147 ], 148 "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. 149 }, 150 "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. 151 "a_key": "", # Properties of the object. Contains field @type with type URL. 152 }, 153 "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}`. 154 "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`. 155 "a_key": "", # Properties of the object. Contains field @type with type URL. 156 }, 157}</pre> 158</div> 159 160<div class="method"> 161 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 162 <pre>Deletes a backup. 163 164Args: 165 name: string, Required. The backup resource name, in the format `projects/{project_number}/locations/{location}/backups/{backup_id}` (required) 166 x__xgafv: string, V1 error format. 167 Allowed values 168 1 - v1 error format 169 2 - v2 error format 170 171Returns: 172 An object of the form: 173 174 { # This resource represents a long-running operation that is the result of a network API call. 175 "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. 176 "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. 177 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 178 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 179 { 180 "a_key": "", # Properties of the object. Contains field @type with type URL. 181 }, 182 ], 183 "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. 184 }, 185 "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. 186 "a_key": "", # Properties of the object. Contains field @type with type URL. 187 }, 188 "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}`. 189 "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`. 190 "a_key": "", # Properties of the object. Contains field @type with type URL. 191 }, 192}</pre> 193</div> 194 195<div class="method"> 196 <code class="details" id="get">get(name, x__xgafv=None)</code> 197 <pre>Gets the details of a specific backup. 198 199Args: 200 name: string, Required. The backup resource name, in the format `projects/{project_number}/locations/{location}/backups/{backup_id}`. (required) 201 x__xgafv: string, V1 error format. 202 Allowed values 203 1 - v1 error format 204 2 - v2 error format 205 206Returns: 207 An object of the form: 208 209 { # A Cloud Filestore backup. 210 "capacityGb": "A String", # Output only. Capacity of the source file share when the backup was created. 211 "createTime": "A String", # Output only. The time when the backup was created. 212 "description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected. 213 "downloadBytes": "A String", # Output only. Amount of bytes that will be downloaded if the backup is restored. This may be different than storage bytes, since sequential backups of the same disk will share storage. 214 "labels": { # Resource labels to represent user provided metadata. 215 "a_key": "A String", 216 }, 217 "name": "A String", # Output only. The resource name of the backup, in the format `projects/{project_number}/locations/{location_id}/backups/{backup_id}`. 218 "satisfiesPzs": True or False, # Output only. Reserved for future use. 219 "sourceFileShare": "A String", # Name of the file share in the source Cloud Filestore instance that the backup is created from. 220 "sourceInstance": "A String", # The resource name of the source Cloud Filestore instance, in the format `projects/{project_number}/locations/{location_id}/instances/{instance_id}`, used to create this backup. 221 "sourceInstanceTier": "A String", # Output only. The service tier of the source Cloud Filestore instance that this backup is created from. 222 "state": "A String", # Output only. The backup state. 223 "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. 224}</pre> 225</div> 226 227<div class="method"> 228 <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 229 <pre>Lists all backups in a project for either a specified location or for all locations. 230 231Args: 232 parent: string, Required. The project and location for which to retrieve backup information, in the format `projects/{project_number}/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) 233 filter: string, List filter. 234 orderBy: string, Sort results. Supported values are "name", "name desc" or "" (unsorted). 235 pageSize: integer, The maximum number of items to return. 236 pageToken: string, The next_page_token value to use if there are additional results to retrieve for this list request. 237 x__xgafv: string, V1 error format. 238 Allowed values 239 1 - v1 error format 240 2 - v2 error format 241 242Returns: 243 An object of the form: 244 245 { # ListBackupsResponse is the result of ListBackupsRequest. 246 "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. 247 { # A Cloud Filestore backup. 248 "capacityGb": "A String", # Output only. Capacity of the source file share when the backup was created. 249 "createTime": "A String", # Output only. The time when the backup was created. 250 "description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected. 251 "downloadBytes": "A String", # Output only. Amount of bytes that will be downloaded if the backup is restored. This may be different than storage bytes, since sequential backups of the same disk will share storage. 252 "labels": { # Resource labels to represent user provided metadata. 253 "a_key": "A String", 254 }, 255 "name": "A String", # Output only. The resource name of the backup, in the format `projects/{project_number}/locations/{location_id}/backups/{backup_id}`. 256 "satisfiesPzs": True or False, # Output only. Reserved for future use. 257 "sourceFileShare": "A String", # Name of the file share in the source Cloud Filestore instance that the backup is created from. 258 "sourceInstance": "A String", # The resource name of the source Cloud Filestore instance, in the format `projects/{project_number}/locations/{location_id}/instances/{instance_id}`, used to create this backup. 259 "sourceInstanceTier": "A String", # Output only. The service tier of the source Cloud Filestore instance that this backup is created from. 260 "state": "A String", # Output only. The backup state. 261 "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. 262 }, 263 ], 264 "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. 265 "unreachable": [ # Locations that could not be reached. 266 "A String", 267 ], 268}</pre> 269</div> 270 271<div class="method"> 272 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 273 <pre>Retrieves the next page of results. 274 275Args: 276 previous_request: The request for the previous page. (required) 277 previous_response: The response from the request for the previous page. (required) 278 279Returns: 280 A request object that you can call 'execute()' on to request the next 281 page. Returns None if there are no more items in the collection. 282 </pre> 283</div> 284 285<div class="method"> 286 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 287 <pre>Updates the settings of a specific backup. 288 289Args: 290 name: string, Output only. The resource name of the backup, in the format `projects/{project_number}/locations/{location_id}/backups/{backup_id}`. (required) 291 body: object, The request body. 292 The object takes the form of: 293 294{ # A Cloud Filestore backup. 295 "capacityGb": "A String", # Output only. Capacity of the source file share when the backup was created. 296 "createTime": "A String", # Output only. The time when the backup was created. 297 "description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected. 298 "downloadBytes": "A String", # Output only. Amount of bytes that will be downloaded if the backup is restored. This may be different than storage bytes, since sequential backups of the same disk will share storage. 299 "labels": { # Resource labels to represent user provided metadata. 300 "a_key": "A String", 301 }, 302 "name": "A String", # Output only. The resource name of the backup, in the format `projects/{project_number}/locations/{location_id}/backups/{backup_id}`. 303 "satisfiesPzs": True or False, # Output only. Reserved for future use. 304 "sourceFileShare": "A String", # Name of the file share in the source Cloud Filestore instance that the backup is created from. 305 "sourceInstance": "A String", # The resource name of the source Cloud Filestore instance, in the format `projects/{project_number}/locations/{location_id}/instances/{instance_id}`, used to create this backup. 306 "sourceInstanceTier": "A String", # Output only. The service tier of the source Cloud Filestore instance that this backup is created from. 307 "state": "A String", # Output only. The backup state. 308 "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. 309} 310 311 updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field. 312 x__xgafv: string, V1 error format. 313 Allowed values 314 1 - v1 error format 315 2 - v2 error format 316 317Returns: 318 An object of the form: 319 320 { # This resource represents a long-running operation that is the result of a network API call. 321 "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. 322 "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. 323 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 324 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 325 { 326 "a_key": "", # Properties of the object. Contains field @type with type URL. 327 }, 328 ], 329 "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. 330 }, 331 "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. 332 "a_key": "", # Properties of the object. Contains field @type with type URL. 333 }, 334 "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}`. 335 "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`. 336 "a_key": "", # Properties of the object. Contains field @type with type URL. 337 }, 338}</pre> 339</div> 340 341</body></html>