Class CloudFunction
Describes a Cloud Function that contains user computation executed in response to an event. It encapsulate
function and triggers configurations.
Inheritance
CloudFunction
Assembly: Google.Apis.CloudFunctions.v1.dll
Syntax
public class CloudFunction : IDirectResponseSchema
Properties
AutomaticUpdatePolicy
Declaration
[JsonProperty("automaticUpdatePolicy")]
public virtual AutomaticUpdatePolicy AutomaticUpdatePolicy { get; set; }
Property Value
AvailableMemoryMb
The amount of memory in MB available for a function. Defaults to 256MB.
Declaration
[JsonProperty("availableMemoryMb")]
public virtual int? AvailableMemoryMb { get; set; }
Property Value
BuildEnvironmentVariables
Build environment variables that shall be available during build time.
Declaration
[JsonProperty("buildEnvironmentVariables")]
public virtual IDictionary<string, string> BuildEnvironmentVariables { get; set; }
Property Value
BuildId
Output only. The Cloud Build ID of the latest successful deployment of the function.
Declaration
[JsonProperty("buildId")]
public virtual string BuildId { get; set; }
Property Value
BuildName
Output only. The Cloud Build Name of the function deployment. projects//locations//builds/.
Declaration
[JsonProperty("buildName")]
public virtual string BuildName { get; set; }
Property Value
BuildServiceAccount
A service account the user provides for use with Cloud Build. The format of this field is
projects/{projectId}/serviceAccounts/{serviceAccountEmail}.
Declaration
[JsonProperty("buildServiceAccount")]
public virtual string BuildServiceAccount { get; set; }
Property Value
BuildWorkerPool
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.
Declaration
[JsonProperty("buildWorkerPool")]
public virtual string BuildWorkerPool { get; set; }
Property Value
Description
User-provided description of a function.
Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
DockerRegistry
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.
Declaration
[JsonProperty("dockerRegistry")]
public virtual string DockerRegistry { get; set; }
Property Value
DockerRepository
User-managed repository created in Artifact Registry to which the function's Docker image will be pushed
after it is built by Cloud Build. May optionally be encrypted with a customer-managed encryption key (CMEK).
If unspecified and docker_registry is not explicitly set to CONTAINER_REGISTRY, GCF will create and use
a default Artifact Registry repository named 'gcf-artifacts' in the 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'.
Declaration
[JsonProperty("dockerRepository")]
public virtual string DockerRepository { get; set; }
Property Value
ETag
Declaration
public virtual string ETag { get; set; }
Property Value
EntryPoint
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.
Declaration
[JsonProperty("entryPoint")]
public virtual string EntryPoint { get; set; }
Property Value
EnvironmentVariables
Environment variables that shall be available during function execution.
Declaration
[JsonProperty("environmentVariables")]
public virtual IDictionary<string, string> EnvironmentVariables { get; set; }
Property Value
EventTrigger
A source that fires events in response to a condition in another service.
Declaration
[JsonProperty("eventTrigger")]
public virtual EventTrigger EventTrigger { get; set; }
Property Value
HttpsTrigger
An HTTPS endpoint type of source that can be triggered via URL.
Declaration
[JsonProperty("httpsTrigger")]
public virtual HttpsTrigger HttpsTrigger { get; set; }
Property Value
IngressSettings
The ingress settings for the function, controlling what traffic can reach it.
Declaration
[JsonProperty("ingressSettings")]
public virtual string IngressSettings { get; set; }
Property Value
KmsKeyName
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.
Declaration
[JsonProperty("kmsKeyName")]
public virtual string KmsKeyName { get; set; }
Property Value
Labels
Labels associated with this Cloud Function.
Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
MaxInstances
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.
Declaration
[JsonProperty("maxInstances")]
public virtual int? MaxInstances { get; set; }
Property Value
MinInstances
A lower bound for the number function instances that may coexist at a given time.
Declaration
[JsonProperty("minInstances")]
public virtual int? MinInstances { get; set; }
Property Value
Name
A user-defined name of the function. Function names must be unique globally and match pattern
projects/*/locations/*/functions/*
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Network
Deprecated: use vpc_connector
Declaration
[JsonProperty("network")]
public virtual string Network { get; set; }
Property Value
OnDeployUpdatePolicy
Declaration
[JsonProperty("onDeployUpdatePolicy")]
public virtual OnDeployUpdatePolicy OnDeployUpdatePolicy { get; set; }
Property Value
Runtime
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.
Declaration
[JsonProperty("runtime")]
public virtual string Runtime { get; set; }
Property Value
SecretEnvironmentVariables
Secret environment variables configuration.
Declaration
[JsonProperty("secretEnvironmentVariables")]
public virtual IList<SecretEnvVar> SecretEnvironmentVariables { get; set; }
Property Value
SecretVolumes
Secret volumes configuration.
Declaration
[JsonProperty("secretVolumes")]
public virtual IList<SecretVolume> SecretVolumes { get; set; }
Property Value
ServiceAccountEmail
The email of the function's service account. If empty, defaults to
{project_id}@appspot.gserviceaccount.com.
Declaration
[JsonProperty("serviceAccountEmail")]
public virtual string ServiceAccountEmail { get; set; }
Property Value
SourceArchiveUrl
The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the
function.
Declaration
[JsonProperty("sourceArchiveUrl")]
public virtual string SourceArchiveUrl { get; set; }
Property Value
SourceRepository
Beta Feature The source repository where a function is hosted.
Declaration
[JsonProperty("sourceRepository")]
public virtual SourceRepository SourceRepository { get; set; }
Property Value
SourceToken
Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for
Firebase function deployments.
Declaration
[JsonProperty("sourceToken")]
public virtual string SourceToken { get; set; }
Property Value
SourceUploadUrl
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)
Declaration
[JsonProperty("sourceUploadUrl")]
public virtual string SourceUploadUrl { get; set; }
Property Value
Status
Output only. Status of the function deployment.
Declaration
[JsonProperty("status")]
public virtual string Status { get; set; }
Property Value
Timeout
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.
Declaration
[JsonProperty("timeout")]
public virtual object Timeout { get; set; }
Property Value
UpdateTime
Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }
Property Value
UpdateTimeDateTimeOffset
Declaration
[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }
Property Value
UpdateTimeRaw
Output only. The last update timestamp of a Cloud Function.
Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
VersionId
Output only. The version identifier of the Cloud Function. Each deployment attempt results in a new version
of a function being created.
Declaration
[JsonProperty("versionId")]
public virtual long? VersionId { get; set; }
Property Value
VpcConnector
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.
Declaration
[JsonProperty("vpcConnector")]
public virtual string VpcConnector { get; set; }
Property Value
VpcConnectorEgressSettings
The egress settings for the connector, controlling what traffic is diverted through it.
Declaration
[JsonProperty("vpcConnectorEgressSettings")]
public virtual string VpcConnectorEgressSettings { get; set; }
Property Value
Implements