| yoshi-code-bot | a36e3b1 | 2021-07-27 00:20:26 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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_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.instances.html">instances</a> . <a href="file_v1beta1.projects.locations.instances.snapshots.html">snapshots</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, body=None, snapshotId=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Creates a snapshot.</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 snapshot.</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 snapshot.</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 snapshots 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 snapshot.</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, body=None, snapshotId=None, x__xgafv=None)</code> |
| 106 | <pre>Creates a snapshot. |
| 107 | |
| 108 | Args: |
| 109 | parent: string, Required. The Filestore Instance to create the snapshots of, in the format projects/{project_id}/locations/{location}/instances/{instance_id} (required) |
| 110 | body: object, The request body. |
| 111 | The object takes the form of: |
| 112 | |
| 113 | { # A Cloud Filestore snapshot. |
| 114 | "createTime": "A String", # Output only. The time when the snapshot was created. |
| 115 | "description": "A String", # A description of the snapshot with 2048 characters or less. Requests with longer descriptions will be rejected. |
| 116 | "filesystemUsedBytes": "A String", # Output only. The amount of bytes needed to allocate a full copy of the snapshot content |
| 117 | "labels": { # Resource labels to represent user provided metadata. |
| 118 | "a_key": "A String", |
| 119 | }, |
| 120 | "name": "A String", # Output only. The resource name of the snapshot, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapshots/{snapshot_id}. |
| 121 | "state": "A String", # Output only. The snapshot state. |
| 122 | } |
| 123 | |
| 124 | snapshotId: string, Required. The ID to use for the snapshot. The ID must be unique within the specified instance. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. |
| 125 | x__xgafv: string, V1 error format. |
| 126 | Allowed values |
| 127 | 1 - v1 error format |
| 128 | 2 - v2 error format |
| 129 | |
| 130 | Returns: |
| 131 | An object of the form: |
| 132 | |
| 133 | { # This resource represents a long-running operation that is the result of a network API call. |
| 134 | "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. |
| 135 | "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. |
| 136 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 137 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 138 | { |
| 139 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 140 | }, |
| 141 | ], |
| 142 | "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. |
| 143 | }, |
| 144 | "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. |
| 145 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 146 | }, |
| 147 | "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}`. |
| 148 | "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`. |
| 149 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 150 | }, |
| 151 | }</pre> |
| 152 | </div> |
| 153 | |
| 154 | <div class="method"> |
| 155 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 156 | <pre>Deletes a snapshot. |
| 157 | |
| 158 | Args: |
| 159 | name: string, Required. The snapshot resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id}/snapshots/{snapshot_id} (required) |
| 160 | x__xgafv: string, V1 error format. |
| 161 | Allowed values |
| 162 | 1 - v1 error format |
| 163 | 2 - v2 error format |
| 164 | |
| 165 | Returns: |
| 166 | An object of the form: |
| 167 | |
| 168 | { # This resource represents a long-running operation that is the result of a network API call. |
| 169 | "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. |
| 170 | "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. |
| 171 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 172 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 173 | { |
| 174 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 175 | }, |
| 176 | ], |
| 177 | "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. |
| 178 | }, |
| 179 | "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. |
| 180 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 181 | }, |
| 182 | "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}`. |
| 183 | "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`. |
| 184 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 185 | }, |
| 186 | }</pre> |
| 187 | </div> |
| 188 | |
| 189 | <div class="method"> |
| 190 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 191 | <pre>Gets the details of a specific snapshot. |
| 192 | |
| 193 | Args: |
| 194 | name: string, Required. The snapshot resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id}/snapshots/{snapshot_id} (required) |
| 195 | x__xgafv: string, V1 error format. |
| 196 | Allowed values |
| 197 | 1 - v1 error format |
| 198 | 2 - v2 error format |
| 199 | |
| 200 | Returns: |
| 201 | An object of the form: |
| 202 | |
| 203 | { # A Cloud Filestore snapshot. |
| 204 | "createTime": "A String", # Output only. The time when the snapshot was created. |
| 205 | "description": "A String", # A description of the snapshot with 2048 characters or less. Requests with longer descriptions will be rejected. |
| 206 | "filesystemUsedBytes": "A String", # Output only. The amount of bytes needed to allocate a full copy of the snapshot content |
| 207 | "labels": { # Resource labels to represent user provided metadata. |
| 208 | "a_key": "A String", |
| 209 | }, |
| 210 | "name": "A String", # Output only. The resource name of the snapshot, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapshots/{snapshot_id}. |
| 211 | "state": "A String", # Output only. The snapshot state. |
| 212 | }</pre> |
| 213 | </div> |
| 214 | |
| 215 | <div class="method"> |
| 216 | <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| 217 | <pre>Lists all snapshots in a project for either a specified location or for all locations. |
| 218 | |
| 219 | Args: |
| 220 | parent: string, Required. The instance for which to retrieve snapshot information, in the format projects/{project_id}/locations/{location}/instances/{instance_id}. (required) |
| 221 | filter: string, List filter. |
| 222 | orderBy: string, Sort results. Supported values are "name", "name desc" or "" (unsorted). |
| 223 | pageSize: integer, The maximum number of items to return. |
| 224 | pageToken: string, The next_page_token value to use if there are additional results to retrieve for this list request. |
| 225 | x__xgafv: string, V1 error format. |
| 226 | Allowed values |
| 227 | 1 - v1 error format |
| 228 | 2 - v2 error format |
| 229 | |
| 230 | Returns: |
| 231 | An object of the form: |
| 232 | |
| 233 | { # ListSnapshotsResponse is the result of ListSnapshotsRequest. |
| 234 | "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. |
| 235 | "snapshots": [ # A list of snapshots in the project for the specified instance. |
| 236 | { # A Cloud Filestore snapshot. |
| 237 | "createTime": "A String", # Output only. The time when the snapshot was created. |
| 238 | "description": "A String", # A description of the snapshot with 2048 characters or less. Requests with longer descriptions will be rejected. |
| 239 | "filesystemUsedBytes": "A String", # Output only. The amount of bytes needed to allocate a full copy of the snapshot content |
| 240 | "labels": { # Resource labels to represent user provided metadata. |
| 241 | "a_key": "A String", |
| 242 | }, |
| 243 | "name": "A String", # Output only. The resource name of the snapshot, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapshots/{snapshot_id}. |
| 244 | "state": "A String", # Output only. The snapshot state. |
| 245 | }, |
| 246 | ], |
| 247 | }</pre> |
| 248 | </div> |
| 249 | |
| 250 | <div class="method"> |
| 251 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 252 | <pre>Retrieves the next page of results. |
| 253 | |
| 254 | Args: |
| 255 | previous_request: The request for the previous page. (required) |
| 256 | previous_response: The response from the request for the previous page. (required) |
| 257 | |
| 258 | Returns: |
| 259 | A request object that you can call 'execute()' on to request the next |
| 260 | page. Returns None if there are no more items in the collection. |
| 261 | </pre> |
| 262 | </div> |
| 263 | |
| 264 | <div class="method"> |
| 265 | <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| 266 | <pre>Updates the settings of a specific snapshot. |
| 267 | |
| 268 | Args: |
| 269 | name: string, Output only. The resource name of the snapshot, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapshots/{snapshot_id}. (required) |
| 270 | body: object, The request body. |
| 271 | The object takes the form of: |
| 272 | |
| 273 | { # A Cloud Filestore snapshot. |
| 274 | "createTime": "A String", # Output only. The time when the snapshot was created. |
| 275 | "description": "A String", # A description of the snapshot with 2048 characters or less. Requests with longer descriptions will be rejected. |
| 276 | "filesystemUsedBytes": "A String", # Output only. The amount of bytes needed to allocate a full copy of the snapshot content |
| 277 | "labels": { # Resource labels to represent user provided metadata. |
| 278 | "a_key": "A String", |
| 279 | }, |
| 280 | "name": "A String", # Output only. The resource name of the snapshot, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapshots/{snapshot_id}. |
| 281 | "state": "A String", # Output only. The snapshot state. |
| 282 | } |
| 283 | |
| 284 | updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field. |
| 285 | x__xgafv: string, V1 error format. |
| 286 | Allowed values |
| 287 | 1 - v1 error format |
| 288 | 2 - v2 error format |
| 289 | |
| 290 | Returns: |
| 291 | An object of the form: |
| 292 | |
| 293 | { # This resource represents a long-running operation that is the result of a network API call. |
| 294 | "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. |
| 295 | "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. |
| 296 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 297 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 298 | { |
| 299 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 300 | }, |
| 301 | ], |
| 302 | "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. |
| 303 | }, |
| 304 | "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. |
| 305 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 306 | }, |
| 307 | "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}`. |
| 308 | "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`. |
| 309 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 310 | }, |
| 311 | }</pre> |
| 312 | </div> |
| 313 | |
| 314 | </body></html> |