BuildConfig class final
Describes the Build step of the function that builds a container from the given source.
- Inheritance
-
- Object
- ProtoMessage
- BuildConfig
Constructors
-
BuildConfig({AutomaticUpdatePolicy? automaticUpdatePolicy, OnDeployUpdatePolicy? onDeployUpdatePolicy, String build = '', String runtime = '', String entryPoint = '', Source? source, SourceProvenance? sourceProvenance, String workerPool = '', Map<
String, String> environmentVariables = const {}, BuildConfig_DockerRegistry dockerRegistry = BuildConfig_DockerRegistry.$default, String dockerRepository = '', String serviceAccount = ''}) -
BuildConfig.fromJson(Map<
String, dynamic> json) -
factory
Properties
- automaticUpdatePolicy → AutomaticUpdatePolicy?
-
final
- build → String
-
Output only. The Cloud Build name of the latest successful deployment of
the function.
final
- dockerRegistry → 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.
Deprecated: As of March 2025,
CONTAINER_REGISTRYoption 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.final - dockerRepository → String
-
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.
final
- entryPoint → String
-
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.final -
environmentVariables
→ Map<
String, String> -
User-provided build-time environment variables for the function
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- onDeployUpdatePolicy → OnDeployUpdatePolicy?
-
final
- qualifiedName → String
-
The fully qualified name of this message, i.e.,
google.protobuf.Durationorgoogle.rpc.ErrorInfo.finalinherited - runtime → String
-
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
gcloudcommand reference.final - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- serviceAccount → String
-
Service account to be used for building the container. The format of this
field is
projects/{projectId}/serviceAccounts/{serviceAccountEmail}.final - source → Source?
-
The location of the function source code.
final
- sourceProvenance → SourceProvenance?
-
Output only. A permanent fixed identifier for source.
final
- workerPool → String
-
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.final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Object -
override
-
toString(
) → String -
A string representation of this object.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Constants
- fullyQualifiedName → const String