Class BuildConfig (1.15.0)

Version 1.15.0

• 1.18.1 (latest)
• 1.18.0
• 1.16.5
• 1.15.0
• 1.14.0
• 1.13.2
• 1.12.0
• 1.11.0
• 1.10.1
• 1.9.0
• 1.8.3
• 1.7.0
• 1.6.0
• 1.5.2
• 1.4.0
• 1.3.1
• 1.2.0
• 1.1.1
• 1.0.4
• 0.7.2
• 0.6.1
• 0.5.1
• 0.4.0
• 0.1.0

BuildConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

Attributes
Name	Description
build	str Output only. The Cloud Build name of the latest successful deployment of the function.
runtime	str 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
entry_point	str 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.
source	google.cloud.functions_v2.types.Source The location of the function source code.
source_provenance	google.cloud.functions_v2.types.SourceProvenance Output only. A permanent fixed identifier for source.
worker_pool	str 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-
environment_variables	MutableMapping[str, str] User-provided build-time environment variables for the function
docker_registry	google.cloud.functions_v2.types.BuildConfig.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. 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.
docker_repository	str User managed repository created in Artifact Registry optionally with a customer managed encryption key. This is the repository to which the function docker image will be pushed after it is built by Cloud Build. If unspecified, 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'.

Classes

DockerRegistry

DockerRegistry(value)

Docker Registry to use for storing function Docker images.

Values: DOCKER_REGISTRY_UNSPECIFIED (0): Unspecified. CONTAINER_REGISTRY (1): Docker images will be stored in multi-regional Container Registry repositories named gcf. ARTIFACT_REGISTRY (2): Docker images will be stored in regional Artifact Registry repositories. By default, GCF will create and use repositories named gcf-artifacts in every region in which a function is deployed. But the repository to use can also be specified by the user using the docker_repository field.

EnvironmentVariablesEntry

EnvironmentVariablesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, .Message] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.