Class BuildOptions

Optional arguments to enable specific features of builds.

Inheritance
object
BuildOptions
Implements
Inherited Members
Namespace: Google.Apis.CloudBuild.v1.Data
Assembly: Google.Apis.CloudBuild.v1.dll
Syntax
public class BuildOptions : IDirectResponseSchema

Properties

AutomapSubstitutions

Option to include built-in and custom substitutions as env variables for all build steps.

Declaration
[JsonProperty("automapSubstitutions")]
public virtual bool? AutomapSubstitutions { get; set; }
Property Value
Type Description
bool?

DefaultLogsBucketBehavior

Optional. Option to specify how default logs buckets are setup.

Declaration
[JsonProperty("defaultLogsBucketBehavior")]
public virtual string DefaultLogsBucketBehavior { get; set; }
Property Value
Type Description
string

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 4000GB; builds that request more than the maximum are rejected with an error.

Declaration
[JsonProperty("diskSizeGb")]
public virtual long? DiskSizeGb { get; set; }
Property Value
Type Description
long?

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.

Declaration
[JsonProperty("dynamicSubstitutions")]
public virtual bool? DynamicSubstitutions { get; set; }
Property Value
Type Description
bool?

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EnableStructuredLogging

Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs.

Declaration
[JsonProperty("enableStructuredLogging")]
public virtual bool? EnableStructuredLogging { get; set; }
Property Value
Type Description
bool?

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".

Declaration
[JsonProperty("env")]
public virtual IList<string> Env { get; set; }
Property Value
Type Description
IList<string>

LogStreamingOption

Option to define build log streaming behavior to Cloud Storage.

Declaration
[JsonProperty("logStreamingOption")]
public virtual string LogStreamingOption { get; set; }
Property Value
Type Description
string

Logging

Option to specify the logging mode, which determines if and where build logs are stored.

Declaration
[JsonProperty("logging")]
public virtual string Logging { get; set; }
Property Value
Type Description
string

MachineType

Compute Engine machine type on which to run the build.

Declaration
[JsonProperty("machineType")]
public virtual string MachineType { get; set; }
Property Value
Type Description
string

Pool

Optional. Specification for execution on a WorkerPool. See running builds in a private pool for more information.

Declaration
[JsonProperty("pool")]
public virtual PoolOption Pool { get; set; }
Property Value
Type Description
PoolOption

PubsubTopic

Optional. Option to specify the Pub/Sub topic to receive build status updates.

Declaration
[JsonProperty("pubsubTopic")]
public virtual string PubsubTopic { get; set; }
Property Value
Type Description
string

RequestedVerifyOption

Requested verifiability options.

Declaration
[JsonProperty("requestedVerifyOption")]
public virtual string RequestedVerifyOption { get; set; }
Property Value
Type Description
string

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.

Declaration
[JsonProperty("secretEnv")]
public virtual IList<string> SecretEnv { get; set; }
Property Value
Type Description
IList<string>

SourceProvenanceHash

Requested hash for SourceProvenance.

Declaration
[JsonProperty("sourceProvenanceHash")]
public virtual IList<string> SourceProvenanceHash { get; set; }
Property Value
Type Description
IList<string>

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.

Declaration
[JsonProperty("substitutionOption")]
public virtual string SubstitutionOption { get; set; }
Property Value
Type Description
string

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.

Declaration
[JsonProperty("volumes")]
public virtual IList<Volume> Volumes { get; set; }
Property Value
Type Description
IList<Volume>

WorkerPool

This field deprecated; please use pool.name instead.

Declaration
[JsonProperty("workerPool")]
public virtual string WorkerPool { get; set; }
Property Value
Type Description
string

Implements