Struct BuildOptions

#[non_exhaustive]
pub struct BuildOptions {

    pub source_provenance_hash: Vec<HashType>,
    pub requested_verify_option: VerifyOption,
    pub machine_type: MachineType,
    pub disk_size_gb: i64,
    pub substitution_option: SubstitutionOption,
    pub dynamic_substitutions: bool,
    pub automap_substitutions: bool,
    pub log_streaming_option: LogStreamingOption,
    pub worker_pool: String,
    pub pool: Option<PoolOption>,
    pub logging: LoggingMode,
    pub env: Vec<String>,
    pub secret_env: Vec<String>,
    pub volumes: Vec<Volume>,
    pub default_logs_bucket_behavior: DefaultLogsBucketBehavior,
    pub enable_structured_logging: bool,
}

Optional arguments to enable specific features of builds.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

source_provenance_hash: Vec<HashType>

Requested hash for SourceProvenance.

requested_verify_option: VerifyOption

Requested verifiability options.

machine_type: MachineType

Compute Engine machine type on which to run the build.

disk_size_gb: i64

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.

substitution_option: 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: LogStreamingOption

Option to define build log streaming behavior to Cloud Storage.

worker_pool: String

This field deprecated; please use pool.name instead.

pool: Option<PoolOption>

Optional. Specification for execution on a WorkerPool.

See running builds in a private pool for more information.

logging: LoggingMode

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

env: Vec<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”.

secret_env: Vec<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.

volumes: Vec<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: 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.

Implementations

impl BuildOptions

pub fn set_requested_verify_option<T: Into<VerifyOption>>(self, v: T) -> Self

Sets the value of requested_verify_option.

pub fn set_machine_type<T: Into<MachineType>>(self, v: T) -> Self

Sets the value of machine_type.

pub fn set_disk_size_gb<T: Into<i64>>(self, v: T) -> Self

Sets the value of disk_size_gb.

pub fn set_substitution_option<T: Into<SubstitutionOption>>(self, v: T) -> Self

Sets the value of substitution_option.

pub fn set_dynamic_substitutions<T: Into<bool>>(self, v: T) -> Self

Sets the value of dynamic_substitutions.

pub fn set_automap_substitutions<T: Into<bool>>(self, v: T) -> Self

Sets the value of automap_substitutions.

pub fn set_log_streaming_option<T: Into<LogStreamingOption>>(self, v: T) -> Self

Sets the value of log_streaming_option.

pub fn set_worker_pool<T: Into<String>>(self, v: T) -> Self

Sets the value of worker_pool.

pub fn set_pool<T: Into<Option<PoolOption>>>(self, v: T) -> Self

Sets the value of pool.

pub fn set_logging<T: Into<LoggingMode>>(self, v: T) -> Self

Sets the value of logging.

pub fn set_default_logs_bucket_behavior<T: Into<DefaultLogsBucketBehavior>>( self, v: T, ) -> Self

Sets the value of default_logs_bucket_behavior.

pub fn set_enable_structured_logging<T: Into<bool>>(self, v: T) -> Self

Sets the value of enable_structured_logging.

pub fn set_source_provenance_hash<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<HashType>,

Sets the value of source_provenance_hash.

pub fn set_env<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of env.

pub fn set_secret_env<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of secret_env.

pub fn set_volumes<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Volume>,

Sets the value of volumes.

Trait Implementations

impl Clone for BuildOptions

fn clone(&self) -> BuildOptions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BuildOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for BuildOptions

fn default() -> BuildOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BuildOptions

where BuildOptions: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for BuildOptions

fn typename() -> &'static str

The typename of this message.

impl PartialEq for BuildOptions

fn eq(&self, other: &BuildOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for BuildOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BuildOptions