Class BuildOptions (3.31.3) 

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

Optional arguments to enable specific features of builds.

Attributes
Name Description
source_provenance_hash MutableSequence[google.cloud.devtools.cloudbuild_v1.types.Hash.HashType]
Requested hash for SourceProvenance.
requested_verify_option google.cloud.devtools.cloudbuild_v1.types.BuildOptions.VerifyOption
Requested verifiability options.
machine_type google.cloud.devtools.cloudbuild_v1.types.BuildOptions.MachineType
Compute Engine machine type on which to run the build.
disk_size_gb int
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 4000GB; builds that request more than the maximum are rejected with an error.
substitution_option google.cloud.devtools.cloudbuild_v1.types.BuildOptions.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.
dynamic_substitutions 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.
automap_substitutions bool
Option to include built-in and custom substitutions as env variables for all build steps.
log_streaming_option google.cloud.devtools.cloudbuild_v1.types.BuildOptions.LogStreamingOption
Option to define build log streaming behavior to Cloud Storage.
worker_pool str
This field deprecated; please use pool.name instead.
pool google.cloud.devtools.cloudbuild_v1.types.BuildOptions.PoolOption
Optional. Specification for execution on a WorkerPool. See `running builds in a private pool
logging google.cloud.devtools.cloudbuild_v1.types.BuildOptions.LoggingMode
Option to specify the logging mode, which determines if and where build logs are stored.
env MutableSequence[str]
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".
secret_env MutableSequence[str]
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.
volumes MutableSequence[google.cloud.devtools.cloudbuild_v1.types.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.
default_logs_bucket_behavior google.cloud.devtools.cloudbuild_v1.types.BuildOptions.DefaultLogsBucketBehavior
Optional. Option to specify how default logs buckets are setup.
enable_structured_logging bool
Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs.

Classes

DefaultLogsBucketBehavior

DefaultLogsBucketBehavior(value)

Default Cloud Storage log bucket behavior options.

LogStreamingOption

LogStreamingOption(value)

Specifies the behavior when writing build logs to Cloud Storage.

LoggingMode

LoggingMode(value)

Specifies the logging mode.

MachineType

MachineType(value)

Supported Compute Engine machine types. For more information, see Machine types <https://cloud.google.com/compute/docs/machine-types>__.

PoolOption

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

Details about how a build should be executed on a WorkerPool.

See running builds in a private pool <https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool>__ for more information.

SubstitutionOption

SubstitutionOption(value)

Specifies the behavior when there is an error in the substitution checks.

VerifyOption

VerifyOption(value)

Specifies the manner in which the build should be verified, if at all.

If a verified build is requested, and any part of the process to generate and upload provenance fails, the build will also fail.

If the build does not request verification then that process may occur, but is not guaranteed to. If it does occur and fails, the build will not fail.

For more information, see Viewing Build Provenance <https://cloud.google.com/build/docs/securing-builds/view-build-provenance>__.