REST Resource: projects.locations.functions

Resource: Function

Describes a Cloud Function that contains user computation executed in response to an event. It encapsulates function and trigger configurations.

JSON representation 
{
  "name": string,
  "description": string,
  "buildConfig": {
    object (BuildConfig)
  },
  "serviceConfig": {
    object (ServiceConfig)
  },
  "eventTrigger": {
    object (EventTrigger)
  },
  "state": enum (State),
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "stateMessages": [
    {
      object (StateMessage)
    }
  ],
  "environment": enum (Environment),
  "url": string,
  "kmsKeyName": string,
  "satisfiesPzs": boolean
}
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.
buildConfig

object (BuildConfig)

Describes the Build step of the function that builds a container from the given source.
serviceConfig

object (ServiceConfig)

Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).
eventTrigger

object (EventTrigger)

An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service.
state

enum (State)

Output only. State of the function.
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".
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" }.
stateMessages[]

object (StateMessage)

Output only. State Messages for this Cloud Function.
environment

enum (Environment)

Describe whether the function is 1st Gen or 2nd Gen.
url

string

Output only. The deployed url for the function.
kmsKeyName

string

[Preview] 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}.
satisfiesPzs

boolean

Output only. Reserved for future use.

BuildConfig

Describes the Build step of the function that builds a container from the given source.

JSON representation 
{
  "build": string,
  "runtime": string,
  "entryPoint": string,
  "source": {
    object (Source)
  },
  "sourceProvenance": {
    object (SourceProvenance)
  },
  "workerPool": string,
  "environmentVariables": {
    string: string,
    ...
  },
  "dockerRegistry": enum (DockerRegistry),
  "dockerRepository": string,
  "serviceAccount": string,
  "sourceToken": string,

  // Union field runtime_update_policy can be only one of the following:
  "automaticUpdatePolicy": {
    object (AutomaticUpdatePolicy)
  },
  "onDeployUpdatePolicy": {
    object (OnDeployUpdatePolicy)
  }
  // End of list of possible types for union field runtime_update_policy.
}
Fields
build

string

Output only. The Cloud Build name of the latest successful deployment of the function.
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.
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.
source

object (Source)

The location of the function source code.
sourceProvenance

object (SourceProvenance)

Output only. A permanent fixed identifier for source.
workerPool

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-@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project.
environmentVariables

map (key: string, value: string)

User-provided build-time environment variables for the function

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

enum (DockerRegistry)

Docker Registry to use for this deployment. This configuration is only applicable to 1st Gen functions, 2nd Gen functions can only use Artifact Registry.

If unspecified, it defaults to ARTIFACT_REGISTRY. If dockerRepository field is specified, this field should either be left unspecified or set to ARTIFACT_REGISTRY.
dockerRepository

string

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

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'.
serviceAccount

string

Service account to be used for building the container. The format of this field is projects/{projectId}/serviceAccounts/{serviceAccountEmail}.
sourceToken

string

An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.
Union field runtime_update_policy. This controls when security patches are applied to the runtime environment. runtime_update_policy can be only one of the following:
automaticUpdatePolicy

object (AutomaticUpdatePolicy)
onDeployUpdatePolicy

object (OnDeployUpdatePolicy)

AutomaticUpdatePolicy

This type has no fields.

Security patches are applied automatically to the runtime without requiring the function to be redeployed.

OnDeployUpdatePolicy

Security patches are only applied when a function is redeployed.

JSON representation 
{
  "runtimeVersion": string
}
Fields
runtimeVersion

string

Output only. contains the runtime version which was used during latest function deployment.

Source

The location of the function source code.

JSON representation 
{

  // Union field source can be only one of the following:
  "storageSource": {
    object (StorageSource)
  },
  "repoSource": {
    object (RepoSource)
  },
  "gitUri": string
  // End of list of possible types for union field source.
}
Fields
Union field source. Location of the source. At least one source needs to be provided for the deployment to succeed. source can be only one of the following:
storageSource

object (StorageSource)

If provided, get the source from this location in Google Cloud Storage.
repoSource

object (RepoSource)

If provided, get the source from this location in a Cloud Source Repository.
gitUri

string

If provided, get the source from GitHub repository. This option is valid only for GCF 1st Gen function. Example: https://github.com///blob//

StorageSource

Location of the source in an archive file in Google Cloud Storage.

JSON representation 
{
  "bucket": string,
  "object": string,
  "generation": string
}
Fields
bucket

string

Google Cloud Storage bucket containing the source (see Bucket Name Requirements).
object

