package google.cloud.functions.v1beta2
Get desktop application:
View/edit binary Protocol Buffers messages
A service that application uses to manipulate triggers and functions.
rpc ListFunctions (, )
functions.proto:40Returns a list of functions that belong to the requested project.
message
functions.proto:439Request for the `ListFunctions` method.
string location = 1
Required. 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. When listing functions in all locations, if one or more location(s) are unreachable, the response will contain functions from all reachable locations along with the names of any unreachable locations.
int32 page_size = 2
Maximum number of functions to return per call.
string page_token = 3
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.
message
functions.proto:464Response for the `ListFunctions` method.
repeated functions = 1
The functions that match the request.
string next_page_token = 2
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][google.cloud.functions.v1beta2.ListFunctionsRequest] to get more functions.
repeated string unreachable = 3
Locations that could not be reached. The response does not include any functions from these locations.
rpc GetFunction (, )
functions.proto:48Returns a function with the given name from the requested project.
message
functions.proto:428Request for the `GetFunction` method.
string name = 1
Required. The name of the function which details should be obtained.
rpc CreateFunction (, )
functions.proto:58Creates 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.
message
functions.proto:381Request for the `CreateFunction` method.
string location = 1
Required. The project and location in which the function should be created, specified in the format `projects/*/locations/*`
optional function = 2
Required. Function to be created.
rpc UpdateFunction (, )
functions.proto:71Updates existing function.
message
functions.proto:396Request for the `UpdateFunction` method.
string name = 1
Required. The name of the function to be updated.
optional function = 2
Required. New version of the function.
rpc DeleteFunction (, )
functions.proto:86Deletes 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.
message
functions.proto:480Request for the `DeleteFunction` method.
string name = 1
Required. The name of the function which should be deleted.
rpc CallFunction (, )
functions.proto:101Synchronously invokes a deployed Cloud Function. To be used for testing purposes as very limited traffic is allowed. For more information on the actual limits refer to [API Calls]( https://cloud.google.com/functions/quotas#rate_limits).
message
functions.proto:491Request for the `CallFunction` method.
string name = 1
Required. The name of the function to be called.
string data = 2
Required. Input to be passed to the function.
message
functions.proto:505Response of `CallFunction` method.
string execution_id = 1
Execution id of function invocation.
string result = 2
Result populated for successful execution of synchronous function. Will not be populated if function does not return a result through context.
string error = 3
Either system or user-function generated error. Set if execution was not successful.
rpc GenerateUploadUrl (, )
functions.proto:134Returns a signed URL for uploading a function source code. For more information about the signed URL usage see: https://cloud.google.com/storage/docs/access-control/signed-urls Once the function source code upload is complete, the used signed URL should be provided in CreateFunction or UpdateFunction request as a reference to the function source code. When uploading source code to the generated signed URL, please follow these restrictions: * Source file type should be a zip file. * Source file size should not exceed 100MB limit. * No credentials should be attached - the signed URLs provide access to the target bucket using internal service identity; if credentials were attached, the identity from the credentials would be used, but that identity does not have permissions to upload files to the URL. When making a HTTP PUT request, these two headers need to be specified: * `content-type: application/zip` * `x-goog-content-length-range: 0,104857600` And this header SHOULD NOT be specified: * `Authorization: Bearer YOUR_TOKEN`
message
functions.proto:519Request of `GenerateUploadUrl` method.
string parent = 1
The project and location in which the Google Cloud Storage signed URL should be generated, specified in the format `projects/*/locations/*`.
message
functions.proto:526Response of `GenerateUploadUrl` method.
string upload_url = 1
The generated Google Cloud Storage signed URL that should be used for a function source code upload. The uploaded file should be a zip archive which contains a function.
Returns a signed URL for downloading deployed function source code. The URL is only valid for a limited period and should be used within minutes after generation. For more information about the signed URL usage see: https://cloud.google.com/storage/docs/access-control/signed-urls
message
functions.proto:534Request of `GenerateDownloadUrl` method.
string name = 1
The name of function for which source code Google Cloud Storage signed URL should be generated.
uint64 version_id = 2
The optional version of function.
message
functions.proto:544Response of `GenerateDownloadUrl` method.
string download_url = 1
The generated Google Cloud Storage signed URL that should be used for function source code download.
message
functions.proto:156Describes a Cloud Function that contains user computation executed in response to an event. It encapsulate function and triggers configurations.
Used as response type in: CloudFunctionsService.GetFunction
Used as field type in: , ,
string name = 1
A user-defined name of the function. Function names must be unique globally and match pattern `projects/*/locations/*/functions/*`
oneof source_code
The location of the function source code.
string source_archive_url = 14
The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the function.
source_repository = 3
The hosted repository where the function is defined.
string source_repository_url = 18
The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` To refer to a moveable alias (branch): `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*` In particular, to refer to HEAD use `master` moveable alias. To refer to a specific fixed alias (tag): `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*` You may omit `paths/*` if you want to use the main directory.
string source_upload_url = 16
The Google Cloud Storage signed URL used for source uploading, generated by [google.cloud.functions.v1beta2.GenerateUploadUrl][]
oneof trigger
An event that triggers the function.
https_trigger = 6
An HTTPS endpoint type of source that can be triggered via URL.
event_trigger = 12
A source that fires events in response to a condition in another service.
CloudFunctionStatus status = 7
Output only. Status of the function deployment.
string latest_operation = 8
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.
string entry_point = 9
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`.
string runtime = 23
The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function. For a complete list of possible choices, see the [`gcloud` command reference](/sdk/gcloud/reference/functions/deploy#--runtime).
optional timeout = 10
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.
int32 available_memory_mb = 11
The amount of memory in MB available for a function. Defaults to 256MB.
string service_account = 13
The email of the function's service account. If empty, defaults to `{project_id}@appspot.gserviceaccount.com`.
optional update_time = 15
Output only. The last update timestamp of a Cloud Function.
int64 version_id = 20
Output only. The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created.
map<string, string> labels = 21
Labels associated with this Cloud Function.
map<string, string> environment_variables = 22
Environment variables that shall be available during function execution.
int32 max_instances = 24
The limit on the maximum number of function instances that may coexist at a given time.
string network = 25
The VPC Network that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network resource. If the short network name is used, the network must belong to the same project. Otherwise, it must belong to a project within the same organization. The format of this field is either `projects/{project}/global/networks/{network}` or `{network}`, where {project} is a project id where the network is defined, and {network} is the short name of the network. This field is mutually exclusive with `vpc_connector` and will be replaced by it. See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for more information on connecting Cloud projects.
string vpc_connector = 26
The VPC Network Connector that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network connector resource. The format of this field is `projects/*/locations/*/connectors/*` This field is mutually exclusive with `network` field and will eventually replace it. See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for more information on connecting Cloud projects.
Describes the current stage of a deployment.
Used in:
STATUS_UNSPECIFIED = 0
Status not specified.
READY = 1
Successfully deployed.
FAILED = 2
Not deployed correctly - behavior is undefined. The item should be updated or deleted to move it out of this state.
DEPLOYING = 3
Creation or update in progress.
DELETING = 4
Deletion in progress.
message
functions.proto:294Describes EventTrigger, used to request events be sent from another service.
Used in:
string event_type = 1
`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/google.firebase.database/eventTypes/ref.write`
string resource = 2
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/*`)
string service = 6
The hostname of the service that should be observed. If no string is provided, the default service implementing the API will be used. For example, `storage.googleapis.com` is the default for all event types in the `google.storage` namespace.
optional failure_policy = 5
Specifies policy for failed executions.
message
functions.proto:363Describes the policy in case of function's execution failure. If empty, then defaults to ignoring failures (i.e. not retrying them).
Used in:
oneof action
Defines the action taken in case of a function execution failure.
retry = 1
If specified, then the function will be retried in case of a failure.
message
functions.proto:369Describes the retry policy in case of function's execution failure. A function execution will be retried on any failure. A failed execution will be retried up to 7 days with an exponential backoff (capped at 10 seconds). Retried execution is charged as any other execution.
Used in:
(message has no fields)
message
functions.proto:287Describes HTTPSTrigger, could be used to connect web hooks to function.
Used in:
string url = 1
Output only. The deployed url for the function.
message
operations.proto:45Metadata describing an [Operation][google.longrunning.Operation]
string target = 1
Target of the operation - for example projects/project-1/locations/region-1/functions/function-1
OperationType type = 2
Type of operation.
optional request = 3
The original request that started the operation.
int64 version_id = 4
Version id of the function created or updated by an API call. This field is only populated for Create and Update operations.
optional update_time = 5
The last update timestamp of the operation.
A type of an operation.
Used in:
OPERATION_UNSPECIFIED = 0
Unknown operation type.
CREATE_FUNCTION = 1
Triggered by CreateFunction call
UPDATE_FUNCTION = 2
Triggered by UpdateFunction call
DELETE_FUNCTION = 3
Triggered by DeleteFunction call.
message
functions.proto:326Describes the location of the function source in a remote repository.
Used in:
string repository_url = 1
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.
string source_path = 2
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.
oneof version
The version of a function. Defaults to the latest version of the master branch.
string branch = 3
The name of the branch from which the function should be fetched.
string tag = 4
The name of the tag that captures the state of the repository from which the function should be fetched.
string revision = 5
The id of the revision that captures the state of the repository from which the function should be fetched.
string deployed_revision = 6
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.