GoogleDevtoolsCloudbuildV1BuildOptions (Cloud Run Admin API v2-rev20260320-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.run.v2.model.GoogleDevtoolsCloudbuildV1BuildOptions

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleDevtoolsCloudbuildV1BuildOptions
extends com.google.api.client.json.GenericJson
```
Optional arguments to enable specific features of builds.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Run Admin API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

GoogleDevtoolsCloudbuildV1BuildOptions()

Constructors
Constructor and Description
`GoogleDevtoolsCloudbuildV1BuildOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleDevtoolsCloudbuildV1BuildOptions`	`clone()`
`Boolean`	`getAutomapSubstitutions()` Option to include built-in and custom substitutions as env variables for all build steps.
`String`	`getDefaultLogsBucketBehavior()` Optional.
`Long`	`getDiskSizeGb()` Requested disk size for the VM that runs the build.
`Boolean`	`getDynamicSubstitutions()` Option to specify whether or not to apply bash style string operations to the substitutions.
`Boolean`	`getEnableStructuredLogging()` Optional.
`List<String>`	`getEnv()` A list of global environment variable definitions that will exist for all build steps in this build.
`String`	`getLogging()` Option to specify the logging mode, which determines if and where build logs are stored.
`String`	`getLogStreamingOption()` Option to define build log streaming behavior to Cloud Storage.
`String`	`getMachineType()` Compute Engine machine type on which to run the build.
`GoogleDevtoolsCloudbuildV1PoolOption`	`getPool()` Optional.
`String`	`getPubsubTopic()` Optional.
`String`	`getRequestedVerifyOption()` Requested verifiability options.
`List<String>`	`getSecretEnv()` A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key.
`List<String>`	`getSourceProvenanceHash()` Requested hash for SourceProvenance.
`String`	`getSubstitutionOption()` Option to specify behavior when there is an error in the substitution checks.
`List<GoogleDevtoolsCloudbuildV1Volume>`	`getVolumes()` Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process.
`String`	`getWorkerPool()` This field deprecated; please use `pool.name` instead.
`GoogleDevtoolsCloudbuildV1BuildOptions`	`set(String fieldName, Object value)`
`GoogleDevtoolsCloudbuildV1BuildOptions`	`setAutomapSubstitutions(Boolean automapSubstitutions)` Option to include built-in and custom substitutions as env variables for all build steps.
`GoogleDevtoolsCloudbuildV1BuildOptions`	`setDefaultLogsBucketBehavior(String defaultLogsBucketBehavior)` Optional.
`GoogleDevtoolsCloudbuildV1BuildOptions`	`setDiskSizeGb(Long diskSizeGb)` Requested disk size for the VM that runs the build.
`GoogleDevtoolsCloudbuildV1BuildOptions`	`setDynamicSubstitutions(Boolean dynamicSubstitutions)` Option to specify whether or not to apply bash style string operations to the substitutions.
`GoogleDevtoolsCloudbuildV1BuildOptions`	`setEnableStructuredLogging(Boolean enableStructuredLogging)` Optional.
`GoogleDevtoolsCloudbuildV1BuildOptions`	`setEnv(List<String> env)` A list of global environment variable definitions that will exist for all build steps in this build.
`GoogleDevtoolsCloudbuildV1BuildOptions`	`setLogging(String logging)` Option to specify the logging mode, which determines if and where build logs are stored.
`GoogleDevtoolsCloudbuildV1BuildOptions`	`setLogStreamingOption(String logStreamingOption)` Option to define build log streaming behavior to Cloud Storage.
`GoogleDevtoolsCloudbuildV1BuildOptions`	`setMachineType(String machineType)` Compute Engine machine type on which to run the build.
`GoogleDevtoolsCloudbuildV1BuildOptions`	`setPool(GoogleDevtoolsCloudbuildV1PoolOption pool)` Optional.
`GoogleDevtoolsCloudbuildV1BuildOptions`	`setPubsubTopic(String pubsubTopic)` Optional.
`GoogleDevtoolsCloudbuildV1BuildOptions`	`setRequestedVerifyOption(String requestedVerifyOption)` Requested verifiability options.
`GoogleDevtoolsCloudbuildV1BuildOptions`	`setSecretEnv(List<String> secretEnv)` A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key.
`GoogleDevtoolsCloudbuildV1BuildOptions`	`setSourceProvenanceHash(List<String> sourceProvenanceHash)` Requested hash for SourceProvenance.
`GoogleDevtoolsCloudbuildV1BuildOptions`	`setSubstitutionOption(String substitutionOption)` Option to specify behavior when there is an error in the substitution checks.
`GoogleDevtoolsCloudbuildV1BuildOptions`	`setVolumes(List<GoogleDevtoolsCloudbuildV1Volume> 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.
`GoogleDevtoolsCloudbuildV1BuildOptions`	`setWorkerPool(String workerPool)` This field deprecated; please use `pool.name` instead.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - GoogleDevtoolsCloudbuildV1BuildOptions
```
public GoogleDevtoolsCloudbuildV1BuildOptions()
```
- Method Detail
  - getAutomapSubstitutions
```
public Boolean getAutomapSubstitutions()
```
    Option to include built-in and custom substitutions as env variables for all build steps.
    
    Returns:
    
    value or null for none
  - setAutomapSubstitutions
```
public GoogleDevtoolsCloudbuildV1BuildOptions setAutomapSubstitutions(Boolean automapSubstitutions)
```
    Option to include built-in and custom substitutions as env variables for all build steps.
    
    Parameters:
    
    automapSubstitutions - automapSubstitutions or null for none
  - getDefaultLogsBucketBehavior
```
public String getDefaultLogsBucketBehavior()
```
    Optional. Option to specify how default logs buckets are setup.
    
    Returns:
    
    value or null for none
  - setDefaultLogsBucketBehavior
```
public GoogleDevtoolsCloudbuildV1BuildOptions setDefaultLogsBucketBehavior(String defaultLogsBucketBehavior)
```
    Optional. Option to specify how default logs buckets are setup.
    
    Parameters:
    
    defaultLogsBucketBehavior - defaultLogsBucketBehavior or null for none
  - getDiskSizeGb
```
public 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 4000GB; builds that request more than the maximum are rejected with an error.
    
    Returns:
    
    value or null for none
  - setDiskSizeGb
```
public GoogleDevtoolsCloudbuildV1BuildOptions setDiskSizeGb(Long 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.
    
    Parameters:
    
    diskSizeGb - diskSizeGb or null for none
  - getDynamicSubstitutions
```
public 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.
    
    Returns:
    
    value or null for none
  - setDynamicSubstitutions
```
public GoogleDevtoolsCloudbuildV1BuildOptions setDynamicSubstitutions(Boolean 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.
    
    Parameters:
    
    dynamicSubstitutions - dynamicSubstitutions or null for none
  - getEnableStructuredLogging
```
public Boolean getEnableStructuredLogging()
```
    Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs.
    
    Returns:
    
    value or null for none
  - setEnableStructuredLogging
```
public GoogleDevtoolsCloudbuildV1BuildOptions setEnableStructuredLogging(Boolean enableStructuredLogging)
```
    Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs.
    
    Parameters:
    
    enableStructuredLogging - enableStructuredLogging or null for none
  - getEnv
```
public List<String> getEnv()
```
    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".
    
    Returns:
    
    value or null for none
  - setEnv
```
public GoogleDevtoolsCloudbuildV1BuildOptions setEnv(List<String> 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".
    
    Parameters:
    
    env - env or null for none
  - getLogStreamingOption
```
public String getLogStreamingOption()
```
    Option to define build log streaming behavior to Cloud Storage.
    
    Returns:
    
    value or null for none
  - setLogStreamingOption
```
public GoogleDevtoolsCloudbuildV1BuildOptions setLogStreamingOption(String logStreamingOption)
```
    Option to define build log streaming behavior to Cloud Storage.
    
    Parameters:
    
    logStreamingOption - logStreamingOption or null for none
  - getLogging
```
public String getLogging()
```
    Option to specify the logging mode, which determines if and where build logs are stored.
    
    Returns:
    
    value or null for none
  - setLogging
```
public GoogleDevtoolsCloudbuildV1BuildOptions setLogging(String logging)
```
    Option to specify the logging mode, which determines if and where build logs are stored.
    
    Parameters:
    
    logging - logging or null for none
  - getMachineType
```
public String getMachineType()
```
    Compute Engine machine type on which to run the build.
    
    Returns:
    
    value or null for none
  - setMachineType
```
public GoogleDevtoolsCloudbuildV1BuildOptions setMachineType(String machineType)
```
    Compute Engine machine type on which to run the build.
    
    Parameters:
    
    machineType - machineType or null for none
  - getPool
```
public GoogleDevtoolsCloudbuildV1PoolOption getPool()
```
    Optional. Specification for execution 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.
    
    Returns:
    
    value or null for none
  - setPool
```
public GoogleDevtoolsCloudbuildV1BuildOptions setPool(GoogleDevtoolsCloudbuildV1PoolOption pool)
```
    Optional. Specification for execution 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.
    
    Parameters:
    
    pool - pool or null for none
  - getPubsubTopic
```
public String getPubsubTopic()
```
    Optional. Option to specify the Pub/Sub topic to receive build status updates.
    
    Returns:
    
    value or null for none
  - setPubsubTopic
```
public GoogleDevtoolsCloudbuildV1BuildOptions setPubsubTopic(String pubsubTopic)
```
    Optional. Option to specify the Pub/Sub topic to receive build status updates.
    
    Parameters:
    
    pubsubTopic - pubsubTopic or null for none
  - getRequestedVerifyOption
```
public String getRequestedVerifyOption()
```
    Requested verifiability options.
    
    Returns:
    
    value or null for none
  - setRequestedVerifyOption
```
public GoogleDevtoolsCloudbuildV1BuildOptions setRequestedVerifyOption(String requestedVerifyOption)
```
    Requested verifiability options.
    
    Parameters:
    
    requestedVerifyOption - requestedVerifyOption or null for none
  - getSecretEnv
```
public List<String> getSecretEnv()
```
    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.
    
    Returns:
    
    value or null for none
  - setSecretEnv
```
public GoogleDevtoolsCloudbuildV1BuildOptions setSecretEnv(List<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.
    
    Parameters:
    
    secretEnv - secretEnv or null for none
  - getSourceProvenanceHash
```
public List<String> getSourceProvenanceHash()
```
    Requested hash for SourceProvenance.
    
    Returns:
    
    value or null for none
  - setSourceProvenanceHash
```
public GoogleDevtoolsCloudbuildV1BuildOptions setSourceProvenanceHash(List<String> sourceProvenanceHash)
```
    Requested hash for SourceProvenance.
    
    Parameters:
    
    sourceProvenanceHash - sourceProvenanceHash or null for none
  - getSubstitutionOption
```
public String 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.
    
    Returns:
    
    value or null for none
  - setSubstitutionOption
```
public GoogleDevtoolsCloudbuildV1BuildOptions setSubstitutionOption(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.
    
    Parameters:
    
    substitutionOption - substitutionOption or null for none
  - getVolumes
```
public List<GoogleDevtoolsCloudbuildV1Volume> getVolumes()
```
    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.
    
    Returns:
    
    value or null for none
  - setVolumes
```
public GoogleDevtoolsCloudbuildV1BuildOptions setVolumes(List<GoogleDevtoolsCloudbuildV1Volume> 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.
    
    Parameters:
    
    volumes - volumes or null for none
  - getWorkerPool
```
public String getWorkerPool()
```
    This field deprecated; please use `pool.name` instead.
    
    Returns:
    
    value or null for none
  - setWorkerPool
```
public GoogleDevtoolsCloudbuildV1BuildOptions setWorkerPool(String workerPool)
```
    This field deprecated; please use `pool.name` instead.
    
    Parameters:
    
    workerPool - workerPool or null for none
  - set
```
public GoogleDevtoolsCloudbuildV1BuildOptions set(String fieldName,
                                                  Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GoogleDevtoolsCloudbuildV1BuildOptions clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GoogleDevtoolsCloudbuildV1BuildOptions

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

GoogleDevtoolsCloudbuildV1BuildOptions

Method Detail

getAutomapSubstitutions

setAutomapSubstitutions

getDefaultLogsBucketBehavior

setDefaultLogsBucketBehavior

getDiskSizeGb

setDiskSizeGb

getDynamicSubstitutions

setDynamicSubstitutions

getEnableStructuredLogging

setEnableStructuredLogging

getEnv

setEnv

getLogStreamingOption

setLogStreamingOption

getLogging

setLogging

getMachineType

setMachineType

getPool

setPool

getPubsubTopic

setPubsubTopic

getRequestedVerifyOption

setRequestedVerifyOption

getSecretEnv

setSecretEnv

getSourceProvenanceHash

setSourceProvenanceHash

getSubstitutionOption

setSubstitutionOption

getVolumes

setVolumes

getWorkerPool

setWorkerPool

set

clone