string

Google Cloud Storage object containing the source.

This object must be a gzipped archive file (.tar.gz) containing source to build.
generation

string (int64 format)

Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.

RepoSource

Location of the source in a Google Cloud Source Repository.

JSON representation 
{
  "projectId": string,
  "repoName": string,
  "dir": string,

  // Union field revision can be only one of the following:
  "branchName": string,
  "tagName": string,
  "commitSha": string
  // End of list of possible types for union field revision.
}
Fields
projectId

string

ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.
repoName

string

Name of the Cloud Source Repository.
dir

string

Directory, relative to the source root, in which to run the build.

This must be a relative path. If a step's dir is specified and is an absolute path, this value is ignored for that step's execution. eg. helloworld (no leading slash allowed)
Union field revision. A revision within the Cloud Source Repository must be specified in one of these ways. revision can be only one of the following:
branchName

string

Regex matching branches to build.

The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
tagName

string

Regex matching tags to build.

The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
commitSha

string

Explicit commit SHA to build.

SourceProvenance

Provenance of the source. Ways to find the original source, or verify that some source was used for this build.

JSON representation 
{
  "resolvedStorageSource": {
    object (StorageSource)
  },
  "resolvedRepoSource": {
    object (RepoSource)
  },
  "gitUri": string
}
Fields
resolvedStorageSource

object (StorageSource)

A copy of the build's source.storage_source, if exists, with any generations resolved.
resolvedRepoSource

object (RepoSource)

A copy of the build's source.repo_source, if exists, with any revisions resolved.
gitUri

string

A copy of the build's source.git_uri, if exists, with any commits resolved.

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.

ServiceConfig

Describes the Service being deployed. Currently Supported : Cloud Run (fully managed).

JSON representation 
{
  "service": string,
  "timeoutSeconds": integer,
  "availableMemory": string,
  "availableCpu": string,
  "environmentVariables": {
    string: string,
    ...
  },
  "maxInstanceCount": integer,
  "minInstanceCount": integer,
  "vpcConnector": string,
  "vpcConnectorEgressSettings": enum (VpcConnectorEgressSettings),
  "ingressSettings": enum (IngressSettings),
  "uri": string,
  "serviceAccountEmail": string,
  "allTrafficOnLatestRevision": boolean,
  "secretEnvironmentVariables": [
    {
      object (SecretEnvVar)
    }
  ],
  "secretVolumes": [
    {
      object (SecretVolume)
    }
  ],
  "revision": string,
  "maxInstanceRequestConcurrency": integer,
  "securityLevel": enum (SecurityLevel)
}
Fields
service

string

Output only. Name of the service associated with a Function. The format of this field is projects/{project}/locations/{region}/services/{service}
timeoutSeconds

integer

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.
availableMemory

string

The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes. See https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go a full description.
availableCpu

string

The number of CPUs used in a single container instance. Default value is calculated from available memory. Supports the same values as Cloud Run, see https://cloud.google.com/run/docs/reference/rest/v1/Container#resourcerequirements Example: "1" indicates 1 vCPU
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" }.
maxInstanceCount

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.
minInstanceCount

integer

The limit on the minimum number of function instances that may coexist at a given time.

Function instances are kept in idle state for a short period after they finished executing the request to reduce cold start time for subsequent requests. Setting a minimum instance count will ensure that the given number of instances are kept running in idle state always. This can help with cold start times when jump in incoming request count occurs after the idle instance would have been stopped in the default case.
vpcConnector

string

