BuildConfig class
Describes the Build step of the function that builds a container from the given source.
- Inheritance
-
- Object
- GeneratedMessage
- BuildConfig
Constructors
-
BuildConfig({String? build, String? runtime, String? entryPoint, Source? source, String? workerPool, Map<
String, String> ? environmentVariables, String? dockerRepository, SourceProvenance? sourceProvenance, String? buildpackStack, BuildConfig_DockerRegistry? dockerRegistry}) -
factory
-
BuildConfig.fromBuffer(List<
int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY]) -
factory
- BuildConfig.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
-
factory
Properties
- build ↔ String
-
Output only. The Cloud Build name of the latest successful deployment of
the function.
getter/setter pair
- buildpackStack ↔ String
-
Specifies one of the Google provided buildpack stacks.
getter/setter pair
- dockerRegistry ↔ BuildConfig_DockerRegistry
-
Optional. Docker Registry to use for this deployment. This configuration is
only applicable to 1st Gen functions, 2nd Gen functions can only use
Artifact Registry.
getter/setter pair
- dockerRepository ↔ String
-
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.
getter/setter pair
- 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.getter/setter pair -
environmentVariables
→ Map<
String, String> -
User-provided build-time environment variables for the function
no setter
- eventPlugin → EventPlugin?
-
Subclasses can override this getter to be notified of changes
to protobuf fields.
no setterinherited
- hashCode → int
-
Calculates a hash code based on the contents of the protobuf.
no setterinherited
- info_ → BuilderInfo
-
no setteroverride
- isFrozen → bool
-
Returns
trueif this message is marked read-only. Otherwisefalse.no setterinherited - 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.getter/setter pair - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- source ↔ Source
-
The location of the function source code.
getter/setter pair
- sourceProvenance ↔ SourceProvenance
-
Output only. A permanent fixed identifier for source.
getter/setter pair
- unknownFields → UnknownFieldSet
-
no setterinherited
- 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.getter/setter pair
Methods
-
addExtension(
Extension extension, Object? value) → void -
Adds an extension field value to a repeated field.
inherited
-
check(
) → void -
inherited
-
clear(
) → void -
Clears all data that was set in this message.
inherited
-
clearBuild(
) → void -
clearBuildpackStack(
) → void -
clearDockerRegistry(
) → void -
clearDockerRepository(
) → void -
clearEntryPoint(
) → void -
clearExtension(
Extension extension) → void -
Clears an extension field and also removes the extension.
inherited
-
clearField(
int tagNumber) → void -
Clears the contents of a given field.
inherited
-
clearRuntime(
) → void -
clearSource(
) → void -
clearSourceProvenance(
) → void -
clearWorkerPool(
) → void -
clone(
) → BuildConfig -
Creates a deep copy of the fields in this message.
(The generated code uses mergeFromMessage.)
override
-
copyWith(
void updates(BuildConfig)) → BuildConfig -
Apply
updatesto a copy of this message.override -
createEmptyInstance(
) → BuildConfig -
Creates an empty instance of the same message type as this.
override
-
createMapField<
K, V> (int tagNumber, MapFieldInfo< K, V> fi) → Map<K, V> -
Creates a Map representing a map field.
inherited
-
createRepeatedField<
T> (int tagNumber, FieldInfo< T> fi) → List<T> -
Creates List implementing a mutable repeated field.
inherited
-
ensureSource(
) → Source -
ensureSourceProvenance(
) → SourceProvenance -
extensionsAreInitialized(
) → bool -
inherited
-
freeze(
) → GeneratedMessage -
Make this message read-only.
inherited
-
getDefaultForField(
int tagNumber) → dynamic -
Returns the default value for the given field.
inherited
-
getExtension(
Extension extension) → dynamic -
Returns the value of
extension.inherited -
getField(
int tagNumber) → dynamic -
Returns the value of the field associated with
tagNumber, or the default value if it is not set.inherited -
getFieldOrNull(
int tagNumber) → dynamic -
Returns the value of a field, ignoring any defaults.
inherited
-
getTagNumber(
String fieldName) → int? -
inherited
-
hasBuild(
) → bool -
hasBuildpackStack(
) → bool -
hasDockerRegistry(
) → bool -
hasDockerRepository(
) → bool -
hasEntryPoint(
) → bool -
hasExtension(
Extension extension) → bool -
Returns
trueif a value ofextensionis present.inherited -
hasField(
int tagNumber) → bool -
Whether this message has a field associated with
tagNumber.inherited -
hasRequiredFields(
) → bool -
Whether the message has required fields.
inherited
-
hasRuntime(
) → bool -
hasSource(
) → bool -
hasSourceProvenance(
) → bool -
hasWorkerPool(
) → bool -
isInitialized(
) → bool -
Whether all required fields in the message and embedded messages are set.
inherited
-
mergeFromBuffer(
List< int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges serialized protocol buffer data into this message.
inherited
-
mergeFromCodedBufferReader(
CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
inherited
-
mergeFromJson(
String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges field values from
data, a JSON object, encoded as described byGeneratedMessage.writeToJson.inherited -
mergeFromJsonMap(
Map< String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges field values from a JSON object represented as a Dart map.
inherited
-
mergeFromMessage(
GeneratedMessage other) → void -
Merges the contents of the
otherinto this message.inherited -
mergeFromProto3Json(
Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void -
Merges field values from
json, a JSON object using proto3 encoding.inherited -
mergeUnknownFields(
UnknownFieldSet unknownFieldSet) → void -
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
setExtension(
Extension extension, Object value) → void -
Sets the value of a non-repeated extension field to
value.inherited -
setField(
int tagNumber, Object value) → void -
Sets the value of a field by its
tagNumber.inherited -
toBuilder(
) → GeneratedMessage -
Creates a writable, shallow copy of this message.
inherited
-
toDebugString(
) → String -
Returns a String representation of this message.
inherited
-
toProto3Json(
{TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object? -
Returns an Object representing Proto3 JSON serialization of
this.inherited -
toString(
) → String -
Returns a String representation of this message.
inherited
-
writeToBuffer(
) → Uint8List -
inherited
-
writeToCodedBufferWriter(
CodedBufferWriter output) → void -
inherited
-
writeToJson(
) → String -
Returns a JSON string that encodes this message.
inherited
-
writeToJsonMap(
) → Map< String, dynamic> -
Returns the JSON encoding of this message as a Dart Map.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
create(
) → BuildConfig -
createRepeated(
) → PbList< BuildConfig> -
getDefault(
) → BuildConfig