REST Resource: projects.locations.functions

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 (CloudFunctionStatus),
  "entryPoint": string,
  "runtime": string,
  "timeout": string,
  "availableMemoryMb": integer,
  "serviceAccountEmail": string,
  "updateTime": string,
  "versionId": string,
  "labels": {
    string: string,
    ...
  },
  "environmentVariables": {
    string: string,
    ...
  },
  "buildEnvironmentVariables": {
    string: string,
    ...
  },
  "network": string,
  "maxInstances": integer,
  "minInstances": integer,
  "vpcConnector": string,
  "vpcConnectorEgressSettings": enum (VpcConnectorEgressSettings),
  "ingressSettings": enum (IngressSettings),
  "kmsKeyName": string,
  "buildWorkerPool": string,
  "buildId": string,
  "buildName": string,
  "secretEnvironmentVariables": [
    {
      object (SecretEnvVar)
    }
  ],
  "secretVolumes": [
    {
      object (SecretVolume)
    }
  ],
  "sourceToken": string,
  "dockerRepository": string,
  "dockerRegistry": enum (DockerRegistry),

  // Union field source_code can be only one of the following:
  "sourceArchiveUrl": string,
  "sourceRepository": {
    object (SourceRepository)
  },
  "sourceUploadUrl": string
  // End of list of possible types for union field source_code.

  // Union field trigger can be only one of the following:
  "httpsTrigger": {
    object (HttpsTrigger)
  },
  "eventTrigger": {
    object (EventTrigger)
  }
  // End of list of possible types for union field trigger.
}
Fields
name

string

