| <html><body> | |
| <style> | |
| body, h1, h2, h3, div, span, p, pre, a { | |
| margin: 0; | |
| padding: 0; | |
| border: 0; | |
| font-weight: inherit; | |
| font-style: inherit; | |
| font-size: 100%; | |
| font-family: inherit; | |
| vertical-align: baseline; | |
| } | |
| body { | |
| font-size: 13px; | |
| padding: 1em; | |
| } | |
| h1 { | |
| font-size: 26px; | |
| margin-bottom: 1em; | |
| } | |
| h2 { | |
| font-size: 24px; | |
| margin-bottom: 1em; | |
| } | |
| h3 { | |
| font-size: 20px; | |
| margin-bottom: 1em; | |
| margin-top: 1em; | |
| } | |
| pre, code { | |
| line-height: 1.5; | |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; | |
| } | |
| pre { | |
| margin-top: 0.5em; | |
| } | |
| h1, h2, h3, p { | |
| font-family: Arial, sans serif; | |
| } | |
| h1, h2, h3 { | |
| border-bottom: solid #CCC 1px; | |
| } | |
| .toc_element { | |
| margin-top: 0.5em; | |
| } | |
| .firstline { | |
| margin-left: 2 em; | |
| } | |
| .method { | |
| margin-top: 1em; | |
| border: solid 1px #CCC; | |
| padding: 1em; | |
| background: #EEE; | |
| } | |
| .details { | |
| font-weight: bold; | |
| font-size: 14px; | |
| } | |
| </style> | |
| <h1><a href="cloudfunctions_v1beta2.html">Google 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> | |
| <h2>Instance Methods</h2> | |
| <p class="toc_element"> | |
| <code><a href="#call">call(name, body, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Invokes synchronously deployed function. To be used for testing, very</p> | |
| <p class="toc_element"> | |
| <code><a href="#create">create(location, body, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Creates a new function. If a function with the given name already exists in</p> | |
| <p class="toc_element"> | |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Deletes a function with the given name from the specified project. If the</p> | |
| <p class="toc_element"> | |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Returns a function with the given name from the requested project.</p> | |
| <p class="toc_element"> | |
| <code><a href="#list">list(location, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Returns a list of functions that belong to the requested project.</p> | |
| <p class="toc_element"> | |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> | |
| <p class="firstline">Retrieves the next page of results.</p> | |
| <p class="toc_element"> | |
| <code><a href="#update">update(name, body, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Updates existing function.</p> | |
| <h3>Method Details</h3> | |
| <div class="method"> | |
| <code class="details" id="call">call(name, body, x__xgafv=None)</code> | |
| <pre>Invokes synchronously deployed function. To be used for testing, very | |
| limited traffic allowed. | |
| Args: | |
| name: string, The name of the function to be called. (required) | |
| body: object, The request body. (required) | |
| The object takes the form of: | |
| { # Request for the `CallFunction` method. | |
| "data": "A String", # Input to be passed to the function. | |
| } | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Response of `CallFunction` method. | |
| "executionId": "A String", # Execution id of function invocation. | |
| "result": "A String", # Result populated for successful execution of synchronous function. Will | |
| # not be populated if function does not return a result through context. | |
| "error": "A String", # Either system or user-function generated error. Set if execution | |
| # was not successful. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="create">create(location, body, x__xgafv=None)</code> | |
| <pre>Creates a new function. If a function with the given name already exists in | |
| the specified project, the long running operation will return | |
| `ALREADY_EXISTS` error. | |
| Args: | |
| location: string, The project and location in which the function should be created, specified | |
| in the format `projects/*/locations/*` (required) | |
| body: object, The request body. (required) | |
| The object takes the form of: | |
| { # Describes a Cloud Function that contains user computation executed in | |
| # response to an event. It encapsulate function and triggers configurations. | |
| "eventTrigger": { # Describes EventTrigger, used to request events be sent from another # A source that fires events in response to a condition in another service. | |
| # service. | |
| "eventType": "A String", # `event_type` names contain the service that is sending an event and the | |
| # kind of event that was fired. Must be of the form | |
| # `providers/*/eventTypes/*` e.g. Directly handle a Message published to | |
| # Google Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish` | |
| # | |
| # Handle an object changing in Google Cloud Storage | |
| # `providers/cloud.storage/eventTypes/object.change` | |
| # | |
| # Handle a write to the Firebase Realtime Database | |
| # `providers/firebase.database/eventTypes/data.write` | |
| "resource": "A String", # Which instance of the source's service should send events. E.g. for Pub/Sub | |
| # this would be a Pub/Sub topic at `projects/*/topics/*`. For Google Cloud | |
| # Storage this would be a bucket at `projects/*/buckets/*`. For any source | |
| # that only supports one instance per-project, this should be the name of the | |
| # project (`projects/*`) | |
| }, | |
| "status": "A String", # Output only. Status of the function deployment. | |
| "updateTime": "A String", # Output only. The last update timestamp of a Cloud Function. | |
| "name": "A String", # A user-defined name of the function. Function names must be unique | |
| # globally and match pattern `projects/*/locations/*/functions/*` | |
| "sourceRepository": { # Describes the location of the function source in a remote repository. # The hosted repository where the function is defined. | |
| "repositoryUrl": "A String", # URL to the hosted repository where the function is defined. Only paths in | |
| # https://source.developers.google.com domain are supported. The path should | |
| # contain the name of the repository. | |
| "sourcePath": "A String", # The path within the repository where the function is defined. The path | |
| # should point to the directory where Cloud Functions files are located. Use | |
| # "/" if the function is defined directly in the root directory of a | |
| # repository. | |
| "deployedRevision": "A String", # Output only. The id of the revision that was resolved at the moment of | |
| # function creation or update. For example when a user deployed from a | |
| # branch, it will be the revision id of the latest change on this branch at | |
| # that time. If user deployed from revision then this value will be always | |
| # equal to the revision specified by the user. | |
| "tag": "A String", # The name of the tag that captures the state of the repository from | |
| # which the function should be fetched. | |
| "branch": "A String", # The name of the branch from which the function should be fetched. | |
| "revision": "A String", # The id of the revision that captures the state of the repository from | |
| # which the function should be fetched. | |
| }, | |
| "availableMemoryMb": 42, # The amount of memory in MB available for a function. | |
| # Defaults to 256MB. | |
| "httpsTrigger": { # Describes HTTPSTrigger, could be used to connect web hooks to function. # An HTTPS endpoint type of source that can be triggered via URL. | |
| "url": "A String", # Output only. The deployed url for the function. | |
| }, | |
| "sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with gs://, pointing to the zip | |
| # archive which contains the function. | |
| "serviceAccount": "A String", # Output only. The service account of the function. | |
| "entryPoint": "A String", # The name of the function (as defined in source code) that will be | |
| # executed. Defaults to the resource name suffix, if not specified. For | |
| # backward compatibility, if function with given name is not found, then the | |
| # system will try to use function named "function". | |
| # For Node.js this is name of a function exported by the module specified | |
| # in `source_location`. | |
| "timeout": "A String", # The function execution timeout. Execution is considered failed and | |
| # can be terminated if the function is not completed at the end of the | |
| # timeout period. Defaults to 60 seconds. | |
| "latestOperation": "A String", # Output only. Name of the most recent operation modifying the function. If | |
| # the function status is `DEPLOYING` or `DELETING`, then it points to the | |
| # active operation. | |
| } | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # This resource represents a long-running operation that is the result of a | |
| # network API call. | |
| "metadata": { # Service-specific metadata associated with the operation. It typically | |
| # contains progress information and common metadata such as create time. | |
| # Some services might not provide such metadata. Any method that returns a | |
| # long-running operation should document the metadata type, if any. | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation. | |
| # programming environments, including REST APIs and RPC APIs. It is used by | |
| # [gRPC](https://github.com/grpc). The error model is designed to be: | |
| # | |
| # - Simple to use and understand for most users | |
| # - Flexible enough to meet unexpected needs | |
| # | |
| # # Overview | |
| # | |
| # The `Status` message contains three pieces of data: error code, error message, | |
| # and error details. The error code should be an enum value of | |
| # google.rpc.Code, but it may accept additional error codes if needed. The | |
| # error message should be a developer-facing English message that helps | |
| # developers *understand* and *resolve* the error. If a localized user-facing | |
| # error message is needed, put the localized message in the error details or | |
| # localize it in the client. The optional error details may contain arbitrary | |
| # information about the error. There is a predefined set of error detail types | |
| # in the package `google.rpc` that can be used for common error conditions. | |
| # | |
| # # Language mapping | |
| # | |
| # The `Status` message is the logical representation of the error model, but it | |
| # is not necessarily the actual wire format. When the `Status` message is | |
| # exposed in different client libraries and different wire protocols, it can be | |
| # mapped differently. For example, it will likely be mapped to some exceptions | |
| # in Java, but more likely mapped to some error codes in C. | |
| # | |
| # # Other uses | |
| # | |
| # The error model and the `Status` message can be used in a variety of | |
| # environments, either with or without APIs, to provide a | |
| # consistent developer experience across different environments. | |
| # | |
| # Example uses of this error model include: | |
| # | |
| # - Partial errors. If a service needs to return partial errors to the client, | |
| # it may embed the `Status` in the normal response to indicate the partial | |
| # errors. | |
| # | |
| # - Workflow errors. A typical workflow has multiple steps. Each step may | |
| # have a `Status` message for error reporting. | |
| # | |
| # - Batch operations. If a client uses batch request and batch response, the | |
| # `Status` message should be used directly inside batch response, one for | |
| # each error sub-response. | |
| # | |
| # - Asynchronous operations. If an API call embeds asynchronous operation | |
| # results in its response, the status of those operations should be | |
| # represented directly using the `Status` message. | |
| # | |
| # - Logging. If some API errors are stored in logs, the message `Status` could | |
| # be used directly after any stripping needed for security/privacy reasons. | |
| "message": "A String", # A developer-facing error message, which should be in English. Any | |
| # user-facing error message should be localized and sent in the | |
| # google.rpc.Status.details field, or localized by the client. | |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. | |
| "details": [ # A list of messages that carry the error details. There will be a | |
| # common set of message types for APIs to use. | |
| { | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| ], | |
| }, | |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. | |
| # If true, the operation is completed, and either `error` or `response` is | |
| # available. | |
| "response": { # The normal response of the operation in case of success. If the original | |
| # method returns no data on success, such as `Delete`, the response is | |
| # `google.protobuf.Empty`. If the original method is standard | |
| # `Get`/`Create`/`Update`, the response should be the resource. For other | |
| # methods, the response should have the type `XxxResponse`, where `Xxx` | |
| # is the original method name. For example, if the original method name | |
| # is `TakeSnapshot()`, the inferred response type is | |
| # `TakeSnapshotResponse`. | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| "name": "A String", # The server-assigned name, which is only unique within the same service that | |
| # originally returns it. If you use the default HTTP mapping, the | |
| # `name` should have the format of `operations/some/unique/name`. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> | |
| <pre>Deletes a function with the given name from the specified project. If the | |
| given function is used by some trigger, the trigger will be updated to | |
| remove this function. | |
| Args: | |
| name: string, The name of the function which should be deleted. (required) | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # This resource represents a long-running operation that is the result of a | |
| # network API call. | |
| "metadata": { # Service-specific metadata associated with the operation. It typically | |
| # contains progress information and common metadata such as create time. | |
| # Some services might not provide such metadata. Any method that returns a | |
| # long-running operation should document the metadata type, if any. | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation. | |
| # programming environments, including REST APIs and RPC APIs. It is used by | |
| # [gRPC](https://github.com/grpc). The error model is designed to be: | |
| # | |
| # - Simple to use and understand for most users | |
| # - Flexible enough to meet unexpected needs | |
| # | |
| # # Overview | |
| # | |
| # The `Status` message contains three pieces of data: error code, error message, | |
| # and error details. The error code should be an enum value of | |
| # google.rpc.Code, but it may accept additional error codes if needed. The | |
| # error message should be a developer-facing English message that helps | |
| # developers *understand* and *resolve* the error. If a localized user-facing | |
| # error message is needed, put the localized message in the error details or | |
| # localize it in the client. The optional error details may contain arbitrary | |
| # information about the error. There is a predefined set of error detail types | |
| # in the package `google.rpc` that can be used for common error conditions. | |
| # | |
| # # Language mapping | |
| # | |
| # The `Status` message is the logical representation of the error model, but it | |
| # is not necessarily the actual wire format. When the `Status` message is | |
| # exposed in different client libraries and different wire protocols, it can be | |
| # mapped differently. For example, it will likely be mapped to some exceptions | |
| # in Java, but more likely mapped to some error codes in C. | |
| # | |
| # # Other uses | |
| # | |
| # The error model and the `Status` message can be used in a variety of | |
| # environments, either with or without APIs, to provide a | |
| # consistent developer experience across different environments. | |
| # | |
| # Example uses of this error model include: | |
| # | |
| # - Partial errors. If a service needs to return partial errors to the client, | |
| # it may embed the `Status` in the normal response to indicate the partial | |
| # errors. | |
| # | |
| # - Workflow errors. A typical workflow has multiple steps. Each step may | |
| # have a `Status` message for error reporting. | |
| # | |
| # - Batch operations. If a client uses batch request and batch response, the | |
| # `Status` message should be used directly inside batch response, one for | |
| # each error sub-response. | |
| # | |
| # - Asynchronous operations. If an API call embeds asynchronous operation | |
| # results in its response, the status of those operations should be | |
| # represented directly using the `Status` message. | |
| # | |
| # - Logging. If some API errors are stored in logs, the message `Status` could | |
| # be used directly after any stripping needed for security/privacy reasons. | |
| "message": "A String", # A developer-facing error message, which should be in English. Any | |
| # user-facing error message should be localized and sent in the | |
| # google.rpc.Status.details field, or localized by the client. | |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. | |
| "details": [ # A list of messages that carry the error details. There will be a | |
| # common set of message types for APIs to use. | |
| { | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| ], | |
| }, | |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. | |
| # If true, the operation is completed, and either `error` or `response` is | |
| # available. | |
| "response": { # The normal response of the operation in case of success. If the original | |
| # method returns no data on success, such as `Delete`, the response is | |
| # `google.protobuf.Empty`. If the original method is standard | |
| # `Get`/`Create`/`Update`, the response should be the resource. For other | |
| # methods, the response should have the type `XxxResponse`, where `Xxx` | |
| # is the original method name. For example, if the original method name | |
| # is `TakeSnapshot()`, the inferred response type is | |
| # `TakeSnapshotResponse`. | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| "name": "A String", # The server-assigned name, which is only unique within the same service that | |
| # originally returns it. If you use the default HTTP mapping, the | |
| # `name` should have the format of `operations/some/unique/name`. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="get">get(name, x__xgafv=None)</code> | |
| <pre>Returns a function with the given name from the requested project. | |
| Args: | |
| name: string, The name of the function which details should be obtained. (required) | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Describes a Cloud Function that contains user computation executed in | |
| # response to an event. It encapsulate function and triggers configurations. | |
| "eventTrigger": { # Describes EventTrigger, used to request events be sent from another # A source that fires events in response to a condition in another service. | |
| # service. | |
| "eventType": "A String", # `event_type` names contain the service that is sending an event and the | |
| # kind of event that was fired. Must be of the form | |
| # `providers/*/eventTypes/*` e.g. Directly handle a Message published to | |
| # Google Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish` | |
| # | |
| # Handle an object changing in Google Cloud Storage | |
| # `providers/cloud.storage/eventTypes/object.change` | |
| # | |
| # Handle a write to the Firebase Realtime Database | |
| # `providers/firebase.database/eventTypes/data.write` | |
| "resource": "A String", # Which instance of the source's service should send events. E.g. for Pub/Sub | |
| # this would be a Pub/Sub topic at `projects/*/topics/*`. For Google Cloud | |
| # Storage this would be a bucket at `projects/*/buckets/*`. For any source | |
| # that only supports one instance per-project, this should be the name of the | |
| # project (`projects/*`) | |
| }, | |
| "status": "A String", # Output only. Status of the function deployment. | |
| "updateTime": "A String", # Output only. The last update timestamp of a Cloud Function. | |
| "name": "A String", # A user-defined name of the function. Function names must be unique | |
| # globally and match pattern `projects/*/locations/*/functions/*` | |
| "sourceRepository": { # Describes the location of the function source in a remote repository. # The hosted repository where the function is defined. | |
| "repositoryUrl": "A String", # URL to the hosted repository where the function is defined. Only paths in | |
| # https://source.developers.google.com domain are supported. The path should | |
| # contain the name of the repository. | |
| "sourcePath": "A String", # The path within the repository where the function is defined. The path | |
| # should point to the directory where Cloud Functions files are located. Use | |
| # "/" if the function is defined directly in the root directory of a | |
| # repository. | |
| "deployedRevision": "A String", # Output only. The id of the revision that was resolved at the moment of | |
| # function creation or update. For example when a user deployed from a | |
| # branch, it will be the revision id of the latest change on this branch at | |
| # that time. If user deployed from revision then this value will be always | |
| # equal to the revision specified by the user. | |
| "tag": "A String", # The name of the tag that captures the state of the repository from | |
| # which the function should be fetched. | |
| "branch": "A String", # The name of the branch from which the function should be fetched. | |
| "revision": "A String", # The id of the revision that captures the state of the repository from | |
| # which the function should be fetched. | |
| }, | |
| "availableMemoryMb": 42, # The amount of memory in MB available for a function. | |
| # Defaults to 256MB. | |
| "httpsTrigger": { # Describes HTTPSTrigger, could be used to connect web hooks to function. # An HTTPS endpoint type of source that can be triggered via URL. | |
| "url": "A String", # Output only. The deployed url for the function. | |
| }, | |
| "sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with gs://, pointing to the zip | |
| # archive which contains the function. | |
| "serviceAccount": "A String", # Output only. The service account of the function. | |
| "entryPoint": "A String", # The name of the function (as defined in source code) that will be | |
| # executed. Defaults to the resource name suffix, if not specified. For | |
| # backward compatibility, if function with given name is not found, then the | |
| # system will try to use function named "function". | |
| # For Node.js this is name of a function exported by the module specified | |
| # in `source_location`. | |
| "timeout": "A String", # The function execution timeout. Execution is considered failed and | |
| # can be terminated if the function is not completed at the end of the | |
| # timeout period. Defaults to 60 seconds. | |
| "latestOperation": "A String", # Output only. Name of the most recent operation modifying the function. If | |
| # the function status is `DEPLOYING` or `DELETING`, then it points to the | |
| # active operation. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="list">list(location, pageSize=None, pageToken=None, x__xgafv=None)</code> | |
| <pre>Returns a list of functions that belong to the requested project. | |
| Args: | |
| location: string, The project and location from which the function should be listed, | |
| specified in the format `projects/*/locations/*` | |
| If you want to list functions in all locations, use "-" in place of a | |
| location. (required) | |
| pageSize: integer, Maximum number of functions to return per call. | |
| pageToken: string, The value returned by the last | |
| `ListFunctionsResponse`; indicates that | |
| this is a continuation of a prior `ListFunctions` call, and that the | |
| system should return the next page of data. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Response for the `ListFunctions` method. | |
| "nextPageToken": "A String", # If not empty, indicates that there may be more functions that match | |
| # the request; this value should be passed in a new | |
| # google.cloud.functions.v1beta2.ListFunctionsRequest | |
| # to get more functions. | |
| "functions": [ # The functions that match the request. | |
| { # Describes a Cloud Function that contains user computation executed in | |
| # response to an event. It encapsulate function and triggers configurations. | |
| "eventTrigger": { # Describes EventTrigger, used to request events be sent from another # A source that fires events in response to a condition in another service. | |
| # service. | |
| "eventType": "A String", # `event_type` names contain the service that is sending an event and the | |
| # kind of event that was fired. Must be of the form | |
| # `providers/*/eventTypes/*` e.g. Directly handle a Message published to | |
| # Google Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish` | |
| # | |
| # Handle an object changing in Google Cloud Storage | |
| # `providers/cloud.storage/eventTypes/object.change` | |
| # | |
| # Handle a write to the Firebase Realtime Database | |
| # `providers/firebase.database/eventTypes/data.write` | |
| "resource": "A String", # Which instance of the source's service should send events. E.g. for Pub/Sub | |
| # this would be a Pub/Sub topic at `projects/*/topics/*`. For Google Cloud | |
| # Storage this would be a bucket at `projects/*/buckets/*`. For any source | |
| # that only supports one instance per-project, this should be the name of the | |
| # project (`projects/*`) | |
| }, | |
| "status": "A String", # Output only. Status of the function deployment. | |
| "updateTime": "A String", # Output only. The last update timestamp of a Cloud Function. | |
| "name": "A String", # A user-defined name of the function. Function names must be unique | |
| # globally and match pattern `projects/*/locations/*/functions/*` | |
| "sourceRepository": { # Describes the location of the function source in a remote repository. # The hosted repository where the function is defined. | |
| "repositoryUrl": "A String", # URL to the hosted repository where the function is defined. Only paths in | |
| # https://source.developers.google.com domain are supported. The path should | |
| # contain the name of the repository. | |
| "sourcePath": "A String", # The path within the repository where the function is defined. The path | |
| # should point to the directory where Cloud Functions files are located. Use | |
| # "/" if the function is defined directly in the root directory of a | |
| # repository. | |
| "deployedRevision": "A String", # Output only. The id of the revision that was resolved at the moment of | |
| # function creation or update. For example when a user deployed from a | |
| # branch, it will be the revision id of the latest change on this branch at | |
| # that time. If user deployed from revision then this value will be always | |
| # equal to the revision specified by the user. | |
| "tag": "A String", # The name of the tag that captures the state of the repository from | |
| # which the function should be fetched. | |
| "branch": "A String", # The name of the branch from which the function should be fetched. | |
| "revision": "A String", # The id of the revision that captures the state of the repository from | |
| # which the function should be fetched. | |
| }, | |
| "availableMemoryMb": 42, # The amount of memory in MB available for a function. | |
| # Defaults to 256MB. | |
| "httpsTrigger": { # Describes HTTPSTrigger, could be used to connect web hooks to function. # An HTTPS endpoint type of source that can be triggered via URL. | |
| "url": "A String", # Output only. The deployed url for the function. | |
| }, | |
| "sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with gs://, pointing to the zip | |
| # archive which contains the function. | |
| "serviceAccount": "A String", # Output only. The service account of the function. | |
| "entryPoint": "A String", # The name of the function (as defined in source code) that will be | |
| # executed. Defaults to the resource name suffix, if not specified. For | |
| # backward compatibility, if function with given name is not found, then the | |
| # system will try to use function named "function". | |
| # For Node.js this is name of a function exported by the module specified | |
| # in `source_location`. | |
| "timeout": "A String", # The function execution timeout. Execution is considered failed and | |
| # can be terminated if the function is not completed at the end of the | |
| # timeout period. Defaults to 60 seconds. | |
| "latestOperation": "A String", # Output only. Name of the most recent operation modifying the function. If | |
| # the function status is `DEPLOYING` or `DELETING`, then it points to the | |
| # active operation. | |
| }, | |
| ], | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> | |
| <pre>Retrieves the next page of results. | |
| Args: | |
| previous_request: The request for the previous page. (required) | |
| previous_response: The response from the request for the previous page. (required) | |
| Returns: | |
| A request object that you can call 'execute()' on to request the next | |
| page. Returns None if there are no more items in the collection. | |
| </pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="update">update(name, body, x__xgafv=None)</code> | |
| <pre>Updates existing function. | |
| Args: | |
| name: string, The name of the function to be updated. (required) | |
| body: object, The request body. (required) | |
| The object takes the form of: | |
| { # Describes a Cloud Function that contains user computation executed in | |
| # response to an event. It encapsulate function and triggers configurations. | |
| "eventTrigger": { # Describes EventTrigger, used to request events be sent from another # A source that fires events in response to a condition in another service. | |
| # service. | |
| "eventType": "A String", # `event_type` names contain the service that is sending an event and the | |
| # kind of event that was fired. Must be of the form | |
| # `providers/*/eventTypes/*` e.g. Directly handle a Message published to | |
| # Google Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish` | |
| # | |
| # Handle an object changing in Google Cloud Storage | |
| # `providers/cloud.storage/eventTypes/object.change` | |
| # | |
| # Handle a write to the Firebase Realtime Database | |
| # `providers/firebase.database/eventTypes/data.write` | |
| "resource": "A String", # Which instance of the source's service should send events. E.g. for Pub/Sub | |
| # this would be a Pub/Sub topic at `projects/*/topics/*`. For Google Cloud | |
| # Storage this would be a bucket at `projects/*/buckets/*`. For any source | |
| # that only supports one instance per-project, this should be the name of the | |
| # project (`projects/*`) | |
| }, | |
| "status": "A String", # Output only. Status of the function deployment. | |
| "updateTime": "A String", # Output only. The last update timestamp of a Cloud Function. | |
| "name": "A String", # A user-defined name of the function. Function names must be unique | |
| # globally and match pattern `projects/*/locations/*/functions/*` | |
| "sourceRepository": { # Describes the location of the function source in a remote repository. # The hosted repository where the function is defined. | |
| "repositoryUrl": "A String", # URL to the hosted repository where the function is defined. Only paths in | |
| # https://source.developers.google.com domain are supported. The path should | |
| # contain the name of the repository. | |
| "sourcePath": "A String", # The path within the repository where the function is defined. The path | |
| # should point to the directory where Cloud Functions files are located. Use | |
| # "/" if the function is defined directly in the root directory of a | |
| # repository. | |
| "deployedRevision": "A String", # Output only. The id of the revision that was resolved at the moment of | |
| # function creation or update. For example when a user deployed from a | |
| # branch, it will be the revision id of the latest change on this branch at | |
| # that time. If user deployed from revision then this value will be always | |
| # equal to the revision specified by the user. | |
| "tag": "A String", # The name of the tag that captures the state of the repository from | |
| # which the function should be fetched. | |
| "branch": "A String", # The name of the branch from which the function should be fetched. | |
| "revision": "A String", # The id of the revision that captures the state of the repository from | |
| # which the function should be fetched. | |
| }, | |
| "availableMemoryMb": 42, # The amount of memory in MB available for a function. | |
| # Defaults to 256MB. | |
| "httpsTrigger": { # Describes HTTPSTrigger, could be used to connect web hooks to function. # An HTTPS endpoint type of source that can be triggered via URL. | |
| "url": "A String", # Output only. The deployed url for the function. | |
| }, | |
| "sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with gs://, pointing to the zip | |
| # archive which contains the function. | |
| "serviceAccount": "A String", # Output only. The service account of the function. | |
| "entryPoint": "A String", # The name of the function (as defined in source code) that will be | |
| # executed. Defaults to the resource name suffix, if not specified. For | |
| # backward compatibility, if function with given name is not found, then the | |
| # system will try to use function named "function". | |
| # For Node.js this is name of a function exported by the module specified | |
| # in `source_location`. | |
| "timeout": "A String", # The function execution timeout. Execution is considered failed and | |
| # can be terminated if the function is not completed at the end of the | |
| # timeout period. Defaults to 60 seconds. | |
| "latestOperation": "A String", # Output only. Name of the most recent operation modifying the function. If | |
| # the function status is `DEPLOYING` or `DELETING`, then it points to the | |
| # active operation. | |
| } | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # This resource represents a long-running operation that is the result of a | |
| # network API call. | |
| "metadata": { # Service-specific metadata associated with the operation. It typically | |
| # contains progress information and common metadata such as create time. | |
| # Some services might not provide such metadata. Any method that returns a | |
| # long-running operation should document the metadata type, if any. | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation. | |
| # programming environments, including REST APIs and RPC APIs. It is used by | |
| # [gRPC](https://github.com/grpc). The error model is designed to be: | |
| # | |
| # - Simple to use and understand for most users | |
| # - Flexible enough to meet unexpected needs | |
| # | |
| # # Overview | |
| # | |
| # The `Status` message contains three pieces of data: error code, error message, | |
| # and error details. The error code should be an enum value of | |
| # google.rpc.Code, but it may accept additional error codes if needed. The | |
| # error message should be a developer-facing English message that helps | |
| # developers *understand* and *resolve* the error. If a localized user-facing | |
| # error message is needed, put the localized message in the error details or | |
| # localize it in the client. The optional error details may contain arbitrary | |
| # information about the error. There is a predefined set of error detail types | |
| # in the package `google.rpc` that can be used for common error conditions. | |
| # | |
| # # Language mapping | |
| # | |
| # The `Status` message is the logical representation of the error model, but it | |
| # is not necessarily the actual wire format. When the `Status` message is | |
| # exposed in different client libraries and different wire protocols, it can be | |
| # mapped differently. For example, it will likely be mapped to some exceptions | |
| # in Java, but more likely mapped to some error codes in C. | |
| # | |
| # # Other uses | |
| # | |
| # The error model and the `Status` message can be used in a variety of | |
| # environments, either with or without APIs, to provide a | |
| # consistent developer experience across different environments. | |
| # | |
| # Example uses of this error model include: | |
| # | |
| # - Partial errors. If a service needs to return partial errors to the client, | |
| # it may embed the `Status` in the normal response to indicate the partial | |
| # errors. | |
| # | |
| # - Workflow errors. A typical workflow has multiple steps. Each step may | |
| # have a `Status` message for error reporting. | |
| # | |
| # - Batch operations. If a client uses batch request and batch response, the | |
| # `Status` message should be used directly inside batch response, one for | |
| # each error sub-response. | |
| # | |
| # - Asynchronous operations. If an API call embeds asynchronous operation | |
| # results in its response, the status of those operations should be | |
| # represented directly using the `Status` message. | |
| # | |
| # - Logging. If some API errors are stored in logs, the message `Status` could | |
| # be used directly after any stripping needed for security/privacy reasons. | |
| "message": "A String", # A developer-facing error message, which should be in English. Any | |
| # user-facing error message should be localized and sent in the | |
| # google.rpc.Status.details field, or localized by the client. | |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. | |
| "details": [ # A list of messages that carry the error details. There will be a | |
| # common set of message types for APIs to use. | |
| { | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| ], | |
| }, | |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. | |
| # If true, the operation is completed, and either `error` or `response` is | |
| # available. | |
| "response": { # The normal response of the operation in case of success. If the original | |
| # method returns no data on success, such as `Delete`, the response is | |
| # `google.protobuf.Empty`. If the original method is standard | |
| # `Get`/`Create`/`Update`, the response should be the resource. For other | |
| # methods, the response should have the type `XxxResponse`, where `Xxx` | |
| # is the original method name. For example, if the original method name | |
| # is `TakeSnapshot()`, the inferred response type is | |
| # `TakeSnapshotResponse`. | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| "name": "A String", # The server-assigned name, which is only unique within the same service that | |
| # originally returns it. If you use the default HTTP mapping, the | |
| # `name` should have the format of `operations/some/unique/name`. | |
| }</pre> | |
| </div> | |
| </body></html> |