BuildConfig

import type { BuildConfig } from "https://googleapis.deno.dev/v1/cloudfunctions:v2.ts";

Describes the Build step of the function that builds a container from the given source.

interface BuildConfig {

automaticUpdatePolicy?: AutomaticUpdatePolicy;

readonly build?: string;

dockerRegistry?: "DOCKER_REGISTRY_UNSPECIFIED" | "CONTAINER_REGISTRY" | "ARTIFACT_REGISTRY";

dockerRepository?: string;

entryPoint?: string;

environmentVariables?: {

[key: string]: string;

};

onDeployUpdatePolicy?: OnDeployUpdatePolicy;

runtime?: string;

serviceAccount?: string;

source?: Source;

readonly sourceProvenance?: SourceProvenance;

sourceToken?: string;

workerPool?: string;

}

§Properties

automaticUpdatePolicy?: AutomaticUpdatePolicy

[src]

readonly build?: string

[src]

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

dockerRegistry?: "DOCKER_REGISTRY_UNSPECIFIED" | "CONTAINER_REGISTRY" | "ARTIFACT_REGISTRY"

[src]

Docker Registry to use for this deployment. This configuration is only applicable to 1st Gen functions, 2nd Gen functions can only use Artifact Registry. 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.

dockerRepository?: string

[src]

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}. Cross-project repositories are not supported. Cross-location repositories are not supported. Repository format must be 'DOCKER'.

entryPoint?: string

[src]

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.

environmentVariables?: {

[key: string]: string;

}

[src]

User-provided build-time environment variables for the function

onDeployUpdatePolicy?: OnDeployUpdatePolicy

[src]

runtime?: string

[src]

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.

serviceAccount?: string

[src]

[Preview] Service account to be used for building the container

source?: Source

[src]

The location of the function source code.

readonly sourceProvenance?: SourceProvenance

[src]

Output only. A permanent fixed identifier for source.

sourceToken?: string

[src]

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

workerPool?: string

[src]

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.