A user-defined name of the function. Function names must be unique globally and match pattern projects/*/locations/*/functions/*

description

string

User-provided description of a function.

status

enum (CloudFunctionStatus)

Output only. Status of the function deployment.

entryPoint

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.

runtime

string

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.

timeout

string (Duration format)

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 's'. Example: "3.5s".

availableMemoryMb

integer

The amount of memory in MB available for a function. Defaults to 256MB.

serviceAccountEmail

string

The email of the function's service account. If empty, defaults to {projectId}@appspot.gserviceaccount.com.

updateTime

string (Timestamp format)

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: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

versionId

string (int64 format)

Output only. The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created.

labels

map (key: string, value: string)

Labels associated with this Cloud Function.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

environmentVariables

map (key: string, value: string)

Environment variables that shall be available during function execution.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

buildEnvironmentVariables

map (key: string, value: string)

Build environment variables that shall be available during build time.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

network

string

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 vpcConnector and will be replaced by it.

See the VPC documentation for more information on connecting Cloud projects.

maxInstances

integer

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.

minInstances

integer

A lower bound for the number function instances that may coexist at a given time.

vpcConnector

string

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 for more information on connecting Cloud projects.

vpcConnectorEgressSettings

enum (VpcConnectorEgressSettings)

The egress settings for the connector, controlling what traffic is diverted through it.

ingressSettings

enum (IngressSettings)

The ingress settings for the function, controlling what traffic can reach it.

kmsKeyName

string

Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function resources.

It must match the pattern projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.

If specified, you must also provide an artifact registry repository using the dockerRepository field that was created with the same KMS crypto key.

The following service accounts need to be granted the role 'Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter)' on the Key/KeyRing/Project/Organization (least access preferred).

  1. Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) - Required to protect the function's image.
  2. Google Storage service account (service-{project_number}@gs-project-accounts.iam.gserviceaccount.com) - Required to protect the function's source code. If this service account does not exist, deploying a function without a KMS key or retrieving the service agent name provisions it. For more information, see https://cloud.google.com/storage/docs/projects#service-agents and https://cloud.google.com/storage/docs/getting-service-agent#gsutil.

Google Cloud Functions delegates access to service agents to protect function resources in internal projects that are not accessible by the end user.

buildWorkerPool

string

Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is projects/{project}/locations/{region}/workerPools/{workerPool} where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool.

If the project id is not the same as the function, then the Cloud Functions Service Agent (service-<project_number>@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project.

buildId

string

Output only. The Cloud Build ID of the latest successful deployment of the function.

buildName

string

Output only. The Cloud Build Name of the function deployment. projects/<project-number>/locations/<region>/builds/<build-id>.

secretEnvironmentVariables[]

object (SecretEnvVar)

Secret environment variables configuration.

secretVolumes[]

object (SecretVolume)

Secret volumes configuration.

sourceToken

string

Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.

dockerRepository

string

User managed repository created in Artifact Registry optionally with a customer managed encryption key. If specified, deployments will use Artifact Registry. If unspecified and the deployment is eligible to use Artifact Registry, GCF will create and use a repository named 'gcf-artifacts' for every deployed region. This is the repository to which the function docker image will be pushed after it is built by Cloud Build.

It must match the pattern projects/{project}/locations/{location}/repositories/{repository}.

Cross-project repositories are not supported. Cross-location repositories are not supported. Repository format must be 'DOCKER'.

dockerRegistry

enum (DockerRegistry)

Docker Registry to use for this deployment.

If dockerRepository field is specified, this field will be automatically set as ARTIFACT_REGISTRY. If unspecified, it currently defaults to CONTAINER_REGISTRY. This field may be overridden by the backend for eligible deployments.

Union field source_code. The location of the function source code. source_code can be only one of the following:
sourceArchiveUrl

string

The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the function.

sourceRepository

object (SourceRepository)

Beta Feature

The source repository where a function is hosted.

sourceUploadUrl

string

The Google Cloud Storage signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl].

The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List)

Union field trigger. An event that triggers the function. trigger can be only one of the following:
httpsTrigger

object (HttpsTrigger)

An HTTPS endpoint type of source that can be triggered via URL.

eventTrigger

object (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

string

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.

deployedUrl

string

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 (SecurityLevel)
}
Fields
url

string

Output only. The deployed url for the function.

securityLevel

enum (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 (FailurePolicy)
  }
}
Fields
eventType

string

Required. The type of event to observe. For example: providers/cloud.storage/eventTypes/object.change and providers/cloud.pubsub/eventTypes/topic.publish.

Event types match pattern providers/*/eventTypes/*.*. The pattern contains:

  1. namespace: For example, cloud.storage and google.firebase.analytics.
  2. resource type: The type of resource on which event occurs. For example, the Google Cloud Storage API includes the type object.
  3. action: The action that generates the event. For example, action for a Google Cloud Storage Object is 'change'. These parts are lower case.
resource

string

Required. The resource(s) from which to observe events, for example, projects/_/buckets/myBucket.

Not all syntactically correct values are accepted by all services. For example:

  1. The authorization model must support it. Google Cloud Functions only allows EventTriggers to be deployed that observe resources in the same project as the CloudFunction.
  2. The resource type must match the pattern expected for an eventType. For example, an EventTrigger that has an eventType of "google.pubsub.topic.publish" should have a resource that matches Google Cloud Pub/Sub topics.

Additionally, some services may support short names when creating an EventTrigger. These will always be returned in the normalized "long" format.

See each service's documentation for supported formats.

service

string

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.

failurePolicy

object (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 (Retry)
  }
}
Fields
retry

object (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.

SecretEnvVar

Configuration for a secret environment variable. It has the information necessary to fetch the secret value from secret manager and expose it as an environment variable.

JSON representation
{
  "key": string,
  "projectId": string,
  "secret": string,
  "version": string
}
Fields
key

string

Name of the environment variable.

projectId

string

Project identifier (preferrably project number but can also be the project ID) of the project that contains the secret. If not set, it will be populated with the function's project assuming that the secret exists in the same project as of the function.

secret

string

Name of the secret in secret manager (not the full resource name).

version

string

Version of the secret (version number or the string 'latest'). It is recommended to use a numeric version for secret environment variables as any updates to the secret value is not reflected until new instances start.

SecretVolume

Configuration for a secret volume. It has the information necessary to fetch the secret value from secret manager and make it available as files mounted at the requested paths within the application container. Secret value is not a part of the configuration. Every filesystem read operation performs a lookup in secret manager to retrieve the secret value.

JSON representation
{
  "mountPath": string,
  "projectId": string,
  "secret": string,
  "versions": [
    {
      object (SecretVersion)
    }
  ]
}
Fields
mountPath

string

The path within the container to mount the secret volume. For example, setting the mountPath as /etc/secrets would mount the secret value files under the /etc/secrets directory. This directory will also be completely shadowed and unavailable to mount any other secrets.

Recommended mount paths: /etc/secrets Restricted mount paths: /cloudsql, /dev/log, /pod, /proc, /var/log

projectId

string

Project identifier (preferrably project number but can also be the project ID) of the project that contains the secret. If not set, it will be populated with the function's project assuming that the secret exists in the same project as of the function.

secret

string

Name of the secret in secret manager (not the full resource name).

versions[]

object (SecretVersion)

List of secret versions to mount for this secret. If empty, the latest version of the secret will be made available in a file named after the secret under the mount point.

SecretVersion

Configuration for a single version.

JSON representation
{
  "version": string,
  "path": string
}
Fields
version

string

Version of the secret (version number or the string 'latest'). It is preferrable to use latest version with secret volumes as secret value changes are reflected immediately.

path

string

Relative path of the file under the mount path where the secret value for this version will be fetched and made available. For example, setting the mountPath as '/etc/secrets' and path as /secret_foo would mount the secret value file at /etc/secrets/secret_foo.

DockerRegistry

Docker Registry to use for storing function Docker images.

Enums
DOCKER_REGISTRY_UNSPECIFIED Unspecified.
CONTAINER_REGISTRY Docker images will be stored in multi-regional Container Registry repositories named gcf.
ARTIFACT_REGISTRY Docker images will be stored in regional Artifact Registry repositories. By default, GCF will create and use repositories named gcf-artifacts in every region in which a function is deployed. But the repository to use can also be specified by the user using the dockerRepository field.

Methods

call

Synchronously invokes a deployed Cloud Function.

create

Creates a new function.

delete

Deletes a function with the given name from the specified project.

generateDownloadUrl

Returns a signed URL for downloading deployed function source code.

generateUploadUrl

Returns a signed URL for uploading a function source code.

get

Returns a function with the given name from the requested project.

getIamPolicy

Gets the IAM access control policy for a function.

list

Returns a list of functions that belong to the requested project.

patch

Updates existing function.

setIamPolicy

Sets the IAM access control policy on the specified function.

testIamPermissions

Tests the specified permissions against the IAM access control policy for a function.