BuildOptions class

Optional arguments to enable specific features of builds.

Constructors

BuildOptions({Input<bool>? automapSubstitutions, Input<BuildOptionsDefaultLogsBucketBehavior>? defaultLogsBucketBehavior, Input<String>? diskSizeGb, Input<bool>? dynamicSubstitutions, Input<List<String>>? env, Input<BuildOptionsLogStreamingOption>? logStreamingOption, Input<BuildOptionsLogging>? logging, Input<BuildOptionsMachineType>? machineType, Input<PoolOption>? pool, Input<BuildOptionsRequestedVerifyOption>? requestedVerifyOption, Input<List<String>>? secretEnv, Input<List<BuildOptionsSourceProvenanceHashItem>>? sourceProvenanceHash, Input<BuildOptionsSubstitutionOption>? substitutionOption, Input<List<Volume>>? volumes, Input<String>? workerPool})
Creates a new BuildOptions. automapSubstitutions Option to include built-in and custom substitutions as env variables for all build steps. defaultLogsBucketBehavior Optional. Option to specify how default logs buckets are setup. diskSizeGb Requested disk size for the VM that runs the build. Note that this is NOT "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 2000GB; builds that request more than the maximum are rejected with an error. dynamicSubstitutions Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file. env A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". logStreamingOption Option to define build log streaming behavior to Cloud Storage. logging Option to specify the logging mode, which determines if and where build logs are stored. machineType Compute Engine machine type on which to run the build. pool Optional. Specification for execution on a WorkerPool. See running builds in a private pool for more information. requestedVerifyOption Requested verifiability options. secretEnv A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's Secret. These variables will be available to all build steps in this build. sourceProvenanceHash Requested hash for SourceProvenance. substitutionOption Option to specify behavior when there is an error in the substitution checks. NOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot be overridden in the build configuration file. volumes Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process. Upon completion of the build, volumes and their contents are discarded. Global volume names and paths cannot conflict with the volumes defined a build step. Using a global volume in a build with only one step is not valid as it is indicative of a build request with an incorrect configuration. workerPool This field deprecated; please use pool.name instead.
const
BuildOptions.fromMap(Map<String, dynamic> map)
factory

Properties

automapSubstitutions → Input<bool>?
Option to include built-in and custom substitutions as env variables for all build steps.
final
defaultLogsBucketBehavior → Input<BuildOptionsDefaultLogsBucketBehavior>?
Optional. Option to specify how default logs buckets are setup.
final
diskSizeGb → Input<String>?
Requested disk size for the VM that runs the build. Note that this is NOT "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 2000GB; builds that request more than the maximum are rejected with an error.
final
dynamicSubstitutions → Input<bool>?
Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file.
final
env → Input<List<String>>?
A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE".
final
hashCode → int
The hash code for this object.
no setterinherited
logging → Input<BuildOptionsLogging>?
Option to specify the logging mode, which determines if and where build logs are stored.
final
logStreamingOption → Input<BuildOptionsLogStreamingOption>?
Option to define build log streaming behavior to Cloud Storage.
final
machineType → Input<BuildOptionsMachineType>?
Compute Engine machine type on which to run the build.
final
pool → Input<PoolOption>?
Optional. Specification for execution on a WorkerPool. See running builds in a private pool for more information.
final
requestedVerifyOption → Input<BuildOptionsRequestedVerifyOption>?
Requested verifiability options.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
secretEnv → Input<List<String>>?
A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's Secret. These variables will be available to all build steps in this build.
final
sourceProvenanceHash → Input<List<BuildOptionsSourceProvenanceHashItem>>?
Requested hash for SourceProvenance.
final
substitutionOption → Input<BuildOptionsSubstitutionOption>?
Option to specify behavior when there is an error in the substitution checks. NOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot be overridden in the build configuration file.
final
volumes → Input<List<Volume>>?
Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process. Upon completion of the build, volumes and their contents are discarded. Global volume names and paths cannot conflict with the volumes defined a build step. Using a global volume in a build with only one step is not valid as it is indicative of a build request with an incorrect configuration.
final
workerPool → Input<String>?
This field deprecated; please use pool.name instead.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited