Interface BuildOptionsOrBuilder (3.11.0)

Version 3.11.0

• 3.43.0 (latest)
• 3.42.0
• 3.41.0
• 3.39.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.26.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.6
• 3.4.1
• 3.3.12

public interface BuildOptionsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDiskSizeGb()

public abstract long getDiskSizeGb()

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

int64 disk_size_gb = 6;

Returns

Type	Description
long	The diskSizeGb.

getDynamicSubstitutions()

public abstract boolean getDynamicSubstitutions()

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.

bool dynamic_substitutions = 17;

Returns

Type	Description
boolean	The dynamicSubstitutions.

getEnv(int index)

public abstract String getEnv(int index)

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

repeated string env = 12;

Parameter

Name	Description
index	int The index of the element to return.

Returns

Type	Description
String	The env at the given index.

getEnvBytes(int index)

public abstract ByteString getEnvBytes(int index)

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

repeated string env = 12;

Parameter

Name	Description
index	int The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the env at the given index.

getEnvCount()

public abstract int getEnvCount()

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

repeated string env = 12;

Returns

Type	Description
int	The count of env.

getEnvList()

public abstract List<String> getEnvList()

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

repeated string env = 12;

Returns

Type	Description
List<String>	A list containing the env.

getLogStreamingOption()

public abstract BuildOptions.LogStreamingOption getLogStreamingOption()

Option to define build log streaming behavior to Google Cloud Storage.

.google.devtools.cloudbuild.v1.BuildOptions.LogStreamingOption log_streaming_option = 5;

Returns

Type	Description
BuildOptions.LogStreamingOption	The logStreamingOption.

getLogStreamingOptionValue()

public abstract int getLogStreamingOptionValue()

Option to define build log streaming behavior to Google Cloud Storage.

.google.devtools.cloudbuild.v1.BuildOptions.LogStreamingOption log_streaming_option = 5;

Returns

Type	Description
int	The enum numeric value on the wire for logStreamingOption.

getLogging()

public abstract BuildOptions.LoggingMode getLogging()

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

.google.devtools.cloudbuild.v1.BuildOptions.LoggingMode logging = 11;

Returns

Type	Description
BuildOptions.LoggingMode	The logging.

getLoggingValue()

public abstract int getLoggingValue()

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

.google.devtools.cloudbuild.v1.BuildOptions.LoggingMode logging = 11;

Returns

Type	Description
int	The enum numeric value on the wire for logging.

getMachineType()

public abstract BuildOptions.MachineType getMachineType()

Compute Engine machine type on which to run the build.

.google.devtools.cloudbuild.v1.BuildOptions.MachineType machine_type = 3;

Returns

Type	Description
BuildOptions.MachineType	The machineType.

getMachineTypeValue()

public abstract int getMachineTypeValue()

Compute Engine machine type on which to run the build.

.google.devtools.cloudbuild.v1.BuildOptions.MachineType machine_type = 3;

Returns

Type	Description
int	The enum numeric value on the wire for machineType.

getPool()

public abstract BuildOptions.PoolOption getPool()

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

.google.devtools.cloudbuild.v1.BuildOptions.PoolOption pool = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
BuildOptions.PoolOption	The pool.

getPoolOrBuilder()

public abstract BuildOptions.PoolOptionOrBuilder getPoolOrBuilder()

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

.google.devtools.cloudbuild.v1.BuildOptions.PoolOption pool = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
BuildOptions.PoolOptionOrBuilder

getRequestedVerifyOption()

public abstract BuildOptions.VerifyOption getRequestedVerifyOption()

Requested verifiability options.

.google.devtools.cloudbuild.v1.BuildOptions.VerifyOption requested_verify_option = 2;

Returns

Type	Description
BuildOptions.VerifyOption	The requestedVerifyOption.

getRequestedVerifyOptionValue()

public abstract int getRequestedVerifyOptionValue()

Requested verifiability options.

.google.devtools.cloudbuild.v1.BuildOptions.VerifyOption requested_verify_option = 2;

Returns

Type	Description
int	The enum numeric value on the wire for requestedVerifyOption.

getSecretEnv(int index)

public abstract String getSecretEnv(int index)

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.

repeated string secret_env = 13;

Parameter

Name	Description
index	int The index of the element to return.

Returns

Type	Description
String	The secretEnv at the given index.

getSecretEnvBytes(int index)

public abstract ByteString getSecretEnvBytes(int index)

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.

repeated string secret_env = 13;

Parameter

Name	Description
index	int The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the secretEnv at the given index.

getSecretEnvCount()

