- Resource: CloudFunction
- SourceRepository
- HttpsTrigger
- SecurityLevel
- EventTrigger
- FailurePolicy
- Retry
- CloudFunctionStatus
- VpcConnectorEgressSettings
- IngressSettings
- Methods
Resource: CloudFunction
Describes a Cloud Function that contains user computation executed in response to an event. It encapsulate function and triggers configurations.
JSON representation | |
---|---|
{ "name": string, "description": string, "status": enum ( |
Fields | ||
---|---|---|
name |
A user-defined name of the function. Function names must be unique globally and match pattern |
|
description |
User-provided description of a function. |
|
status |
Output only. Status of the function deployment. |
|
entryPoint |
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 |
|
runtime |
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 |
|
timeout |
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. A duration in seconds with up to nine fractional digits, terminated by ' |
|
availableMemoryMb |
The amount of memory in MB available for a function. Defaults to 256MB. |
|
serviceAccountEmail |
The email of the function's service account. If empty, defaults to |
|
updateTime |
Output only. The last update timestamp of a Cloud Function. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
|
versionId |
Output only. The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created. |
|
labels |
Labels associated with this Cloud Function. An object containing a list of |
|
environmentVariables |
Environment variables that shall be available during function execution. An object containing a list of |
|
buildEnvironmentVariables |
Build environment variables that shall be available during build time. An object containing a list of |
|
network |
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 This field is mutually exclusive with See the VPC documentation for more information on connecting Cloud projects. |
|
maxInstances |
The limit on the maximum number of function instances that may coexist at a given time. In some cases, such as rapid traffic surges, Cloud Functions may, for a short period of time, create more instances than the specified max instances limit. If your function cannot tolerate this temporary behavior, you may want to factor in a safety margin and set a lower max instances value than your function can tolerate. See the Max Instances Guide for more details. |
|
vpcConnector |
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 This field is mutually exclusive with See the VPC documentation for more information on connecting Cloud projects. |
|
vpcConnectorEgressSettings |
The egress settings for the connector, controlling what traffic is diverted through it. |
|
ingressSettings |
The ingress settings for the function, controlling what traffic can reach it. |
|
buildWorkerPool |
Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is If the project id is not the same as the function, then the Cloud Functions Service Agent (service- |
|
buildId |
Output only. The Cloud Build ID of the latest successful deployment of the function. |
|
sourceToken |
Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments. |
|
Union field source_code . The location of the function source code. source_code can be only one of the following: |
||
sourceArchiveUrl |
The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the function. |
|
sourceRepository |
Beta Feature The source repository where a function is hosted. |
|
sourceUploadUrl |
The Google Cloud Storage signed URL used for source uploading, generated by [google.cloud.functions.v1.GenerateUploadUrl][] |
|
Union field trigger . An event that triggers the function. trigger can be only one of the following: |
||
httpsTrigger |
An HTTPS endpoint type of source that can be triggered via URL. |
|
eventTrigger |
A source that fires events in response to a condition in another service. |
SourceRepository
Describes SourceRepository, used to represent parameters related to source repository where a function is hosted.
JSON representation | |
---|---|
{ "url": string, "deployedUrl": string } |
Fields | |
---|---|
url |
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: You may omit |
deployedUrl |
Output only. The URL pointing to the hosted repository where the function were defined at the time of deployment. It always points to a specific commit in the format described above. |
HttpsTrigger
Describes HttpsTrigger, could be used to connect web hooks to function.
JSON representation | |
---|---|
{
"url": string,
"securityLevel": enum ( |
Fields | |
---|---|
url |
Output only. The deployed url for the function. |
securityLevel |
The security level for the function. |
SecurityLevel
Available security level settings.
This controls the methods to enforce security (HTTPS) on a URL.
If unspecified, SECURE_OPTIONAL will be used.
Enums | |
---|---|
SECURITY_LEVEL_UNSPECIFIED |
Unspecified. |
SECURE_ALWAYS |
Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect. |
SECURE_OPTIONAL |
Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly. |
EventTrigger
Describes EventTrigger, used to request events be sent from another service.
JSON representation | |
---|---|
{
"eventType": string,
"resource": string,
"service": string,
"failurePolicy": {
object ( |
Fields | |
---|---|
eventType |
Required. The type of event to observe. For example: Event types match pattern
|
resource |
Required. The resource(s) from which to observe events, for example, Not all syntactically correct values are accepted by all services. For example:
Additionally, some services may support short names when creating an See each service's documentation for supported formats. |
service |
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, |
failurePolicy |
Specifies policy for failed executions. |
FailurePolicy
Describes the policy in case of function's execution failure. If empty, then defaults to ignoring failures (i.e. not retrying them).
JSON representation | |
---|---|
{
"retry": {
object ( |
Fields | |
---|---|
retry |
If specified, then the function will be retried in case of a failure. |
Retry
Describes 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.
CloudFunctionStatus
Describes the current stage of a deployment.
Enums | |
---|---|
CLOUD_FUNCTION_STATUS_UNSPECIFIED |
Not specified. Invalid state. |
ACTIVE |
Function has been successfully deployed and is serving. |
OFFLINE |
Function deployment failed and the function isn’t serving. |
DEPLOY_IN_PROGRESS |
Function is being created or updated. |
DELETE_IN_PROGRESS |
Function is being deleted. |
UNKNOWN |
Function deployment failed and the function serving state is undefined. The function should be updated or deleted to move it out of this state. |
VpcConnectorEgressSettings
Available egress settings.
This controls what traffic is diverted through the VPC Access Connector resource. By default PRIVATE_RANGES_ONLY will be used.
Enums | |
---|---|
VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED |
Unspecified. |
PRIVATE_RANGES_ONLY |
Use the VPC Access Connector only for private IP space from RFC1918. |
ALL_TRAFFIC |
Force the use of VPC Access Connector for all egress traffic from the function. |
IngressSettings
Available ingress settings.
This controls what traffic can reach the function.
If unspecified, ALLOW_ALL will be used.
Enums | |
---|---|
INGRESS_SETTINGS_UNSPECIFIED |
Unspecified. |
ALLOW_ALL |
Allow HTTP traffic from public and private sources. |
ALLOW_INTERNAL_ONLY |
Allow HTTP traffic from only private VPC sources. |
ALLOW_INTERNAL_AND_GCLB |
Allow HTTP traffic from private VPC sources and through GCLB. |
Methods |
|
---|---|
|
Synchronously invokes a deployed Cloud Function. |
|
Creates a new function. |
|
Deletes a function with the given name from the specified project. |
|
Returns a signed URL for downloading deployed function source code. |
|
Returns a signed URL for uploading a function source code. |
|
Returns a function with the given name from the requested project. |
|
Gets the IAM access control policy for a function. |
|
Returns a list of functions that belong to the requested project. |
|
Updates existing function. |
|
Sets the IAM access control policy on the specified function. |
|
Tests the specified permissions against the IAM access control policy for a function. |