BuildStep (Cloud Build API v1-rev20240427-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.cloudbuild.v1.model.BuildStep

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class BuildStep
extends com.google.api.client.json.GenericJson
```
A step in the build pipeline.
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 Build 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

BuildStep()

Constructors
Constructor and Description
`BuildStep()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BuildStep`	`clone()`
`List<Integer>`	`getAllowExitCodes()` Allow this build step to fail without failing the entire build if and only if the exit code is one of the specified codes.
`Boolean`	`getAllowFailure()` Allow this build step to fail without failing the entire build.
`List<String>`	`getArgs()` A list of arguments that will be presented to the step when it is started.
`Boolean`	`getAutomapSubstitutions()` Option to include built-in and custom substitutions as env variables for this build step.
`String`	`getDir()` Working directory to use when running this step's container.
`String`	`getEntrypoint()` Entrypoint to be used instead of the build step image's default entrypoint.
`List<String>`	`getEnv()` A list of environment variable definitions to be used when running a step.
`Integer`	`getExitCode()` Output only.
`String`	`getId()` Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency.
`String`	`getName()` Required.
`TimeSpan`	`getPullTiming()` Output only.
`String`	`getScript()` A shell script to be executed in the step.
`List<String>`	`getSecretEnv()` A list of environment variables which are encrypted using a Cloud Key Management Service crypto key.
`String`	`getStatus()` Output only.
`String`	`getTimeout()` Time limit for executing this build step.
`TimeSpan`	`getTiming()` Output only.
`List<Volume>`	`getVolumes()` List of volumes to mount into the build step.
`List<String>`	`getWaitFor()` The ID(s) of the step(s) that this build step depends on.
`BuildStep`	`set(String fieldName, Object value)`
`BuildStep`	`setAllowExitCodes(List<Integer> allowExitCodes)` Allow this build step to fail without failing the entire build if and only if the exit code is one of the specified codes.
`BuildStep`	`setAllowFailure(Boolean allowFailure)` Allow this build step to fail without failing the entire build.
`BuildStep`	`setArgs(List<String> args)` A list of arguments that will be presented to the step when it is started.
`BuildStep`	`setAutomapSubstitutions(Boolean automapSubstitutions)` Option to include built-in and custom substitutions as env variables for this build step.
`BuildStep`	`setDir(String dir)` Working directory to use when running this step's container.
`BuildStep`	`setEntrypoint(String entrypoint)` Entrypoint to be used instead of the build step image's default entrypoint.
`BuildStep`	`setEnv(List<String> env)` A list of environment variable definitions to be used when running a step.
`BuildStep`	`setExitCode(Integer exitCode)` Output only.
`BuildStep`	`setId(String id)` Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency.
`BuildStep`	`setName(String name)` Required.
`BuildStep`	`setPullTiming(TimeSpan pullTiming)` Output only.
`BuildStep`	`setScript(String script)` A shell script to be executed in the step.
`BuildStep`	`setSecretEnv(List<String> secretEnv)` A list of environment variables which are encrypted using a Cloud Key Management Service crypto key.
`BuildStep`	`setStatus(String status)` Output only.
`BuildStep`	`setTimeout(String timeout)` Time limit for executing this build step.
`BuildStep`	`setTiming(TimeSpan timing)` Output only.
`BuildStep`	`setVolumes(List<Volume> volumes)` List of volumes to mount into the build step.
`BuildStep`	`setWaitFor(List<String> waitFor)` The ID(s) of the step(s) that this build step depends on.

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
  - BuildStep
```
public BuildStep()
```
- Method Detail
  - getAllowExitCodes
```
public List<Integer> getAllowExitCodes()
```
    Allow this build step to fail without failing the entire build if and only if the exit code is one of the specified codes. If allow_failure is also specified, this field will take precedence.
    
    Returns:
    
    value or null for none
  - setAllowExitCodes
```
public BuildStep setAllowExitCodes(List<Integer> allowExitCodes)
```
    Allow this build step to fail without failing the entire build if and only if the exit code is one of the specified codes. If allow_failure is also specified, this field will take precedence.
    
    Parameters:
    
    allowExitCodes - allowExitCodes or null for none
  - getAllowFailure
```
public Boolean getAllowFailure()
```
    Allow this build step to fail without failing the entire build. If false, the entire build will fail if this step fails. Otherwise, the build will succeed, but this step will still have a failure status. Error information will be reported in the failure_detail field.
    
    Returns:
    
    value or null for none
  - setAllowFailure
```
public BuildStep setAllowFailure(Boolean allowFailure)
```
    Allow this build step to fail without failing the entire build. If false, the entire build will fail if this step fails. Otherwise, the build will succeed, but this step will still have a failure status. Error information will be reported in the failure_detail field.
    
    Parameters:
    
    allowFailure - allowFailure or null for none
  - getArgs
```
public List<String> getArgs()
```
    A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the `args` are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments.
    
    Returns:
    
    value or null for none
  - setArgs
```
public BuildStep setArgs(List<String> args)
```
    A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the `args` are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments.
    
    Parameters:
    
    args - args or null for none
  - getAutomapSubstitutions
```
public Boolean getAutomapSubstitutions()
```
    Option to include built-in and custom substitutions as env variables for this build step. This option will override the global option in BuildOption.
    
    Returns:
    
    value or null for none
  - setAutomapSubstitutions
```
public BuildStep setAutomapSubstitutions(Boolean automapSubstitutions)
```
    Option to include built-in and custom substitutions as env variables for this build step. This option will override the global option in BuildOption.
    
    Parameters:
    
    automapSubstitutions - automapSubstitutions or null for none
  - getDir
```
public String getDir()
```
    Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a `volume` for that path is specified. If the build specifies a `RepoSource` with `dir` and a step with a `dir`, which specifies an absolute path, the `RepoSource` `dir` is ignored for the step's execution.
    
    Returns:
    
    value or null for none
  - setDir
```
public BuildStep setDir(String dir)
```
    Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a `volume` for that path is specified. If the build specifies a `RepoSource` with `dir` and a step with a `dir`, which specifies an absolute path, the `RepoSource` `dir` is ignored for the step's execution.
    
    Parameters:
    
    dir - dir or null for none
  - getEntrypoint
```
public String getEntrypoint()
```
    Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used.
    
    Returns:
    
    value or null for none
  - setEntrypoint
```
public BuildStep setEntrypoint(String entrypoint)
```
    Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used.
    
    Parameters:
    
    entrypoint - entrypoint or null for none
  - getEnv
```
public List<String> getEnv()
```
    A list of environment variable definitions to be used when running a step. 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 BuildStep setEnv(List<String> env)
```
    A list of environment variable definitions to be used when running a step. 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
  - getExitCode
```
public Integer getExitCode()
```
    Output only. Return code from running the step.
    
    Returns:
    
    value or null for none
  - setExitCode
```
public BuildStep setExitCode(Integer exitCode)
```
    Output only. Return code from running the step.
    
    Parameters:
    
    exitCode - exitCode or null for none
  - getId
```
public String getId()
```
    Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency.
    
    Returns:
    
    value or null for none
  - setId
```
public BuildStep setId(String id)
```
    Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency.
    
    Parameters:
    
    id - id or null for none
  - getName
```
public String getName()
```
    Required. The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of the officially supported build steps ([https://github.com/GoogleCloudPlatform/cloud- builders](https://github.com/GoogleCloudPlatform/cloud-builders)). The Docker daemon will also have cached many of the layers for some popular images, like "ubuntu", "debian", but they will be refreshed at the time you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step.
    
    Returns:
    
    value or null for none
  - setName
```
public BuildStep setName(String name)
```
    Required. The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of the officially supported build steps ([https://github.com/GoogleCloudPlatform/cloud- builders](https://github.com/GoogleCloudPlatform/cloud-builders)). The Docker daemon will also have cached many of the layers for some popular images, like "ubuntu", "debian", but they will be refreshed at the time you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step.
    
    Parameters:
    
    name - name or null for none
  - getPullTiming
```
public TimeSpan getPullTiming()
```
    Output only. Stores timing information for pulling this build step's builder image only.
    
    Returns:
    
    value or null for none
  - setPullTiming
```
public BuildStep setPullTiming(TimeSpan pullTiming)
```
    Output only. Stores timing information for pulling this build step's builder image only.
    
    Parameters:
    
    pullTiming - pullTiming or null for none
  - getScript
```
public String getScript()
```
    A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args.
    
    Returns:
    
    value or null for none
  - setScript
```
public BuildStep setScript(String script)
```
    A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args.
    
    Parameters:
    
    script - script or null for none
  - getSecretEnv
```
public List<String> getSecretEnv()
```
    A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`.
    
    Returns:
    
    value or null for none
  - setSecretEnv
```
public BuildStep setSecretEnv(List<String> secretEnv)
```
    A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`.
    
    Parameters:
    
    secretEnv - secretEnv or null for none
  - getStatus
```
public String getStatus()
```
    Output only. Status of the build step. At this time, build step status is only updated on build completion; step status is not updated in real-time as the build progresses.
    
    Returns:
    
    value or null for none
  - setStatus
```
public BuildStep setStatus(String status)
```
    Output only. Status of the build step. At this time, build step status is only updated on build completion; step status is not updated in real-time as the build progresses.
    
    Parameters:
    
    status - status or null for none
  - getTimeout
```
public String getTimeout()
```
    Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.
    
    Returns:
    
    value or null for none
  - setTimeout
```
public BuildStep setTimeout(String timeout)
```
    Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.
    
    Parameters:
    
    timeout - timeout or null for none
  - getTiming
```
public TimeSpan getTiming()
```
    Output only. Stores timing information for executing this build step.
    
    Returns:
    
    value or null for none
  - setTiming
```
public BuildStep setTiming(TimeSpan timing)
```
    Output only. Stores timing information for executing this build step.
    
    Parameters:
    
    timing - timing or null for none
  - getVolumes
```
public List<Volume> getVolumes()
```
    List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in 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 BuildStep setVolumes(List<Volume> volumes)
```
    List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in 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
  - getWaitFor
```
public List<String> getWaitFor()
```
    The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in `wait_for` have completed successfully. If `wait_for` is empty, this build step will start when all previous build steps in the `Build.Steps` list have completed successfully.
    
    Returns:
    
    value or null for none
  - setWaitFor
```
public BuildStep setWaitFor(List<String> waitFor)
```
    The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in `wait_for` have completed successfully. If `wait_for` is empty, this build step will start when all previous build steps in the `Build.Steps` list have completed successfully.
    
    Parameters:
    
    waitFor - waitFor or null for none
  - set
```
public BuildStep set(String fieldName,
                     Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public BuildStep clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class BuildStep

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

BuildStep

Method Detail

getAllowExitCodes

setAllowExitCodes

getAllowFailure

setAllowFailure

getArgs

setArgs

getAutomapSubstitutions

setAutomapSubstitutions

getDir

setDir

getEntrypoint

setEntrypoint

getEnv

setEnv

getExitCode

setExitCode

getId

setId

getName

setName

getPullTiming

setPullTiming

getScript

setScript

getSecretEnv

setSecretEnv

getStatus

setStatus

getTimeout

setTimeout

getTiming

setTiming

getVolumes

setVolumes

getWaitFor

setWaitFor

set

clone