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="cloudfunctions_v1beta2.html">Cloud Functions API</a> . <a href="cloudfunctions_v1beta2.projects.html">projects</a> . <a href="cloudfunctions_v1beta2.projects.locations.html">locations</a> . <a href="cloudfunctions_v1beta2.projects.locations.functions.html">functions</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#call">call(name, body, x__xgafv=None)</a></code></p> 79<p class="firstline">Synchronously invokes a deployed Cloud Function. To be used for testing</p> 80<p class="toc_element"> 81 <code><a href="#create">create(location, body, x__xgafv=None)</a></code></p> 82<p class="firstline">Creates a new function. If a function with the given name already exists in</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 function with the given name from the specified project. If the</p> 86<p class="toc_element"> 87 <code><a href="#generateDownloadUrl">generateDownloadUrl(name, body, x__xgafv=None)</a></code></p> 88<p class="firstline">Returns a signed URL for downloading deployed function source code.</p> 89<p class="toc_element"> 90 <code><a href="#generateUploadUrl">generateUploadUrl(parent, body=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Returns a signed URL for uploading a function source code.</p> 92<p class="toc_element"> 93 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 94<p class="firstline">Returns a function with the given name from the requested project.</p> 95<p class="toc_element"> 96 <code><a href="#list">list(location, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Returns a list of functions that belong to the requested project.</p> 98<p class="toc_element"> 99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 100<p class="firstline">Retrieves the next page of results.</p> 101<p class="toc_element"> 102 <code><a href="#update">update(name, body, x__xgafv=None)</a></code></p> 103<p class="firstline">Updates existing function.</p> 104<h3>Method Details</h3> 105<div class="method"> 106 <code class="details" id="call">call(name, body, x__xgafv=None)</code> 107 <pre>Synchronously invokes a deployed Cloud Function. To be used for testing 108purposes as very limited traffic is allowed. For more information on 109the actual limits refer to [API Calls]( 110https://cloud.google.com/functions/quotas#rate_limits). 111 112Args: 113 name: string, The name of the function to be called. (required) 114 body: object, The request body. (required) 115 The object takes the form of: 116 117{ # Request for the `CallFunction` method. 118 "data": "A String", # Input to be passed to the function. 119 } 120 121 x__xgafv: string, V1 error format. 122 Allowed values 123 1 - v1 error format 124 2 - v2 error format 125 126Returns: 127 An object of the form: 128 129 { # Response of `CallFunction` method. 130 "executionId": "A String", # Execution id of function invocation. 131 "result": "A String", # Result populated for successful execution of synchronous function. Will 132 # not be populated if function does not return a result through context. 133 "error": "A String", # Either system or user-function generated error. Set if execution 134 # was not successful. 135 }</pre> 136</div> 137 138<div class="method"> 139 <code class="details" id="create">create(location, body, x__xgafv=None)</code> 140 <pre>Creates a new function. If a function with the given name already exists in 141the specified project, the long running operation will return 142`ALREADY_EXISTS` error. 143 144Args: 145 location: string, The project and location in which the function should be created, specified 146in the format `projects/*/locations/*` (required) 147 body: object, The request body. (required) 148 The object takes the form of: 149 150{ # Describes a Cloud Function that contains user computation executed in 151 # response to an event. It encapsulate function and triggers configurations. 152 "status": "A String", # Output only. Status of the function deployment. 153 "eventTrigger": { # Describes EventTrigger, used to request events be sent from another # A source that fires events in response to a condition in another service. 154 # service. 155 "eventType": "A String", # `event_type` names contain the service that is sending an event and the 156 # kind of event that was fired. Must be of the form 157 # `providers/*/eventTypes/*` e.g. Directly handle a Message published to 158 # Google Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish`. 159 # 160 # Handle an object changing in Google Cloud Storage: 161 # `providers/cloud.storage/eventTypes/object.change` 162 # 163 # Handle a write to the Firebase Realtime Database: 164 # `providers/google.firebase.database/eventTypes/ref.write` 165 "resource": "A String", # Which instance of the source's service should send events. E.g. for Pub/Sub 166 # this would be a Pub/Sub topic at `projects/*/topics/*`. For Google Cloud 167 # Storage this would be a bucket at `projects/*/buckets/*`. For any source 168 # that only supports one instance per-project, this should be the name of the 169 # project (`projects/*`) 170 "service": "A String", # The hostname of the service that should be observed. 171 # 172 # If no string is provided, the default service implementing the API will 173 # be used. For example, `storage.googleapis.com` is the default for all 174 # event types in the `google.storage` namespace. 175 "failurePolicy": { # Describes the policy in case of function's execution failure. # Specifies policy for failed executions. 176 # If empty, then defaults to ignoring failures (i.e. not retrying them). 177 "retry": { # Describes the retry policy in case of function's execution failure. # If specified, then the function will be retried in case of a failure. 178 # A function execution will be retried on any failure. 179 # A failed execution will be retried up to 7 days with an exponential backoff 180 # (capped at 10 seconds). 181 # Retried execution is charged as any other execution. 182 }, 183 }, 184 }, 185 "updateTime": "A String", # Output only. The last update timestamp of a Cloud Function. 186 "name": "A String", # A user-defined name of the function. Function names must be unique 187 # globally and match pattern `projects/*/locations/*/functions/*` 188 "maxInstances": 42, # The limit on the maximum number of function instances that may coexist at a 189 # given time. 190 "sourceRepository": { # Describes the location of the function source in a remote repository. # The hosted repository where the function is defined. 191 "repositoryUrl": "A String", # URL to the hosted repository where the function is defined. Only paths in 192 # https://source.developers.google.com domain are supported. The path should 193 # contain the name of the repository. 194 "sourcePath": "A String", # The path within the repository where the function is defined. The path 195 # should point to the directory where Cloud Functions files are located. Use 196 # "/" if the function is defined directly in the root directory of a 197 # repository. 198 "deployedRevision": "A String", # Output only. The id of the revision that was resolved at the moment of 199 # function creation or update. For example when a user deployed from a 200 # branch, it will be the revision id of the latest change on this branch at 201 # that time. If user deployed from revision then this value will be always 202 # equal to the revision specified by the user. 203 "tag": "A String", # The name of the tag that captures the state of the repository from 204 # which the function should be fetched. 205 "branch": "A String", # The name of the branch from which the function should be fetched. 206 "revision": "A String", # The id of the revision that captures the state of the repository from 207 # which the function should be fetched. 208 }, 209 "sourceUploadUrl": "A String", # The Google Cloud Storage signed URL used for source uploading, generated 210 # by google.cloud.functions.v1beta2.GenerateUploadUrl 211 "httpsTrigger": { # Describes HTTPSTrigger, could be used to connect web hooks to function. # An HTTPS endpoint type of source that can be triggered via URL. 212 "url": "A String", # Output only. The deployed url for the function. 213 }, 214 "sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with gs://, pointing to the zip 215 # archive which contains the function. 216 "labels": { # Labels associated with this Cloud Function. 217 "a_key": "A String", 218 }, 219 "serviceAccount": "A String", # The email of the function's service account. If empty, defaults to 220 # {project_id}@appspot.gserviceaccount.com. 221 "environmentVariables": { # Environment variables that shall be available during function execution. 222 "a_key": "A String", 223 }, 224 "availableMemoryMb": 42, # The amount of memory in MB available for a function. 225 # Defaults to 256MB. 226 "versionId": "A String", # Output only. 227 # The version identifier of the Cloud Function. Each deployment attempt 228 # results in a new version of a function being created. 229 "entryPoint": "A String", # The name of the function (as defined in source code) that will be 230 # executed. Defaults to the resource name suffix, if not specified. For 231 # backward compatibility, if function with given name is not found, then the 232 # system will try to use function named "function". 233 # For Node.js this is name of a function exported by the module specified 234 # in `source_location`. 235 "timeout": "A String", # The function execution timeout. Execution is considered failed and 236 # can be terminated if the function is not completed at the end of the 237 # timeout period. Defaults to 60 seconds. 238 "latestOperation": "A String", # Output only. Name of the most recent operation modifying the function. If 239 # the function status is `DEPLOYING` or `DELETING`, then it points to the 240 # active operation. 241 "sourceRepositoryUrl": "A String", # The URL pointing to the hosted repository where the function is defined. 242 # There are supported Cloud Source Repository URLs in the following 243 # formats: 244 # 245 # To refer to a specific commit: 246 # `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` 247 # To refer to a moveable alias (branch): 248 # `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*` 249 # In particular, to refer to HEAD use `master` moveable alias. 250 # To refer to a specific fixed alias (tag): 251 # `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*` 252 # 253 # You may omit `paths/*` if you want to use the main directory. 254 "runtime": "A String", # Required. The runtime in which the function is going to run. Choices: 255 # 256 # * `nodejs6`: Node.js 6 257 # * `nodejs8`: Node.js 8 258 # * `nodejs10`: Node.js 10 259 # * `python37`: Python 3.7 260 # * `go111`: Go 1.11 261 "vpcConnector": "A String", # The VPC Network Connector that this cloud function can connect to. It can 262 # be either the fully-qualified URI, or the short name of the network 263 # connector resource. The format of this field is 264 # `projects/*/locations/*/connectors/*` 265 # 266 # This field is mutually exclusive with `network` field and will eventually 267 # replace it. 268 # 269 # See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for 270 # more information on connecting Cloud projects. 271 # 272 # This feature is currently in alpha, available only for whitelisted users. 273 "network": "A String", # The VPC Network that this cloud function can connect to. It can be 274 # either the fully-qualified URI, or the short name of the network resource. 275 # If the short network name is used, the network must belong to the same 276 # project. Otherwise, it must belong to a project within the same 277 # organization. The format of this field is either 278 # `projects/{project}/global/networks/{network}` or `{network}`, where 279 # {project} is a project id where the network is defined, and {network} is 280 # the short name of the network. 281 # 282 # This field is mutually exclusive with `vpc_connector` and will be replaced 283 # by it. 284 # 285 # See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for 286 # more information on connecting Cloud projects. 287 # 288 # This feature is currently in alpha, available only for whitelisted users. 289} 290 291 x__xgafv: string, V1 error format. 292 Allowed values 293 1 - v1 error format 294 2 - v2 error format 295 296Returns: 297 An object of the form: 298 299 { # This resource represents a long-running operation that is the result of a 300 # network API call. 301 "metadata": { # Service-specific metadata associated with the operation. It typically 302 # contains progress information and common metadata such as create time. 303 # Some services might not provide such metadata. Any method that returns a 304 # 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 "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. 308 # different programming environments, including REST APIs and RPC APIs. It is 309 # used by [gRPC](https://github.com/grpc). The error model is designed to be: 310 # 311 # - Simple to use and understand for most users 312 # - Flexible enough to meet unexpected needs 313 # 314 # # Overview 315 # 316 # The `Status` message contains three pieces of data: error code, error 317 # message, and error details. The error code should be an enum value of 318 # google.rpc.Code, but it may accept additional error codes if needed. The 319 # error message should be a developer-facing English message that helps 320 # developers *understand* and *resolve* the error. If a localized user-facing 321 # error message is needed, put the localized message in the error details or 322 # localize it in the client. The optional error details may contain arbitrary 323 # information about the error. There is a predefined set of error detail types 324 # in the package `google.rpc` that can be used for common error conditions. 325 # 326 # # Language mapping 327 # 328 # The `Status` message is the logical representation of the error model, but it 329 # is not necessarily the actual wire format. When the `Status` message is 330 # exposed in different client libraries and different wire protocols, it can be 331 # mapped differently. For example, it will likely be mapped to some exceptions 332 # in Java, but more likely mapped to some error codes in C. 333 # 334 # # Other uses 335 # 336 # The error model and the `Status` message can be used in a variety of 337 # environments, either with or without APIs, to provide a 338 # consistent developer experience across different environments. 339 # 340 # Example uses of this error model include: 341 # 342 # - Partial errors. If a service needs to return partial errors to the client, 343 # it may embed the `Status` in the normal response to indicate the partial 344 # errors. 345 # 346 # - Workflow errors. A typical workflow has multiple steps. Each step may 347 # have a `Status` message for error reporting. 348 # 349 # - Batch operations. If a client uses batch request and batch response, the 350 # `Status` message should be used directly inside batch response, one for 351 # each error sub-response. 352 # 353 # - Asynchronous operations. If an API call embeds asynchronous operation 354 # results in its response, the status of those operations should be 355 # represented directly using the `Status` message. 356 # 357 # - Logging. If some API errors are stored in logs, the message `Status` could 358 # be used directly after any stripping needed for security/privacy reasons. 359 "message": "A String", # A developer-facing error message, which should be in English. Any 360 # user-facing error message should be localized and sent in the 361 # google.rpc.Status.details field, or localized by the client. 362 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 363 "details": [ # A list of messages that carry the error details. There is a common set of 364 # message types for APIs to use. 365 { 366 "a_key": "", # Properties of the object. Contains field @type with type URL. 367 }, 368 ], 369 }, 370 "done": True or False, # If the value is `false`, it means the operation is still in progress. 371 # If `true`, the operation is completed, and either `error` or `response` is 372 # available. 373 "response": { # The normal response of the operation in case of success. If the original 374 # method returns no data on success, such as `Delete`, the response is 375 # `google.protobuf.Empty`. If the original method is standard 376 # `Get`/`Create`/`Update`, the response should be the resource. For other 377 # methods, the response should have the type `XxxResponse`, where `Xxx` 378 # is the original method name. For example, if the original method name 379 # is `TakeSnapshot()`, the inferred response type is 380 # `TakeSnapshotResponse`. 381 "a_key": "", # Properties of the object. Contains field @type with type URL. 382 }, 383 "name": "A String", # The server-assigned name, which is only unique within the same service that 384 # originally returns it. If you use the default HTTP mapping, the 385 # `name` should be a resource name ending with `operations/{unique_id}`. 386 }</pre> 387</div> 388 389<div class="method"> 390 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 391 <pre>Deletes a function with the given name from the specified project. If the 392given function is used by some trigger, the trigger will be updated to 393remove this function. 394 395Args: 396 name: string, The name of the function which should be deleted. (required) 397 x__xgafv: string, V1 error format. 398 Allowed values 399 1 - v1 error format 400 2 - v2 error format 401 402Returns: 403 An object of the form: 404 405 { # This resource represents a long-running operation that is the result of a 406 # network API call. 407 "metadata": { # Service-specific metadata associated with the operation. It typically 408 # contains progress information and common metadata such as create time. 409 # Some services might not provide such metadata. Any method that returns a 410 # long-running operation should document the metadata type, if any. 411 "a_key": "", # Properties of the object. Contains field @type with type URL. 412 }, 413 "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. 414 # different programming environments, including REST APIs and RPC APIs. It is 415 # used by [gRPC](https://github.com/grpc). The error model is designed to be: 416 # 417 # - Simple to use and understand for most users 418 # - Flexible enough to meet unexpected needs 419 # 420 # # Overview 421 # 422 # The `Status` message contains three pieces of data: error code, error 423 # message, and error details. The error code should be an enum value of 424 # google.rpc.Code, but it may accept additional error codes if needed. The 425 # error message should be a developer-facing English message that helps 426 # developers *understand* and *resolve* the error. If a localized user-facing 427 # error message is needed, put the localized message in the error details or 428 # localize it in the client. The optional error details may contain arbitrary 429 # information about the error. There is a predefined set of error detail types 430 # in the package `google.rpc` that can be used for common error conditions. 431 # 432 # # Language mapping 433 # 434 # The `Status` message is the logical representation of the error model, but it 435 # is not necessarily the actual wire format. When the `Status` message is 436 # exposed in different client libraries and different wire protocols, it can be 437 # mapped differently. For example, it will likely be mapped to some exceptions 438 # in Java, but more likely mapped to some error codes in C. 439 # 440 # # Other uses 441 # 442 # The error model and the `Status` message can be used in a variety of 443 # environments, either with or without APIs, to provide a 444 # consistent developer experience across different environments. 445 # 446 # Example uses of this error model include: 447 # 448 # - Partial errors. If a service needs to return partial errors to the client, 449 # it may embed the `Status` in the normal response to indicate the partial 450 # errors. 451 # 452 # - Workflow errors. A typical workflow has multiple steps. Each step may 453 # have a `Status` message for error reporting. 454 # 455 # - Batch operations. If a client uses batch request and batch response, the 456 # `Status` message should be used directly inside batch response, one for 457 # each error sub-response. 458 # 459 # - Asynchronous operations. If an API call embeds asynchronous operation 460 # results in its response, the status of those operations should be 461 # represented directly using the `Status` message. 462 # 463 # - Logging. If some API errors are stored in logs, the message `Status` could 464 # be used directly after any stripping needed for security/privacy reasons. 465 "message": "A String", # A developer-facing error message, which should be in English. Any 466 # user-facing error message should be localized and sent in the 467 # google.rpc.Status.details field, or localized by the client. 468 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 469 "details": [ # A list of messages that carry the error details. There is a common set of 470 # message types for APIs to use. 471 { 472 "a_key": "", # Properties of the object. Contains field @type with type URL. 473 }, 474 ], 475 }, 476 "done": True or False, # If the value is `false`, it means the operation is still in progress. 477 # If `true`, the operation is completed, and either `error` or `response` is 478 # available. 479 "response": { # The normal response of the operation in case of success. If the original 480 # method returns no data on success, such as `Delete`, the response is 481 # `google.protobuf.Empty`. If the original method is standard 482 # `Get`/`Create`/`Update`, the response should be the resource. For other 483 # methods, the response should have the type `XxxResponse`, where `Xxx` 484 # is the original method name. For example, if the original method name 485 # is `TakeSnapshot()`, the inferred response type is 486 # `TakeSnapshotResponse`. 487 "a_key": "", # Properties of the object. Contains field @type with type URL. 488 }, 489 "name": "A String", # The server-assigned name, which is only unique within the same service that 490 # originally returns it. If you use the default HTTP mapping, the 491 # `name` should be a resource name ending with `operations/{unique_id}`. 492 }</pre> 493</div> 494 495<div class="method"> 496 <code class="details" id="generateDownloadUrl">generateDownloadUrl(name, body, x__xgafv=None)</code> 497 <pre>Returns a signed URL for downloading deployed function source code. 498The URL is only valid for a limited period and should be used within 499minutes after generation. 500For more information about the signed URL usage see: 501https://cloud.google.com/storage/docs/access-control/signed-urls 502 503Args: 504 name: string, The name of function for which source code Google Cloud Storage signed 505URL should be generated. (required) 506 body: object, The request body. (required) 507 The object takes the form of: 508 509{ # Request of `GenerateDownloadUrl` method. 510 "versionId": "A String", # The optional version of function. 511 } 512 513 x__xgafv: string, V1 error format. 514 Allowed values 515 1 - v1 error format 516 2 - v2 error format 517 518Returns: 519 An object of the form: 520 521 { # Response of `GenerateDownloadUrl` method. 522 "downloadUrl": "A String", # The generated Google Cloud Storage signed URL that should be used for 523 # function source code download. 524 }</pre> 525</div> 526 527<div class="method"> 528 <code class="details" id="generateUploadUrl">generateUploadUrl(parent, body=None, x__xgafv=None)</code> 529 <pre>Returns a signed URL for uploading a function source code. 530For more information about the signed URL usage see: 531https://cloud.google.com/storage/docs/access-control/signed-urls 532Once the function source code upload is complete, the used signed 533URL should be provided in CreateFunction or UpdateFunction request 534as a reference to the function source code. 535 536When uploading source code to the generated signed URL, please follow 537these restrictions: 538 539* Source file type should be a zip file. 540* Source file size should not exceed 100MB limit. 541* No credentials should be attached - the signed URLs provide access to the 542 target bucket using internal service identity; if credentials were 543 attached, the identity from the credentials would be used, but that 544 identity does not have permissions to upload files to the URL. 545 546When making a HTTP PUT request, these two headers need to be specified: 547 548* `content-type: application/zip` 549* `x-goog-content-length-range: 0,104857600` 550 551And this header SHOULD NOT be specified: 552 553* `Authorization: Bearer YOUR_TOKEN` 554 555Args: 556 parent: string, The project and location in which the Google Cloud Storage signed URL 557should be generated, specified in the format `projects/*/locations/*`. (required) 558 body: object, The request body. 559 The object takes the form of: 560 561{ # Request of `GenerateUploadUrl` method. 562 } 563 564 x__xgafv: string, V1 error format. 565 Allowed values 566 1 - v1 error format 567 2 - v2 error format 568 569Returns: 570 An object of the form: 571 572 { # Response of `GenerateUploadUrl` method. 573 "uploadUrl": "A String", # The generated Google Cloud Storage signed URL that should be used for a 574 # function source code upload. The uploaded file should be a zip archive 575 # which contains a function. 576 }</pre> 577</div> 578 579<div class="method"> 580 <code class="details" id="get">get(name, x__xgafv=None)</code> 581 <pre>Returns a function with the given name from the requested project. 582 583Args: 584 name: string, The name of the function which details should be obtained. (required) 585 x__xgafv: string, V1 error format. 586 Allowed values 587 1 - v1 error format 588 2 - v2 error format 589 590Returns: 591 An object of the form: 592 593 { # Describes a Cloud Function that contains user computation executed in 594 # response to an event. It encapsulate function and triggers configurations. 595 "status": "A String", # Output only. Status of the function deployment. 596 "eventTrigger": { # Describes EventTrigger, used to request events be sent from another # A source that fires events in response to a condition in another service. 597 # service. 598 "eventType": "A String", # `event_type` names contain the service that is sending an event and the 599 # kind of event that was fired. Must be of the form 600 # `providers/*/eventTypes/*` e.g. Directly handle a Message published to 601 # Google Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish`. 602 # 603 # Handle an object changing in Google Cloud Storage: 604 # `providers/cloud.storage/eventTypes/object.change` 605 # 606 # Handle a write to the Firebase Realtime Database: 607 # `providers/google.firebase.database/eventTypes/ref.write` 608 "resource": "A String", # Which instance of the source's service should send events. E.g. for Pub/Sub 609 # this would be a Pub/Sub topic at `projects/*/topics/*`. For Google Cloud 610 # Storage this would be a bucket at `projects/*/buckets/*`. For any source 611 # that only supports one instance per-project, this should be the name of the 612 # project (`projects/*`) 613 "service": "A String", # The hostname of the service that should be observed. 614 # 615 # If no string is provided, the default service implementing the API will 616 # be used. For example, `storage.googleapis.com` is the default for all 617 # event types in the `google.storage` namespace. 618 "failurePolicy": { # Describes the policy in case of function's execution failure. # Specifies policy for failed executions. 619 # If empty, then defaults to ignoring failures (i.e. not retrying them). 620 "retry": { # Describes the retry policy in case of function's execution failure. # If specified, then the function will be retried in case of a failure. 621 # A function execution will be retried on any failure. 622 # A failed execution will be retried up to 7 days with an exponential backoff 623 # (capped at 10 seconds). 624 # Retried execution is charged as any other execution. 625 }, 626 }, 627 }, 628 "updateTime": "A String", # Output only. The last update timestamp of a Cloud Function. 629 "name": "A String", # A user-defined name of the function. Function names must be unique 630 # globally and match pattern `projects/*/locations/*/functions/*` 631 "maxInstances": 42, # The limit on the maximum number of function instances that may coexist at a 632 # given time. 633 "sourceRepository": { # Describes the location of the function source in a remote repository. # The hosted repository where the function is defined. 634 "repositoryUrl": "A String", # URL to the hosted repository where the function is defined. Only paths in 635 # https://source.developers.google.com domain are supported. The path should 636 # contain the name of the repository. 637 "sourcePath": "A String", # The path within the repository where the function is defined. The path 638 # should point to the directory where Cloud Functions files are located. Use 639 # "/" if the function is defined directly in the root directory of a 640 # repository. 641 "deployedRevision": "A String", # Output only. The id of the revision that was resolved at the moment of 642 # function creation or update. For example when a user deployed from a 643 # branch, it will be the revision id of the latest change on this branch at 644 # that time. If user deployed from revision then this value will be always 645 # equal to the revision specified by the user. 646 "tag": "A String", # The name of the tag that captures the state of the repository from 647 # which the function should be fetched. 648 "branch": "A String", # The name of the branch from which the function should be fetched. 649 "revision": "A String", # The id of the revision that captures the state of the repository from 650 # which the function should be fetched. 651 }, 652 "sourceUploadUrl": "A String", # The Google Cloud Storage signed URL used for source uploading, generated 653 # by google.cloud.functions.v1beta2.GenerateUploadUrl 654 "httpsTrigger": { # Describes HTTPSTrigger, could be used to connect web hooks to function. # An HTTPS endpoint type of source that can be triggered via URL. 655 "url": "A String", # Output only. The deployed url for the function. 656 }, 657 "sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with gs://, pointing to the zip 658 # archive which contains the function. 659 "labels": { # Labels associated with this Cloud Function. 660 "a_key": "A String", 661 }, 662 "serviceAccount": "A String", # The email of the function's service account. If empty, defaults to 663 # {project_id}@appspot.gserviceaccount.com. 664 "environmentVariables": { # Environment variables that shall be available during function execution. 665 "a_key": "A String", 666 }, 667 "availableMemoryMb": 42, # The amount of memory in MB available for a function. 668 # Defaults to 256MB. 669 "versionId": "A String", # Output only. 670 # The version identifier of the Cloud Function. Each deployment attempt 671 # results in a new version of a function being created. 672 "entryPoint": "A String", # The name of the function (as defined in source code) that will be 673 # executed. Defaults to the resource name suffix, if not specified. For 674 # backward compatibility, if function with given name is not found, then the 675 # system will try to use function named "function". 676 # For Node.js this is name of a function exported by the module specified 677 # in `source_location`. 678 "timeout": "A String", # The function execution timeout. Execution is considered failed and 679 # can be terminated if the function is not completed at the end of the 680 # timeout period. Defaults to 60 seconds. 681 "latestOperation": "A String", # Output only. Name of the most recent operation modifying the function. If 682 # the function status is `DEPLOYING` or `DELETING`, then it points to the 683 # active operation. 684 "sourceRepositoryUrl": "A String", # The URL pointing to the hosted repository where the function is defined. 685 # There are supported Cloud Source Repository URLs in the following 686 # formats: 687 # 688 # To refer to a specific commit: 689 # `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` 690 # To refer to a moveable alias (branch): 691 # `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*` 692 # In particular, to refer to HEAD use `master` moveable alias. 693 # To refer to a specific fixed alias (tag): 694 # `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*` 695 # 696 # You may omit `paths/*` if you want to use the main directory. 697 "runtime": "A String", # Required. The runtime in which the function is going to run. Choices: 698 # 699 # * `nodejs6`: Node.js 6 700 # * `nodejs8`: Node.js 8 701 # * `nodejs10`: Node.js 10 702 # * `python37`: Python 3.7 703 # * `go111`: Go 1.11 704 "vpcConnector": "A String", # The VPC Network Connector that this cloud function can connect to. It can 705 # be either the fully-qualified URI, or the short name of the network 706 # connector resource. The format of this field is 707 # `projects/*/locations/*/connectors/*` 708 # 709 # This field is mutually exclusive with `network` field and will eventually 710 # replace it. 711 # 712 # See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for 713 # more information on connecting Cloud projects. 714 # 715 # This feature is currently in alpha, available only for whitelisted users. 716 "network": "A String", # The VPC Network that this cloud function can connect to. It can be 717 # either the fully-qualified URI, or the short name of the network resource. 718 # If the short network name is used, the network must belong to the same 719 # project. Otherwise, it must belong to a project within the same 720 # organization. The format of this field is either 721 # `projects/{project}/global/networks/{network}` or `{network}`, where 722 # {project} is a project id where the network is defined, and {network} is 723 # the short name of the network. 724 # 725 # This field is mutually exclusive with `vpc_connector` and will be replaced 726 # by it. 727 # 728 # See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for 729 # more information on connecting Cloud projects. 730 # 731 # This feature is currently in alpha, available only for whitelisted users. 732 }</pre> 733</div> 734 735<div class="method"> 736 <code class="details" id="list">list(location, pageSize=None, pageToken=None, x__xgafv=None)</code> 737 <pre>Returns a list of functions that belong to the requested project. 738 739Args: 740 location: string, The project and location from which the function should be listed, 741specified in the format `projects/*/locations/*` 742If you want to list functions in all locations, use "-" in place of a 743location. (required) 744 pageSize: integer, Maximum number of functions to return per call. 745 pageToken: string, The value returned by the last 746`ListFunctionsResponse`; indicates that 747this is a continuation of a prior `ListFunctions` call, and that the 748system should return the next page of data. 749 x__xgafv: string, V1 error format. 750 Allowed values 751 1 - v1 error format 752 2 - v2 error format 753 754Returns: 755 An object of the form: 756 757 { # Response for the `ListFunctions` method. 758 "nextPageToken": "A String", # If not empty, indicates that there may be more functions that match 759 # the request; this value should be passed in a new 760 # google.cloud.functions.v1beta2.ListFunctionsRequest 761 # to get more functions. 762 "functions": [ # The functions that match the request. 763 { # Describes a Cloud Function that contains user computation executed in 764 # response to an event. It encapsulate function and triggers configurations. 765 "status": "A String", # Output only. Status of the function deployment. 766 "eventTrigger": { # Describes EventTrigger, used to request events be sent from another # A source that fires events in response to a condition in another service. 767 # service. 768 "eventType": "A String", # `event_type` names contain the service that is sending an event and the 769 # kind of event that was fired. Must be of the form 770 # `providers/*/eventTypes/*` e.g. Directly handle a Message published to 771 # Google Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish`. 772 # 773 # Handle an object changing in Google Cloud Storage: 774 # `providers/cloud.storage/eventTypes/object.change` 775 # 776 # Handle a write to the Firebase Realtime Database: 777 # `providers/google.firebase.database/eventTypes/ref.write` 778 "resource": "A String", # Which instance of the source's service should send events. E.g. for Pub/Sub 779 # this would be a Pub/Sub topic at `projects/*/topics/*`. For Google Cloud 780 # Storage this would be a bucket at `projects/*/buckets/*`. For any source 781 # that only supports one instance per-project, this should be the name of the 782 # project (`projects/*`) 783 "service": "A String", # The hostname of the service that should be observed. 784 # 785 # If no string is provided, the default service implementing the API will 786 # be used. For example, `storage.googleapis.com` is the default for all 787 # event types in the `google.storage` namespace. 788 "failurePolicy": { # Describes the policy in case of function's execution failure. # Specifies policy for failed executions. 789 # If empty, then defaults to ignoring failures (i.e. not retrying them). 790 "retry": { # Describes the retry policy in case of function's execution failure. # If specified, then the function will be retried in case of a failure. 791 # A function execution will be retried on any failure. 792 # A failed execution will be retried up to 7 days with an exponential backoff 793 # (capped at 10 seconds). 794 # Retried execution is charged as any other execution. 795 }, 796 }, 797 }, 798 "updateTime": "A String", # Output only. The last update timestamp of a Cloud Function. 799 "name": "A String", # A user-defined name of the function. Function names must be unique 800 # globally and match pattern `projects/*/locations/*/functions/*` 801 "maxInstances": 42, # The limit on the maximum number of function instances that may coexist at a 802 # given time. 803 "sourceRepository": { # Describes the location of the function source in a remote repository. # The hosted repository where the function is defined. 804 "repositoryUrl": "A String", # URL to the hosted repository where the function is defined. Only paths in 805 # https://source.developers.google.com domain are supported. The path should 806 # contain the name of the repository. 807 "sourcePath": "A String", # The path within the repository where the function is defined. The path 808 # should point to the directory where Cloud Functions files are located. Use 809 # "/" if the function is defined directly in the root directory of a 810 # repository. 811 "deployedRevision": "A String", # Output only. The id of the revision that was resolved at the moment of 812 # function creation or update. For example when a user deployed from a 813 # branch, it will be the revision id of the latest change on this branch at 814 # that time. If user deployed from revision then this value will be always 815 # equal to the revision specified by the user. 816 "tag": "A String", # The name of the tag that captures the state of the repository from 817 # which the function should be fetched. 818 "branch": "A String", # The name of the branch from which the function should be fetched. 819 "revision": "A String", # The id of the revision that captures the state of the repository from 820 # which the function should be fetched. 821 }, 822 "sourceUploadUrl": "A String", # The Google Cloud Storage signed URL used for source uploading, generated 823 # by google.cloud.functions.v1beta2.GenerateUploadUrl 824 "httpsTrigger": { # Describes HTTPSTrigger, could be used to connect web hooks to function. # An HTTPS endpoint type of source that can be triggered via URL. 825 "url": "A String", # Output only. The deployed url for the function. 826 }, 827 "sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with gs://, pointing to the zip 828 # archive which contains the function. 829 "labels": { # Labels associated with this Cloud Function. 830 "a_key": "A String", 831 }, 832 "serviceAccount": "A String", # The email of the function's service account. If empty, defaults to 833 # {project_id}@appspot.gserviceaccount.com. 834 "environmentVariables": { # Environment variables that shall be available during function execution. 835 "a_key": "A String", 836 }, 837 "availableMemoryMb": 42, # The amount of memory in MB available for a function. 838 # Defaults to 256MB. 839 "versionId": "A String", # Output only. 840 # The version identifier of the Cloud Function. Each deployment attempt 841 # results in a new version of a function being created. 842 "entryPoint": "A String", # The name of the function (as defined in source code) that will be 843 # executed. Defaults to the resource name suffix, if not specified. For 844 # backward compatibility, if function with given name is not found, then the 845 # system will try to use function named "function". 846 # For Node.js this is name of a function exported by the module specified 847 # in `source_location`. 848 "timeout": "A String", # The function execution timeout. Execution is considered failed and 849 # can be terminated if the function is not completed at the end of the 850 # timeout period. Defaults to 60 seconds. 851 "latestOperation": "A String", # Output only. Name of the most recent operation modifying the function. If 852 # the function status is `DEPLOYING` or `DELETING`, then it points to the 853 # active operation. 854 "sourceRepositoryUrl": "A String", # The URL pointing to the hosted repository where the function is defined. 855 # There are supported Cloud Source Repository URLs in the following 856 # formats: 857 # 858 # To refer to a specific commit: 859 # `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` 860 # To refer to a moveable alias (branch): 861 # `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*` 862 # In particular, to refer to HEAD use `master` moveable alias. 863 # To refer to a specific fixed alias (tag): 864 # `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*` 865 # 866 # You may omit `paths/*` if you want to use the main directory. 867 "runtime": "A String", # Required. The runtime in which the function is going to run. Choices: 868 # 869 # * `nodejs6`: Node.js 6 870 # * `nodejs8`: Node.js 8 871 # * `nodejs10`: Node.js 10 872 # * `python37`: Python 3.7 873 # * `go111`: Go 1.11 874 "vpcConnector": "A String", # The VPC Network Connector that this cloud function can connect to. It can 875 # be either the fully-qualified URI, or the short name of the network 876 # connector resource. The format of this field is 877 # `projects/*/locations/*/connectors/*` 878 # 879 # This field is mutually exclusive with `network` field and will eventually 880 # replace it. 881 # 882 # See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for 883 # more information on connecting Cloud projects. 884 # 885 # This feature is currently in alpha, available only for whitelisted users. 886 "network": "A String", # The VPC Network that this cloud function can connect to. It can be 887 # either the fully-qualified URI, or the short name of the network resource. 888 # If the short network name is used, the network must belong to the same 889 # project. Otherwise, it must belong to a project within the same 890 # organization. The format of this field is either 891 # `projects/{project}/global/networks/{network}` or `{network}`, where 892 # {project} is a project id where the network is defined, and {network} is 893 # the short name of the network. 894 # 895 # This field is mutually exclusive with `vpc_connector` and will be replaced 896 # by it. 897 # 898 # See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for 899 # more information on connecting Cloud projects. 900 # 901 # This feature is currently in alpha, available only for whitelisted users. 902 }, 903 ], 904 }</pre> 905</div> 906 907<div class="method"> 908 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 909 <pre>Retrieves the next page of results. 910 911Args: 912 previous_request: The request for the previous page. (required) 913 previous_response: The response from the request for the previous page. (required) 914 915Returns: 916 A request object that you can call 'execute()' on to request the next 917 page. Returns None if there are no more items in the collection. 918 </pre> 919</div> 920 921<div class="method"> 922 <code class="details" id="update">update(name, body, x__xgafv=None)</code> 923 <pre>Updates existing function. 924 925Args: 926 name: string, The name of the function to be updated. (required) 927 body: object, The request body. (required) 928 The object takes the form of: 929 930{ # Describes a Cloud Function that contains user computation executed in 931 # response to an event. It encapsulate function and triggers configurations. 932 "status": "A String", # Output only. Status of the function deployment. 933 "eventTrigger": { # Describes EventTrigger, used to request events be sent from another # A source that fires events in response to a condition in another service. 934 # service. 935 "eventType": "A String", # `event_type` names contain the service that is sending an event and the 936 # kind of event that was fired. Must be of the form 937 # `providers/*/eventTypes/*` e.g. Directly handle a Message published to 938 # Google Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish`. 939 # 940 # Handle an object changing in Google Cloud Storage: 941 # `providers/cloud.storage/eventTypes/object.change` 942 # 943 # Handle a write to the Firebase Realtime Database: 944 # `providers/google.firebase.database/eventTypes/ref.write` 945 "resource": "A String", # Which instance of the source's service should send events. E.g. for Pub/Sub 946 # this would be a Pub/Sub topic at `projects/*/topics/*`. For Google Cloud 947 # Storage this would be a bucket at `projects/*/buckets/*`. For any source 948 # that only supports one instance per-project, this should be the name of the 949 # project (`projects/*`) 950 "service": "A String", # The hostname of the service that should be observed. 951 # 952 # If no string is provided, the default service implementing the API will 953 # be used. For example, `storage.googleapis.com` is the default for all 954 # event types in the `google.storage` namespace. 955 "failurePolicy": { # Describes the policy in case of function's execution failure. # Specifies policy for failed executions. 956 # If empty, then defaults to ignoring failures (i.e. not retrying them). 957 "retry": { # Describes the retry policy in case of function's execution failure. # If specified, then the function will be retried in case of a failure. 958 # A function execution will be retried on any failure. 959 # A failed execution will be retried up to 7 days with an exponential backoff 960 # (capped at 10 seconds). 961 # Retried execution is charged as any other execution. 962 }, 963 }, 964 }, 965 "updateTime": "A String", # Output only. The last update timestamp of a Cloud Function. 966 "name": "A String", # A user-defined name of the function. Function names must be unique 967 # globally and match pattern `projects/*/locations/*/functions/*` 968 "maxInstances": 42, # The limit on the maximum number of function instances that may coexist at a 969 # given time. 970 "sourceRepository": { # Describes the location of the function source in a remote repository. # The hosted repository where the function is defined. 971 "repositoryUrl": "A String", # URL to the hosted repository where the function is defined. Only paths in 972 # https://source.developers.google.com domain are supported. The path should 973 # contain the name of the repository. 974 "sourcePath": "A String", # The path within the repository where the function is defined. The path 975 # should point to the directory where Cloud Functions files are located. Use 976 # "/" if the function is defined directly in the root directory of a 977 # repository. 978 "deployedRevision": "A String", # Output only. The id of the revision that was resolved at the moment of 979 # function creation or update. For example when a user deployed from a 980 # branch, it will be the revision id of the latest change on this branch at 981 # that time. If user deployed from revision then this value will be always 982 # equal to the revision specified by the user. 983 "tag": "A String", # The name of the tag that captures the state of the repository from 984 # which the function should be fetched. 985 "branch": "A String", # The name of the branch from which the function should be fetched. 986 "revision": "A String", # The id of the revision that captures the state of the repository from 987 # which the function should be fetched. 988 }, 989 "sourceUploadUrl": "A String", # The Google Cloud Storage signed URL used for source uploading, generated 990 # by google.cloud.functions.v1beta2.GenerateUploadUrl 991 "httpsTrigger": { # Describes HTTPSTrigger, could be used to connect web hooks to function. # An HTTPS endpoint type of source that can be triggered via URL. 992 "url": "A String", # Output only. The deployed url for the function. 993 }, 994 "sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with gs://, pointing to the zip 995 # archive which contains the function. 996 "labels": { # Labels associated with this Cloud Function. 997 "a_key": "A String", 998 }, 999 "serviceAccount": "A String", # The email of the function's service account. If empty, defaults to 1000 # {project_id}@appspot.gserviceaccount.com. 1001 "environmentVariables": { # Environment variables that shall be available during function execution. 1002 "a_key": "A String", 1003 }, 1004 "availableMemoryMb": 42, # The amount of memory in MB available for a function. 1005 # Defaults to 256MB. 1006 "versionId": "A String", # Output only. 1007 # The version identifier of the Cloud Function. Each deployment attempt 1008 # results in a new version of a function being created. 1009 "entryPoint": "A String", # The name of the function (as defined in source code) that will be 1010 # executed. Defaults to the resource name suffix, if not specified. For 1011 # backward compatibility, if function with given name is not found, then the 1012 # system will try to use function named "function". 1013 # For Node.js this is name of a function exported by the module specified 1014 # in `source_location`. 1015 "timeout": "A String", # The function execution timeout. Execution is considered failed and 1016 # can be terminated if the function is not completed at the end of the 1017 # timeout period. Defaults to 60 seconds. 1018 "latestOperation": "A String", # Output only. Name of the most recent operation modifying the function. If 1019 # the function status is `DEPLOYING` or `DELETING`, then it points to the 1020 # active operation. 1021 "sourceRepositoryUrl": "A String", # The URL pointing to the hosted repository where the function is defined. 1022 # There are supported Cloud Source Repository URLs in the following 1023 # formats: 1024 # 1025 # To refer to a specific commit: 1026 # `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` 1027 # To refer to a moveable alias (branch): 1028 # `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*` 1029 # In particular, to refer to HEAD use `master` moveable alias. 1030 # To refer to a specific fixed alias (tag): 1031 # `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*` 1032 # 1033 # You may omit `paths/*` if you want to use the main directory. 1034 "runtime": "A String", # Required. The runtime in which the function is going to run. Choices: 1035 # 1036 # * `nodejs6`: Node.js 6 1037 # * `nodejs8`: Node.js 8 1038 # * `nodejs10`: Node.js 10 1039 # * `python37`: Python 3.7 1040 # * `go111`: Go 1.11 1041 "vpcConnector": "A String", # The VPC Network Connector that this cloud function can connect to. It can 1042 # be either the fully-qualified URI, or the short name of the network 1043 # connector resource. The format of this field is 1044 # `projects/*/locations/*/connectors/*` 1045 # 1046 # This field is mutually exclusive with `network` field and will eventually 1047 # replace it. 1048 # 1049 # See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for 1050 # more information on connecting Cloud projects. 1051 # 1052 # This feature is currently in alpha, available only for whitelisted users. 1053 "network": "A String", # The VPC Network that this cloud function can connect to. It can be 1054 # either the fully-qualified URI, or the short name of the network resource. 1055 # If the short network name is used, the network must belong to the same 1056 # project. Otherwise, it must belong to a project within the same 1057 # organization. The format of this field is either 1058 # `projects/{project}/global/networks/{network}` or `{network}`, where 1059 # {project} is a project id where the network is defined, and {network} is 1060 # the short name of the network. 1061 # 1062 # This field is mutually exclusive with `vpc_connector` and will be replaced 1063 # by it. 1064 # 1065 # See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for 1066 # more information on connecting Cloud projects. 1067 # 1068 # This feature is currently in alpha, available only for whitelisted users. 1069} 1070 1071 x__xgafv: string, V1 error format. 1072 Allowed values 1073 1 - v1 error format 1074 2 - v2 error format 1075 1076Returns: 1077 An object of the form: 1078 1079 { # This resource represents a long-running operation that is the result of a 1080 # network API call. 1081 "metadata": { # Service-specific metadata associated with the operation. It typically 1082 # contains progress information and common metadata such as create time. 1083 # Some services might not provide such metadata. Any method that returns a 1084 # long-running operation should document the metadata type, if any. 1085 "a_key": "", # Properties of the object. Contains field @type with type URL. 1086 }, 1087 "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. 1088 # different programming environments, including REST APIs and RPC APIs. It is 1089 # used by [gRPC](https://github.com/grpc). The error model is designed to be: 1090 # 1091 # - Simple to use and understand for most users 1092 # - Flexible enough to meet unexpected needs 1093 # 1094 # # Overview 1095 # 1096 # The `Status` message contains three pieces of data: error code, error 1097 # message, and error details. The error code should be an enum value of 1098 # google.rpc.Code, but it may accept additional error codes if needed. The 1099 # error message should be a developer-facing English message that helps 1100 # developers *understand* and *resolve* the error. If a localized user-facing 1101 # error message is needed, put the localized message in the error details or 1102 # localize it in the client. The optional error details may contain arbitrary 1103 # information about the error. There is a predefined set of error detail types 1104 # in the package `google.rpc` that can be used for common error conditions. 1105 # 1106 # # Language mapping 1107 # 1108 # The `Status` message is the logical representation of the error model, but it 1109 # is not necessarily the actual wire format. When the `Status` message is 1110 # exposed in different client libraries and different wire protocols, it can be 1111 # mapped differently. For example, it will likely be mapped to some exceptions 1112 # in Java, but more likely mapped to some error codes in C. 1113 # 1114 # # Other uses 1115 # 1116 # The error model and the `Status` message can be used in a variety of 1117 # environments, either with or without APIs, to provide a 1118 # consistent developer experience across different environments. 1119 # 1120 # Example uses of this error model include: 1121 # 1122 # - Partial errors. If a service needs to return partial errors to the client, 1123 # it may embed the `Status` in the normal response to indicate the partial 1124 # errors. 1125 # 1126 # - Workflow errors. A typical workflow has multiple steps. Each step may 1127 # have a `Status` message for error reporting. 1128 # 1129 # - Batch operations. If a client uses batch request and batch response, the 1130 # `Status` message should be used directly inside batch response, one for 1131 # each error sub-response. 1132 # 1133 # - Asynchronous operations. If an API call embeds asynchronous operation 1134 # results in its response, the status of those operations should be 1135 # represented directly using the `Status` message. 1136 # 1137 # - Logging. If some API errors are stored in logs, the message `Status` could 1138 # be used directly after any stripping needed for security/privacy reasons. 1139 "message": "A String", # A developer-facing error message, which should be in English. Any 1140 # user-facing error message should be localized and sent in the 1141 # google.rpc.Status.details field, or localized by the client. 1142 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 1143 "details": [ # A list of messages that carry the error details. There is a common set of 1144 # message types for APIs to use. 1145 { 1146 "a_key": "", # Properties of the object. Contains field @type with type URL. 1147 }, 1148 ], 1149 }, 1150 "done": True or False, # If the value is `false`, it means the operation is still in progress. 1151 # If `true`, the operation is completed, and either `error` or `response` is 1152 # available. 1153 "response": { # The normal response of the operation in case of success. If the original 1154 # method returns no data on success, such as `Delete`, the response is 1155 # `google.protobuf.Empty`. If the original method is standard 1156 # `Get`/`Create`/`Update`, the response should be the resource. For other 1157 # methods, the response should have the type `XxxResponse`, where `Xxx` 1158 # is the original method name. For example, if the original method name 1159 # is `TakeSnapshot()`, the inferred response type is 1160 # `TakeSnapshotResponse`. 1161 "a_key": "", # Properties of the object. Contains field @type with type URL. 1162 }, 1163 "name": "A String", # The server-assigned name, which is only unique within the same service that 1164 # originally returns it. If you use the default HTTP mapping, the 1165 # `name` should be a resource name ending with `operations/{unique_id}`. 1166 }</pre> 1167</div> 1168 1169</body></html>