public sealed class BuildOptions : IMessage<BuildOptions>, IEquatable<BuildOptions>, IDeepCloneable<BuildOptions>, IBufferMessage, IMessageReference documentation and code samples for the Cloud Build v1 API class BuildOptions.
Optional arguments to enable specific features of builds.
Implements
IMessageBuildOptions, IEquatableBuildOptions, IDeepCloneableBuildOptions, IBufferMessage, IMessageNamespace
Google.Cloud.CloudBuild.V1Assembly
Google.Cloud.CloudBuild.V1.dll
Constructors
BuildOptions()
public BuildOptions()BuildOptions(BuildOptions)
public BuildOptions(BuildOptions other)| Parameter | |
|---|---|
| Name | Description |
other |
BuildOptions |
Properties
AutomapSubstitutions
public bool AutomapSubstitutions { get; set; }Option to include built-in and custom substitutions as env variables for all build steps.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
DefaultLogsBucketBehavior
public BuildOptions.Types.DefaultLogsBucketBehavior DefaultLogsBucketBehavior { get; set; }Optional. Option to specify how default logs buckets are setup.
| Property Value | |
|---|---|
| Type | Description |
BuildOptionsTypesDefaultLogsBucketBehavior |
|
DiskSizeGb
public long DiskSizeGb { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
long |
|
DynamicSubstitutions
public bool DynamicSubstitutions { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
Env
public RepeatedField<string> Env { get; }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".
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldstring |
|
LogStreamingOption
public BuildOptions.Types.LogStreamingOption LogStreamingOption { get; set; }Option to define build log streaming behavior to Cloud Storage.
| Property Value | |
|---|---|
| Type | Description |
BuildOptionsTypesLogStreamingOption |
|
Logging
public BuildOptions.Types.LoggingMode Logging { get; set; }Option to specify the logging mode, which determines if and where build logs are stored.
| Property Value | |
|---|---|
| Type | Description |
BuildOptionsTypesLoggingMode |
|
MachineType
public BuildOptions.Types.MachineType MachineType { get; set; }Compute Engine machine type on which to run the build.
| Property Value | |
|---|---|
| Type | Description |
BuildOptionsTypesMachineType |
|
Pool
public BuildOptions.Types.PoolOption Pool { get; set; }Optional. Specification for execution on a WorkerPool.
See running builds in a private pool for more information.
| Property Value | |
|---|---|
| Type | Description |
BuildOptionsTypesPoolOption |
|
RequestedVerifyOption
public BuildOptions.Types.VerifyOption RequestedVerifyOption { get; set; }Requested verifiability options.
| Property Value | |
|---|---|
| Type | Description |
BuildOptionsTypesVerifyOption |
|
SecretEnv
public RepeatedField<string> SecretEnv { get; }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.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldstring |
|
SourceProvenanceHash
public RepeatedField<Hash.Types.HashType> SourceProvenanceHash { get; }Requested hash for SourceProvenance.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldHashTypesHashType |
|
SubstitutionOption
public BuildOptions.Types.SubstitutionOption SubstitutionOption { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
BuildOptionsTypesSubstitutionOption |
|
Volumes
public RepeatedField<Volume> Volumes { get; }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.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldVolume |
|
WorkerPool
[Obsolete]
public string WorkerPool { get; set; }This field deprecated; please use pool.name instead.
| Property Value | |
|---|---|
| Type | Description |
string |
|