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.instances.html">instances</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#create">create(parent, body, instanceId=None, x__xgafv=None)</a></code></p> 79<p class="firstline">Creates an instance.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 82<p class="firstline">Deletes an instance.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Gets the details of a specific instance.</p> 86<p class="toc_element"> 87 <code><a href="#list">list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</a></code></p> 88<p class="firstline">Lists all instances in a project for either a specified location</p> 89<p class="toc_element"> 90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 91<p class="firstline">Retrieves the next page of results.</p> 92<p class="toc_element"> 93 <code><a href="#patch">patch(name, body, updateMask=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Updates the settings of a specific instance.</p> 95<h3>Method Details</h3> 96<div class="method"> 97 <code class="details" id="create">create(parent, body, instanceId=None, x__xgafv=None)</code> 98 <pre>Creates an instance. 99 100Args: 101 parent: string, The instance's project and location, in the format 102projects/{project_id}/locations/{location}. In Cloud Filestore, 103locations map to GCP zones, for example **us-west1-b**. (required) 104 body: object, The request body. (required) 105 The object takes the form of: 106 107{ # A Cloud Filestore instance. 108 "description": "A String", # Optional. A description of the instance (2048 characters or less). 109 "labels": { # Resource labels to represent user provided metadata. 110 "a_key": "A String", 111 }, 112 "networks": [ # VPC networks to which the instance is connected. 113 # For this version, only a single network is supported. 114 { # Network configuration for the instance. 115 "reservedIpRange": "A String", # A /29 CIDR block in one of the 116 # [internal IP address 117 # ranges](https://www.arin.net/knowledge/address_filters.html) that 118 # identifies the range of IP addresses reserved for this instance. For 119 # example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify can't overlap 120 # with either existing subnets or assigned IP address ranges for other Cloud 121 # Filestore instances in the selected VPC network. 122 "modes": [ # Internet protocol versions for which the instance has IP addresses 123 # assigned. For this version, only MODE_IPV4 is supported. 124 "A String", 125 ], 126 "ipAddresses": [ # Output only. 127 # IPv4 addresses in the format 128 # {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format 129 # {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block 130 # 7}:{block 8}. 131 "A String", 132 ], 133 "network": "A String", # The name of the Google Compute Engine 134 # [VPC network](/compute/docs/networks-and-firewalls#networks) to which the 135 # instance is connected. 136 }, 137 ], 138 "state": "A String", # Output only. 139 # The instance state. 140 "etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous 141 # updates from overwriting each other. 142 "fileShares": [ # File system shares on the instance. 143 # For this version, only a single file share is supported. 144 { # File share configuration for the instance. 145 "capacityGb": "A String", # File share capacity in gigabytes (GB). 146 # Cloud Filestore defines 1 GB as 1024^3 bytes. 147 "name": "A String", # The name of the file share (must be 16 characters or less). 148 }, 149 ], 150 "tier": "A String", # The service tier of the instance. 151 "createTime": "A String", # Output only. 152 # The time when the instance was created. 153 "statusMessage": "A String", # Output only. 154 # Additional information about the instance state, if available. 155 "name": "A String", # Output only. 156 # The resource name of the instance, in the format 157 # projects/{project_id}/locations/{location_id}/instances/{instance_id}. 158 } 159 160 instanceId: string, The name of the instance to create. 161The name must be unique for the specified project and location. 162 x__xgafv: string, V1 error format. 163 Allowed values 164 1 - v1 error format 165 2 - v2 error format 166 167Returns: 168 An object of the form: 169 170 { # This resource represents a long-running operation that is the result of a 171 # network API call. 172 "metadata": { # Service-specific metadata associated with the operation. It typically 173 # contains progress information and common metadata such as create time. 174 # Some services might not provide such metadata. Any method that returns a 175 # long-running operation should document the metadata type, if any. 176 "a_key": "", # Properties of the object. Contains field @type with type URL. 177 }, 178 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. 179 # different programming environments, including REST APIs and RPC APIs. It is 180 # used by [gRPC](https://github.com/grpc). The error model is designed to be: 181 # 182 # - Simple to use and understand for most users 183 # - Flexible enough to meet unexpected needs 184 # 185 # # Overview 186 # 187 # The `Status` message contains three pieces of data: error code, error 188 # message, and error details. The error code should be an enum value of 189 # google.rpc.Code, but it may accept additional error codes if needed. The 190 # error message should be a developer-facing English message that helps 191 # developers *understand* and *resolve* the error. If a localized user-facing 192 # error message is needed, put the localized message in the error details or 193 # localize it in the client. The optional error details may contain arbitrary 194 # information about the error. There is a predefined set of error detail types 195 # in the package `google.rpc` that can be used for common error conditions. 196 # 197 # # Language mapping 198 # 199 # The `Status` message is the logical representation of the error model, but it 200 # is not necessarily the actual wire format. When the `Status` message is 201 # exposed in different client libraries and different wire protocols, it can be 202 # mapped differently. For example, it will likely be mapped to some exceptions 203 # in Java, but more likely mapped to some error codes in C. 204 # 205 # # Other uses 206 # 207 # The error model and the `Status` message can be used in a variety of 208 # environments, either with or without APIs, to provide a 209 # consistent developer experience across different environments. 210 # 211 # Example uses of this error model include: 212 # 213 # - Partial errors. If a service needs to return partial errors to the client, 214 # it may embed the `Status` in the normal response to indicate the partial 215 # errors. 216 # 217 # - Workflow errors. A typical workflow has multiple steps. Each step may 218 # have a `Status` message for error reporting. 219 # 220 # - Batch operations. If a client uses batch request and batch response, the 221 # `Status` message should be used directly inside batch response, one for 222 # each error sub-response. 223 # 224 # - Asynchronous operations. If an API call embeds asynchronous operation 225 # results in its response, the status of those operations should be 226 # represented directly using the `Status` message. 227 # 228 # - Logging. If some API errors are stored in logs, the message `Status` could 229 # be used directly after any stripping needed for security/privacy reasons. 230 "message": "A String", # A developer-facing error message, which should be in English. Any 231 # user-facing error message should be localized and sent in the 232 # google.rpc.Status.details field, or localized by the client. 233 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 234 "details": [ # A list of messages that carry the error details. There is a common set of 235 # message types for APIs to use. 236 { 237 "a_key": "", # Properties of the object. Contains field @type with type URL. 238 }, 239 ], 240 }, 241 "done": True or False, # If the value is `false`, it means the operation is still in progress. 242 # If `true`, the operation is completed, and either `error` or `response` is 243 # available. 244 "response": { # The normal response of the operation in case of success. If the original 245 # method returns no data on success, such as `Delete`, the response is 246 # `google.protobuf.Empty`. If the original method is standard 247 # `Get`/`Create`/`Update`, the response should be the resource. For other 248 # methods, the response should have the type `XxxResponse`, where `Xxx` 249 # is the original method name. For example, if the original method name 250 # is `TakeSnapshot()`, the inferred response type is 251 # `TakeSnapshotResponse`. 252 "a_key": "", # Properties of the object. Contains field @type with type URL. 253 }, 254 "name": "A String", # The server-assigned name, which is only unique within the same service that 255 # originally returns it. If you use the default HTTP mapping, the 256 # `name` should be a resource name ending with `operations/{unique_id}`. 257 }</pre> 258</div> 259 260<div class="method"> 261 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 262 <pre>Deletes an instance. 263 264Args: 265 name: string, The instance resource name, in the format 266projects/{project_id}/locations/{location}/instances/{instance_id} (required) 267 x__xgafv: string, V1 error format. 268 Allowed values 269 1 - v1 error format 270 2 - v2 error format 271 272Returns: 273 An object of the form: 274 275 { # This resource represents a long-running operation that is the result of a 276 # network API call. 277 "metadata": { # Service-specific metadata associated with the operation. It typically 278 # contains progress information and common metadata such as create time. 279 # Some services might not provide such metadata. Any method that returns a 280 # long-running operation should document the metadata type, if any. 281 "a_key": "", # Properties of the object. Contains field @type with type URL. 282 }, 283 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. 284 # different programming environments, including REST APIs and RPC APIs. It is 285 # used by [gRPC](https://github.com/grpc). The error model is designed to be: 286 # 287 # - Simple to use and understand for most users 288 # - Flexible enough to meet unexpected needs 289 # 290 # # Overview 291 # 292 # The `Status` message contains three pieces of data: error code, error 293 # message, and error details. The error code should be an enum value of 294 # google.rpc.Code, but it may accept additional error codes if needed. The 295 # error message should be a developer-facing English message that helps 296 # developers *understand* and *resolve* the error. If a localized user-facing 297 # error message is needed, put the localized message in the error details or 298 # localize it in the client. The optional error details may contain arbitrary 299 # information about the error. There is a predefined set of error detail types 300 # in the package `google.rpc` that can be used for common error conditions. 301 # 302 # # Language mapping 303 # 304 # The `Status` message is the logical representation of the error model, but it 305 # is not necessarily the actual wire format. When the `Status` message is 306 # exposed in different client libraries and different wire protocols, it can be 307 # mapped differently. For example, it will likely be mapped to some exceptions 308 # in Java, but more likely mapped to some error codes in C. 309 # 310 # # Other uses 311 # 312 # The error model and the `Status` message can be used in a variety of 313 # environments, either with or without APIs, to provide a 314 # consistent developer experience across different environments. 315 # 316 # Example uses of this error model include: 317 # 318 # - Partial errors. If a service needs to return partial errors to the client, 319 # it may embed the `Status` in the normal response to indicate the partial 320 # errors. 321 # 322 # - Workflow errors. A typical workflow has multiple steps. Each step may 323 # have a `Status` message for error reporting. 324 # 325 # - Batch operations. If a client uses batch request and batch response, the 326 # `Status` message should be used directly inside batch response, one for 327 # each error sub-response. 328 # 329 # - Asynchronous operations. If an API call embeds asynchronous operation 330 # results in its response, the status of those operations should be 331 # represented directly using the `Status` message. 332 # 333 # - Logging. If some API errors are stored in logs, the message `Status` could 334 # be used directly after any stripping needed for security/privacy reasons. 335 "message": "A String", # A developer-facing error message, which should be in English. Any 336 # user-facing error message should be localized and sent in the 337 # google.rpc.Status.details field, or localized by the client. 338 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 339 "details": [ # A list of messages that carry the error details. There is a common set of 340 # message types for APIs to use. 341 { 342 "a_key": "", # Properties of the object. Contains field @type with type URL. 343 }, 344 ], 345 }, 346 "done": True or False, # If the value is `false`, it means the operation is still in progress. 347 # If `true`, the operation is completed, and either `error` or `response` is 348 # available. 349 "response": { # The normal response of the operation in case of success. If the original 350 # method returns no data on success, such as `Delete`, the response is 351 # `google.protobuf.Empty`. If the original method is standard 352 # `Get`/`Create`/`Update`, the response should be the resource. For other 353 # methods, the response should have the type `XxxResponse`, where `Xxx` 354 # is the original method name. For example, if the original method name 355 # is `TakeSnapshot()`, the inferred response type is 356 # `TakeSnapshotResponse`. 357 "a_key": "", # Properties of the object. Contains field @type with type URL. 358 }, 359 "name": "A String", # The server-assigned name, which is only unique within the same service that 360 # originally returns it. If you use the default HTTP mapping, the 361 # `name` should be a resource name ending with `operations/{unique_id}`. 362 }</pre> 363</div> 364 365<div class="method"> 366 <code class="details" id="get">get(name, x__xgafv=None)</code> 367 <pre>Gets the details of a specific instance. 368 369Args: 370 name: string, The instance resource name, in the format 371projects/{project_id}/locations/{location}/instances/{instance_id}. (required) 372 x__xgafv: string, V1 error format. 373 Allowed values 374 1 - v1 error format 375 2 - v2 error format 376 377Returns: 378 An object of the form: 379 380 { # A Cloud Filestore instance. 381 "description": "A String", # Optional. A description of the instance (2048 characters or less). 382 "labels": { # Resource labels to represent user provided metadata. 383 "a_key": "A String", 384 }, 385 "networks": [ # VPC networks to which the instance is connected. 386 # For this version, only a single network is supported. 387 { # Network configuration for the instance. 388 "reservedIpRange": "A String", # A /29 CIDR block in one of the 389 # [internal IP address 390 # ranges](https://www.arin.net/knowledge/address_filters.html) that 391 # identifies the range of IP addresses reserved for this instance. For 392 # example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify can't overlap 393 # with either existing subnets or assigned IP address ranges for other Cloud 394 # Filestore instances in the selected VPC network. 395 "modes": [ # Internet protocol versions for which the instance has IP addresses 396 # assigned. For this version, only MODE_IPV4 is supported. 397 "A String", 398 ], 399 "ipAddresses": [ # Output only. 400 # IPv4 addresses in the format 401 # {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format 402 # {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block 403 # 7}:{block 8}. 404 "A String", 405 ], 406 "network": "A String", # The name of the Google Compute Engine 407 # [VPC network](/compute/docs/networks-and-firewalls#networks) to which the 408 # instance is connected. 409 }, 410 ], 411 "state": "A String", # Output only. 412 # The instance state. 413 "etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous 414 # updates from overwriting each other. 415 "fileShares": [ # File system shares on the instance. 416 # For this version, only a single file share is supported. 417 { # File share configuration for the instance. 418 "capacityGb": "A String", # File share capacity in gigabytes (GB). 419 # Cloud Filestore defines 1 GB as 1024^3 bytes. 420 "name": "A String", # The name of the file share (must be 16 characters or less). 421 }, 422 ], 423 "tier": "A String", # The service tier of the instance. 424 "createTime": "A String", # Output only. 425 # The time when the instance was created. 426 "statusMessage": "A String", # Output only. 427 # Additional information about the instance state, if available. 428 "name": "A String", # Output only. 429 # The resource name of the instance, in the format 430 # projects/{project_id}/locations/{location_id}/instances/{instance_id}. 431 }</pre> 432</div> 433 434<div class="method"> 435 <code class="details" id="list">list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</code> 436 <pre>Lists all instances in a project for either a specified location 437or for all locations. 438 439Args: 440 parent: string, The project and location for which to retrieve instance information, 441in the format projects/{project_id}/locations/{location}. In Cloud 442Filestore, locations map to GCP zones, for example **us-west1-b**. To 443retrieve instance information for all locations, use "-" for the {location} 444value. (required) 445 orderBy: string, Sort results. Supported values are "name", "name desc" or "" (unsorted). 446 pageSize: integer, The maximum number of items to return. 447 pageToken: string, The next_page_token value to use if there are additional 448results to retrieve for this list request. 449 x__xgafv: string, V1 error format. 450 Allowed values 451 1 - v1 error format 452 2 - v2 error format 453 filter: string, List filter. 454 455Returns: 456 An object of the form: 457 458 { # ListInstancesResponse is the result of ListInstancesRequest. 459 "nextPageToken": "A String", # The token you can use to retrieve the next page of results. Not returned 460 # if there are no more results in the list. 461 "unreachable": [ # Locations that could not be reached. 462 "A String", 463 ], 464 "instances": [ # A list of instances in the project for the specified location. 465 # 466 # If the {location} value in the request is "-", the response contains a list 467 # of instances from all locations. If any location is unreachable, the 468 # response will only return instances in reachable locations and the 469 # "unreachable" field will be populated with a list of unreachable locations. 470 { # A Cloud Filestore instance. 471 "description": "A String", # Optional. A description of the instance (2048 characters or less). 472 "labels": { # Resource labels to represent user provided metadata. 473 "a_key": "A String", 474 }, 475 "networks": [ # VPC networks to which the instance is connected. 476 # For this version, only a single network is supported. 477 { # Network configuration for the instance. 478 "reservedIpRange": "A String", # A /29 CIDR block in one of the 479 # [internal IP address 480 # ranges](https://www.arin.net/knowledge/address_filters.html) that 481 # identifies the range of IP addresses reserved for this instance. For 482 # example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify can't overlap 483 # with either existing subnets or assigned IP address ranges for other Cloud 484 # Filestore instances in the selected VPC network. 485 "modes": [ # Internet protocol versions for which the instance has IP addresses 486 # assigned. For this version, only MODE_IPV4 is supported. 487 "A String", 488 ], 489 "ipAddresses": [ # Output only. 490 # IPv4 addresses in the format 491 # {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format 492 # {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block 493 # 7}:{block 8}. 494 "A String", 495 ], 496 "network": "A String", # The name of the Google Compute Engine 497 # [VPC network](/compute/docs/networks-and-firewalls#networks) to which the 498 # instance is connected. 499 }, 500 ], 501 "state": "A String", # Output only. 502 # The instance state. 503 "etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous 504 # updates from overwriting each other. 505 "fileShares": [ # File system shares on the instance. 506 # For this version, only a single file share is supported. 507 { # File share configuration for the instance. 508 "capacityGb": "A String", # File share capacity in gigabytes (GB). 509 # Cloud Filestore defines 1 GB as 1024^3 bytes. 510 "name": "A String", # The name of the file share (must be 16 characters or less). 511 }, 512 ], 513 "tier": "A String", # The service tier of the instance. 514 "createTime": "A String", # Output only. 515 # The time when the instance was created. 516 "statusMessage": "A String", # Output only. 517 # Additional information about the instance state, if available. 518 "name": "A String", # Output only. 519 # The resource name of the instance, in the format 520 # projects/{project_id}/locations/{location_id}/instances/{instance_id}. 521 }, 522 ], 523 }</pre> 524</div> 525 526<div class="method"> 527 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 528 <pre>Retrieves the next page of results. 529 530Args: 531 previous_request: The request for the previous page. (required) 532 previous_response: The response from the request for the previous page. (required) 533 534Returns: 535 A request object that you can call 'execute()' on to request the next 536 page. Returns None if there are no more items in the collection. 537 </pre> 538</div> 539 540<div class="method"> 541 <code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code> 542 <pre>Updates the settings of a specific instance. 543 544Args: 545 name: string, Output only. 546The resource name of the instance, in the format 547projects/{project_id}/locations/{location_id}/instances/{instance_id}. (required) 548 body: object, The request body. (required) 549 The object takes the form of: 550 551{ # A Cloud Filestore instance. 552 "description": "A String", # Optional. A description of the instance (2048 characters or less). 553 "labels": { # Resource labels to represent user provided metadata. 554 "a_key": "A String", 555 }, 556 "networks": [ # VPC networks to which the instance is connected. 557 # For this version, only a single network is supported. 558 { # Network configuration for the instance. 559 "reservedIpRange": "A String", # A /29 CIDR block in one of the 560 # [internal IP address 561 # ranges](https://www.arin.net/knowledge/address_filters.html) that 562 # identifies the range of IP addresses reserved for this instance. For 563 # example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify can't overlap 564 # with either existing subnets or assigned IP address ranges for other Cloud 565 # Filestore instances in the selected VPC network. 566 "modes": [ # Internet protocol versions for which the instance has IP addresses 567 # assigned. For this version, only MODE_IPV4 is supported. 568 "A String", 569 ], 570 "ipAddresses": [ # Output only. 571 # IPv4 addresses in the format 572 # {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format 573 # {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block 574 # 7}:{block 8}. 575 "A String", 576 ], 577 "network": "A String", # The name of the Google Compute Engine 578 # [VPC network](/compute/docs/networks-and-firewalls#networks) to which the 579 # instance is connected. 580 }, 581 ], 582 "state": "A String", # Output only. 583 # The instance state. 584 "etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous 585 # updates from overwriting each other. 586 "fileShares": [ # File system shares on the instance. 587 # For this version, only a single file share is supported. 588 { # File share configuration for the instance. 589 "capacityGb": "A String", # File share capacity in gigabytes (GB). 590 # Cloud Filestore defines 1 GB as 1024^3 bytes. 591 "name": "A String", # The name of the file share (must be 16 characters or less). 592 }, 593 ], 594 "tier": "A String", # The service tier of the instance. 595 "createTime": "A String", # Output only. 596 # The time when the instance was created. 597 "statusMessage": "A String", # Output only. 598 # Additional information about the instance state, if available. 599 "name": "A String", # Output only. 600 # The resource name of the instance, in the format 601 # projects/{project_id}/locations/{location_id}/instances/{instance_id}. 602 } 603 604 updateMask: string, Mask of fields to update. At least one path must be supplied in this 605field. The elements of the repeated paths field may only include these 606fields: 607"description" 608 x__xgafv: string, V1 error format. 609 Allowed values 610 1 - v1 error format 611 2 - v2 error format 612 613Returns: 614 An object of the form: 615 616 { # This resource represents a long-running operation that is the result of a 617 # network API call. 618 "metadata": { # Service-specific metadata associated with the operation. It typically 619 # contains progress information and common metadata such as create time. 620 # Some services might not provide such metadata. Any method that returns a 621 # long-running operation should document the metadata type, if any. 622 "a_key": "", # Properties of the object. Contains field @type with type URL. 623 }, 624 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. 625 # different programming environments, including REST APIs and RPC APIs. It is 626 # used by [gRPC](https://github.com/grpc). The error model is designed to be: 627 # 628 # - Simple to use and understand for most users 629 # - Flexible enough to meet unexpected needs 630 # 631 # # Overview 632 # 633 # The `Status` message contains three pieces of data: error code, error 634 # message, and error details. The error code should be an enum value of 635 # google.rpc.Code, but it may accept additional error codes if needed. The 636 # error message should be a developer-facing English message that helps 637 # developers *understand* and *resolve* the error. If a localized user-facing 638 # error message is needed, put the localized message in the error details or 639 # localize it in the client. The optional error details may contain arbitrary 640 # information about the error. There is a predefined set of error detail types 641 # in the package `google.rpc` that can be used for common error conditions. 642 # 643 # # Language mapping 644 # 645 # The `Status` message is the logical representation of the error model, but it 646 # is not necessarily the actual wire format. When the `Status` message is 647 # exposed in different client libraries and different wire protocols, it can be 648 # mapped differently. For example, it will likely be mapped to some exceptions 649 # in Java, but more likely mapped to some error codes in C. 650 # 651 # # Other uses 652 # 653 # The error model and the `Status` message can be used in a variety of 654 # environments, either with or without APIs, to provide a 655 # consistent developer experience across different environments. 656 # 657 # Example uses of this error model include: 658 # 659 # - Partial errors. If a service needs to return partial errors to the client, 660 # it may embed the `Status` in the normal response to indicate the partial 661 # errors. 662 # 663 # - Workflow errors. A typical workflow has multiple steps. Each step may 664 # have a `Status` message for error reporting. 665 # 666 # - Batch operations. If a client uses batch request and batch response, the 667 # `Status` message should be used directly inside batch response, one for 668 # each error sub-response. 669 # 670 # - Asynchronous operations. If an API call embeds asynchronous operation 671 # results in its response, the status of those operations should be 672 # represented directly using the `Status` message. 673 # 674 # - Logging. If some API errors are stored in logs, the message `Status` could 675 # be used directly after any stripping needed for security/privacy reasons. 676 "message": "A String", # A developer-facing error message, which should be in English. Any 677 # user-facing error message should be localized and sent in the 678 # google.rpc.Status.details field, or localized by the client. 679 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 680 "details": [ # A list of messages that carry the error details. There is a common set of 681 # message types for APIs to use. 682 { 683 "a_key": "", # Properties of the object. Contains field @type with type URL. 684 }, 685 ], 686 }, 687 "done": True or False, # If the value is `false`, it means the operation is still in progress. 688 # If `true`, the operation is completed, and either `error` or `response` is 689 # available. 690 "response": { # The normal response of the operation in case of success. If the original 691 # method returns no data on success, such as `Delete`, the response is 692 # `google.protobuf.Empty`. If the original method is standard 693 # `Get`/`Create`/`Update`, the response should be the resource. For other 694 # methods, the response should have the type `XxxResponse`, where `Xxx` 695 # is the original method name. For example, if the original method name 696 # is `TakeSnapshot()`, the inferred response type is 697 # `TakeSnapshotResponse`. 698 "a_key": "", # Properties of the object. Contains field @type with type URL. 699 }, 700 "name": "A String", # The server-assigned name, which is only unique within the same service that 701 # originally returns it. If you use the default HTTP mapping, the 702 # `name` should be a resource name ending with `operations/{unique_id}`. 703 }</pre> 704</div> 705 706</body></html>