Class BuildConfig
Describes the Build step of the function that builds a container from the given source.
Assembly: Google.Apis.CloudFunctions.v2beta.dll
Syntax
public class BuildConfig : IDirectResponseSchema
Properties
AutomaticUpdatePolicy
Declaration
[JsonProperty("automaticUpdatePolicy")]
public virtual AutomaticUpdatePolicy AutomaticUpdatePolicy { get; set; }
Property Value
Build
Output only. The Cloud Build name of the latest successful deployment of the function.
Declaration
[JsonProperty("build")]
public virtual string Build { get; set; }
Property Value
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. Deprecated: as of March 2025, CONTAINER_REGISTRY option is
no longer available in response to Container Registry's deprecation:
https://cloud.google.com/artifact-registry/docs/transition/transition-from-gcr Please use Artifact Registry
instead, which is the default choice. 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
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}. 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, 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.
Declaration
[JsonProperty("entryPoint")]
public virtual string EntryPoint { get; set; }
Property Value
EnvironmentVariables
User-provided build-time environment variables for the function
Declaration
[JsonProperty("environmentVariables")]
public virtual IDictionary<string, string> EnvironmentVariables { 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
ServiceAccount
Service account to be used for building the container. The format of this field is
projects/{projectId}/serviceAccounts/{serviceAccountEmail}.
Declaration
[JsonProperty("serviceAccount")]
public virtual string ServiceAccount { get; set; }
Property Value
Source
The location of the function source code.
Declaration
[JsonProperty("source")]
public virtual Source Source { get; set; }
Property Value
SourceProvenance
Output only. A permanent fixed identifier for source.
Declaration
[JsonProperty("sourceProvenance")]
public virtual SourceProvenance SourceProvenance { get; set; }
Property Value
SourceToken
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
WorkerPool
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("workerPool")]
public virtual string WorkerPool { get; set; }
Property Value
Implements