Cloud Functions v1 API - Class CloudFunction (2.1.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 encapsulate function and triggers configurations.

Inheritance

Object > CloudFunction

Implements

IMessage<CloudFunction>, IEquatable<CloudFunction>, IDeepCloneable<CloudFunction>, IBufferMessage, IMessage

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Functions.V1

Assembly

Google.Cloud.Functions.V1.dll

Constructors

CloudFunction()

public CloudFunction()

CloudFunction(CloudFunction)

public CloudFunction(CloudFunction other)

Parameter
Name	Description
`other`	`CloudFunction`

Properties

AvailableMemoryMb

public int AvailableMemoryMb { get; set; }

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

Property Value
Type	Description
`Int32`

BuildEnvironmentVariables

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

Build environment variables that shall be available during build time.

Property Value
Type	Description
`MapField<String, String>`

BuildId

public string BuildId { get; set; }

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

Property Value
Type	Description
`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
Type	Description
`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
Type	Description
`String`

CloudFunctionName

public CloudFunctionName CloudFunctionName { get; set; }

CloudFunctionName-typed view over the Name resource name property.

Property Value
Type	Description
`CloudFunctionName`

Description

public string Description { get; set; }

User-provided description of a function.

Property Value
Type	Description
`String`

DockerRegistry

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

Docker Registry to use for this deployment.

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

Property Value
Type	Description
`CloudFunction.Types.DockerRegistry`

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

Property Value
Type	Description
`String`

DockerRepositoryAsRepositoryName

public RepositoryName DockerRepositoryAsRepositoryName { get; set; }

RepositoryName-typed view over the DockerRepository resource name property.

Property Value
Type	Description
`RepositoryName`

EntryPoint

public string EntryPoint { get; set; }

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.

Property Value
Type	Description
`String`

EnvironmentVariables

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

Environment variables that shall be available during function execution.

Property Value
Type	Description
`MapField<String, String>`

EventTrigger

public EventTrigger EventTrigger { get; set; }

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

Property Value
Type	Description
`EventTrigger`

HttpsTrigger

public HttpsTrigger HttpsTrigger { get; set; }

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

Property Value
Type	Description
`HttpsTrigger`

IngressSettings

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

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

Property Value
Type	Description
`CloudFunction.Types.IngressSettings`

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

Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) - Required to protect the function's image.
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
Type	Description
`String`

KmsKeyNameAsCryptoKeyName

public CryptoKeyName KmsKeyNameAsCryptoKeyName { get; set; }

CryptoKeyName-typed view over the KmsKeyName resource name property.

Property Value
Type	Description
`CryptoKeyName`

Labels

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

Labels associated with this Cloud Function.

Property Value
Type	Description
`MapField<String, String>`

MaxInstances

public int MaxInstances { get; set; }

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.

Property Value
Type	Description
`Int32`

MinInstances

public int MinInstances { get; set; }

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

Property Value
Type	Description
`Int32`

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
Type	Description
`String`

Network

public string Network { get; set; }

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

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

Property Value
Type	Description
`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
Type	Description
`String`

SecretEnvironmentVariables

public RepeatedField<SecretEnvVar> SecretEnvironmentVariables { get; }

Secret environment variables configuration.

Property Value
Type	Description
`RepeatedField<SecretEnvVar>`

SecretVolumes

public RepeatedField<SecretVolume> SecretVolumes { get; }

Secret volumes configuration.

Property Value
Type	Description
`RepeatedField<SecretVolume>`

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
Type	Description
`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
Type	Description
`String`

SourceCodeCase

public CloudFunction.SourceCodeOneofCase SourceCodeCase { get; }

Property Value
Type	Description
`CloudFunction.SourceCodeOneofCase`

SourceRepository

public SourceRepository SourceRepository { get; set; }

Beta Feature

The source repository where a function is hosted.

Property Value
Type	Description
`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
Type	Description
`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
Type	Description
`String`

Status

public CloudFunctionStatus Status { get; set; }

Output only. Status of the function deployment.

Property Value
Type	Description
`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
Type	Description
`Duration`

TriggerCase

public CloudFunction.TriggerOneofCase TriggerCase { get; }

Property Value
Type	Description
`CloudFunction.TriggerOneofCase`

UpdateTime

public Timestamp UpdateTime { get; set; }

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

Property Value
Type	Description
`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
Type	Description
`Int64`

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
Type	Description
`String`

VpcConnectorEgressSettings

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

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

Property Value
Type	Description
`CloudFunction.Types.VpcConnectorEgressSettings`