public abstract int getSecretEnvCount()

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.

repeated string secret_env = 13;

Returns

Type	Description
int	The count of secretEnv.

getSecretEnvList()

public abstract List<String> getSecretEnvList()

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.

repeated string secret_env = 13;

Returns

Type	Description
List<String>	A list containing the secretEnv.

getSourceProvenanceHash(int index)

public abstract Hash.HashType getSourceProvenanceHash(int index)

Requested hash for SourceProvenance.

repeated .google.devtools.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;

Parameter

Name	Description
index	int The index of the element to return.

Returns

Type	Description
Hash.HashType	The sourceProvenanceHash at the given index.

getSourceProvenanceHashCount()

public abstract int getSourceProvenanceHashCount()

Requested hash for SourceProvenance.

repeated .google.devtools.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;

Returns

Type	Description
int	The count of sourceProvenanceHash.

getSourceProvenanceHashList()

public abstract List<Hash.HashType> getSourceProvenanceHashList()

Requested hash for SourceProvenance.

repeated .google.devtools.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;

Returns

Type	Description
List<HashType>	A list containing the sourceProvenanceHash.

getSourceProvenanceHashValue(int index)

public abstract int getSourceProvenanceHashValue(int index)

Requested hash for SourceProvenance.

repeated .google.devtools.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;

Parameter

Name	Description
index	int The index of the value to return.

Returns

Type	Description
int	The enum numeric value on the wire of sourceProvenanceHash at the given index.

getSourceProvenanceHashValueList()

public abstract List<Integer> getSourceProvenanceHashValueList()

Requested hash for SourceProvenance.

repeated .google.devtools.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;

Returns

Type	Description
List<Integer>	A list containing the enum numeric values on the wire for sourceProvenanceHash.

getSubstitutionOption()

public abstract BuildOptions.SubstitutionOption getSubstitutionOption()

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.

.google.devtools.cloudbuild.v1.BuildOptions.SubstitutionOption substitution_option = 4;

Returns

Type	Description
BuildOptions.SubstitutionOption	The substitutionOption.

getSubstitutionOptionValue()

public abstract int getSubstitutionOptionValue()

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.

.google.devtools.cloudbuild.v1.BuildOptions.SubstitutionOption substitution_option = 4;

Returns

Type	Description
int	The enum numeric value on the wire for substitutionOption.

getVolumes(int index)

public abstract Volume getVolumes(int index)

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.

repeated .google.devtools.cloudbuild.v1.Volume volumes = 14;

Parameter

Name	Description
index	int

Returns

Type	Description
Volume

getVolumesCount()

public abstract int getVolumesCount()

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.

repeated .google.devtools.cloudbuild.v1.Volume volumes = 14;

Returns

Type	Description
int

getVolumesList()

public abstract List<Volume> getVolumesList()

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.

repeated .google.devtools.cloudbuild.v1.Volume volumes = 14;

Returns

Type	Description
List<Volume>

getVolumesOrBuilder(int index)

public abstract VolumeOrBuilder getVolumesOrBuilder(int index)

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.

repeated .google.devtools.cloudbuild.v1.Volume volumes = 14;

Parameter

Name	Description
index	int

Returns

Type	Description
VolumeOrBuilder

getVolumesOrBuilderList()

public abstract List<? extends VolumeOrBuilder> getVolumesOrBuilderList()

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.

repeated .google.devtools.cloudbuild.v1.Volume volumes = 14;

Returns

Type	Description
List<? extends com.google.cloudbuild.v1.VolumeOrBuilder>

getWorkerPool() (deprecated)

public abstract String getWorkerPool()

Deprecated. google.devtools.cloudbuild.v1.BuildOptions.worker_pool is deprecated. See google/devtools/cloudbuild/v1/cloudbuild.proto;l=1880

This field deprecated; please use pool.name instead.

string worker_pool = 7 [deprecated = true];

Returns

Type	Description
String	The workerPool.

getWorkerPoolBytes() (deprecated)

public abstract ByteString getWorkerPoolBytes()

Deprecated. google.devtools.cloudbuild.v1.BuildOptions.worker_pool is deprecated. See google/devtools/cloudbuild/v1/cloudbuild.proto;l=1880

This field deprecated; please use pool.name instead.

string worker_pool = 7 [deprecated = true];

Returns

Type	Description
ByteString	The bytes for workerPool.

hasPool()

public abstract boolean hasPool()

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

.google.devtools.cloudbuild.v1.BuildOptions.PoolOption pool = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
boolean	Whether the pool field is set.