Cloud Functions v1 API - Class CloudFunction (2.6.0)

Reference documentation and code samples for the Cloud Functions v1 API class CloudFunction.

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

See the comment next to this message for more details.

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

Build environment variables that shall be available during build time.

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

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

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.

CloudFunctionName-typed view over the Name resource name property.

User-provided description of a function.

Docker Registry to use for this deployment.

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

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

RepositoryName-typed view over the DockerRepository resource name property.

The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix (ID of the function), if not specified.

Environment variables that shall be available during function execution.

A source that fires events in response to a condition in another service.

Gets whether the "source_archive_url" field is set

Gets whether the "source_upload_url" field is set

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

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

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

CryptoKeyName-typed view over the KmsKeyName resource name property.

Labels associated with this Cloud Function.

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.

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

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

Deprecated: use vpc_connector

See the comment next to this message for more details.

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.

Secret environment variables configuration.

Secret volumes configuration.

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

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

Beta Feature

The source repository where a function is hosted.

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

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)

Output only. Status of the function deployment.

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.

Output only. The last update timestamp of a Cloud Function.

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

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.

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