The Serverless VPC Access connector that this cloud function can connect to. The format of this field is projects/*/locations/*/connectors/*.
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.
uri

string

Output only. URI of the Service deployed.
serviceAccountEmail

string

The email of the service's service account. If empty, defaults to {project_number}[email protected].
allTrafficOnLatestRevision

boolean

Whether 100% of traffic is routed to the latest revision. On functions.create and functions.patch, when set to true, the revision being deployed will serve 100% of traffic, ignoring any traffic split settings, if any. On functions.get, true will be returned if the latest revision is serving 100% of traffic.
secretEnvironmentVariables[]

object (SecretEnvVar)

Secret environment variables configuration.
secretVolumes[]

object (SecretVolume)

Secret volumes configuration.
revision

string

Output only. The name of service revision.
maxInstanceRequestConcurrency

integer

Sets the maximum number of concurrent requests that each instance can receive. Defaults to 1.
securityLevel

enum (SecurityLevel)

Security level configure whether the function only accepts https. This configuration is only applicable to 1st Gen functions with Http trigger. By default https is optional for 1st Gen functions; 2nd Gen functions are https ONLY.

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 (preferably project number but can also be the project ID) of the project that contains the secret. If not set, it is assumed that the secret is in the same project as 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.

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 path: /etc/secrets
projectId

string

Project identifier (preferably project number but can also be the project ID) of the project that contains the secret. If not set, it is assumed that the secret is in the same project as 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 preferable 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.

SecurityLevel

Available security level settings.

This enforces security protocol on function URL.

Security level is only configurable for 1st Gen functions, If unspecified, SECURE_OPTIONAL will be used. 2nd Gen functions are SECURE_ALWAYS ONLY.

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 to be sent from another service.

JSON representation 
{
  "trigger": string,
  "triggerRegion": string,
  "eventType": string,
  "eventFilters": [
    {
      object (EventFilter)
    }
  ],
  "pubsubTopic": string,
  "serviceAccountEmail": string,
  "retryPolicy": enum (RetryPolicy),
  "channel": string,
  "service": string
}
Fields
trigger

string

Output only. The resource name of the Eventarc trigger. The format of this field is projects/{project}/locations/{region}/triggers/{trigger}.
triggerRegion

string

The region that the trigger will be in. The trigger will only receive events originating in this region. It can be the same region as the function, a different region or multi-region, or the global region. If not provided, defaults to the same region as the function.
eventType

string

Required. The type of event to observe. For example: google.cloud.audit.log.v1.written or google.cloud.pubsub.topic.v1.messagePublished.
eventFilters[]

object (EventFilter)

Criteria used to filter events.
pubsubTopic

string

Optional. The name of a Pub/Sub topic in the same project that will be used as the transport topic for the event delivery. Format: projects/{project}/topics/{topic}.

This is only valid for events of type google.cloud.pubsub.topic.v1.messagePublished. The topic provided here will not be deleted at function deletion.
serviceAccountEmail

string

Optional. The email of the trigger's service account. The service account must have permission to invoke Cloud Run services, the permission is run.routes.invoke. If empty, defaults to the Compute Engine default service account: {project_number}[email protected].
retryPolicy

enum (RetryPolicy)

Optional. If unset, then defaults to ignoring failures (i.e. not retrying them).
channel

string

Optional. The name of the channel associated with the trigger in projects/{project}/locations/{location}/channels/{channel} format. You must provide a channel to receive events from Eventarc SaaS partners.
service

string

Optional. The hostname of the service that 1st Gen function 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.

The field is only applicable to 1st Gen functions.

EventFilter

Filters events based on exact matches on the CloudEvents attributes.

JSON representation 
{
  "attribute": string,
  "value": string,
  "operator": string
}
Fields
attribute

string

Required. The name of a CloudEvents attribute.
value

string

Required. The value for the attribute.
operator

string

Optional. The operator used for matching the events with the value of the filter. If not specified, only events that have an exact key-value pair specified in the filter are matched. The only allowed value is match-path-pattern.

RetryPolicy

Describes the retry policy in case of function's execution failure. Retried execution is charged as any other execution.

Enums
RETRY_POLICY_UNSPECIFIED Not specified.
RETRY_POLICY_DO_NOT_RETRY Do not retry.
RETRY_POLICY_RETRY Retry on any failure, retry up to 7 days with an exponential backoff (capped at 10 seconds).

State

Describes the current state of the function.

Enums
STATE_UNSPECIFIED Not specified. Invalid state.
ACTIVE Function has been successfully deployed and is serving.
FAILED Function deployment failed and the function is not serving.
DEPLOYING Function is being created or updated.
DELETING 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.

StateMessage

Informational messages about the state of the Cloud Function or Operation.

JSON representation 
{
  "severity": enum (Severity),
  "type": string,
  "message": string
}
Fields
severity

enum (Severity)

Severity of the state message.
type

string

One-word CamelCase type of the state message.
message

string

The message.

Severity

Severity of the state message.

Enums
SEVERITY_UNSPECIFIED Not specified. Invalid severity.
ERROR ERROR-level severity.
WARNING WARNING-level severity.
INFO INFO-level severity.

Environment

The environment the function is hosted on.

Enums
ENVIRONMENT_UNSPECIFIED Unspecified
GEN_1 Gen 1
GEN_2 Gen 2

Methods

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 access control policy for a resource.

list

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

patch

 Updates existing function.

setIamPolicy

 Sets the access control policy on the specified resource.

testIamPermissions

 Returns permissions that a caller has on the specified resource.