Cloud Functions v1 API - Class CloudFunction (2.2.0)

public sealed class CloudFunction : IMessage<CloudFunction>, IEquatable<CloudFunction>, IDeepCloneable<CloudFunction>, IBufferMessage, IMessage

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 encapsulates function and triggers configurations.

Inheritance

object > CloudFunction

Namespace

Google.Cloud.Functions.V1

Assembly

Google.Cloud.Functions.V1.dll

Constructors

CloudFunction()

public CloudFunction()

CloudFunction(CloudFunction)

public CloudFunction(CloudFunction other)
Parameter
NameDescription
otherCloudFunction

Properties

AvailableMemoryMb

public int AvailableMemoryMb { get; set; }

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

Property Value
TypeDescription
int

BuildEnvironmentVariables

public MapField<string, string> BuildEnvironmentVariables { get; }

Build environment variables that shall be available during build time.

Property Value
TypeDescription
MapFieldstringstring

BuildId

public string BuildId { get; set; }

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

Property Value
TypeDescription
string

BuildName

public string BuildName { get; set; }

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

Property Value
TypeDescription
string

BuildWorkerPool

public string BuildWorkerPool { get; set; }

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.

Property Value
TypeDescription
string

CloudFunctionName

public CloudFunctionName CloudFunctionName { get; set; }

CloudFunctionName-typed view over the Name resource name property.

Property Value
TypeDescription
CloudFunctionName

Description

public string Description { get; set; }

User-provided description of a function.

Property Value
TypeDescription
string

DockerRegistry

public CloudFunction.Types.DockerRegistry DockerRegistry { get; set; }

Docker Registry to use for this deployment.

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

Property Value
TypeDescription
CloudFunctionTypesDockerRegistry

DockerRepository

public string DockerRepository { get; set; }

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

Property Value
TypeDescription
string

DockerRepositoryAsRepositoryName

public RepositoryName DockerRepositoryAsRepositoryName { get; set; }

RepositoryName-typed view over the DockerRepository resource name property.

Property Value
TypeDescription
RepositoryName

EntryPoint

public string EntryPoint { get; set; }

The name of the function (as defined in source code) that is executed. Defaults to the resource name suffix, if not specified. For backward compatibility, if function with given name is not found, the system tries to use the function named "function". For Node.js, this is the name of a function exported by the module as specified in source_location.

Property Value
TypeDescription
string

EnvironmentVariables

public MapField<string, string> EnvironmentVariables { get; }

Environment variables that shall be available during function execution.

Property Value
TypeDescription
MapFieldstringstring

EventTrigger

public EventTrigger EventTrigger { get; set; }

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

Property Value
TypeDescription
EventTrigger

HttpsTrigger

public HttpsTrigger HttpsTrigger { get; set; }

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

Property Value
TypeDescription
HttpsTrigger

IngressSettings

public CloudFunction.Types.IngressSettings IngressSettings { get; set; }

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

Property Value
TypeDescription
CloudFunctionTypesIngressSettings

KmsKeyName

public string KmsKeyName { get; set; }

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.

Property Value
TypeDescription
string

KmsKeyNameAsCryptoKeyName

public CryptoKeyName KmsKeyNameAsCryptoKeyName { get; set; }

CryptoKeyName-typed view over the KmsKeyName resource name property.

Property Value
TypeDescription
CryptoKeyName

Labels

public MapField<string, string> Labels { get; }

Labels associated with this Cloud Function.

Property Value
TypeDescription
MapFieldstringstring

MaxInstances

public int MaxInstances { get; set; }

The limit on the maximum number of function instances that can coexist at a given time.

In some cases, such as rapid traffic surges, Cloud Functions can for a short period of time create more instances than the specified max instances limit. If your function cannot tolerate this temporary behavior, you might 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.

Property Value
TypeDescription
int

MinInstances

public int MinInstances { get; set; }

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

Property Value
TypeDescription
int

Name

public string Name { get; set; }

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

Property Value
TypeDescription
string

Network

public string Network { get; set; }

The Serverless VPC Access connector that this cloud function can connect to. It can be either the fully qualified URI, or the short name of the connector resource. If the connector name is used, the connector must belong to the same project as the function. 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 for more information on connecting Cloud projects.

Property Value
TypeDescription
string

Runtime

public string Runtime { get; set; }

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.

Property Value
TypeDescription
string

SecretEnvironmentVariables

public RepeatedField<SecretEnvVar> SecretEnvironmentVariables { get; }

Secret environment variables configuration.

Property Value
TypeDescription
RepeatedFieldSecretEnvVar

SecretVolumes

public RepeatedField<SecretVolume> SecretVolumes { get; }

Secret volumes configuration.

Property Value
TypeDescription
RepeatedFieldSecretVolume

ServiceAccountEmail

public string ServiceAccountEmail { get; set; }

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

Property Value
TypeDescription
string

SourceArchiveUrl

public string SourceArchiveUrl { get; set; }

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

Property Value
TypeDescription
string

SourceCodeCase

public CloudFunction.SourceCodeOneofCase SourceCodeCase { get; }
Property Value
TypeDescription
CloudFunctionSourceCodeOneofCase

SourceRepository

public SourceRepository SourceRepository { get; set; }

Beta Feature

The source repository where a function is hosted.

Property Value
TypeDescription
SourceRepository

SourceToken

public string SourceToken { get; set; }

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

Property Value
TypeDescription
string

SourceUploadUrl

public string SourceUploadUrl { get; set; }

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)

Property Value
TypeDescription
string

Status

public CloudFunctionStatus Status { get; set; }

Output only. Status of the function deployment.

Property Value
TypeDescription
CloudFunctionStatus

Timeout

public Duration Timeout { get; set; }

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.

Property Value
TypeDescription
Duration

TriggerCase

public CloudFunction.TriggerOneofCase TriggerCase { get; }
Property Value
TypeDescription
CloudFunctionTriggerOneofCase

UpdateTime

public Timestamp UpdateTime { get; set; }

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

Property Value
TypeDescription
Timestamp

VersionId

public long VersionId { get; set; }

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

Property Value
TypeDescription
long

VpcConnector

public string VpcConnector { get; set; }

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.

Property Value
TypeDescription
string

VpcConnectorEgressSettings

public CloudFunction.Types.VpcConnectorEgressSettings VpcConnectorEgressSettings { get; set; }

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

Property Value
TypeDescription
CloudFunctionTypesVpcConnectorEgressSettings