Cloud Build v1 API - Class BuildStep (2.9.0) 

public sealed class BuildStep : IMessage<BuildStep>, IEquatable<BuildStep>, IDeepCloneable<BuildStep>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Build v1 API class BuildStep.

A step in the build pipeline.

Inheritance

object > BuildStep

Namespace

Google.Cloud.CloudBuild.V1

Assembly

Google.Cloud.CloudBuild.V1.dll

Constructors

BuildStep()

public BuildStep()

BuildStep(BuildStep)

public BuildStep(BuildStep other)
Parameter
Name Description
other BuildStep

Properties

AllowExitCodes

public RepeatedField<int> AllowExitCodes { get; }

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.

Property Value
Type Description
RepeatedFieldint

AllowFailure

public bool AllowFailure { get; set; }

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.

Property Value
Type Description
bool

Args

public RepeatedField<string> Args { get; }

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.

Property Value
Type Description
RepeatedFieldstring

AutomapSubstitutions

public bool AutomapSubstitutions { get; set; }

Option to include built-in and custom substitutions as env variables for this build step. This option will override the global option in BuildOption.

Property Value
Type Description
bool

Dir

public string Dir { get; set; }

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.

Property Value
Type Description
string

Entrypoint

public string Entrypoint { get; set; }

Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used.

Property Value
Type Description
string

Env

public RepeatedField<string> Env { get; }

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

Property Value
Type Description
RepeatedFieldstring

ExitCode

public int ExitCode { get; set; }

Output only. Return code from running the step.

Property Value
Type Description
int

HasAutomapSubstitutions

public bool HasAutomapSubstitutions { get; }

Gets whether the "automap_substitutions" field is set

Property Value
Type Description
bool

Id

public string Id { get; set; }

Unique identifier for this build step, used in wait_for to reference this build step as a dependency.

Property Value
Type Description
string

Name

public string Name { get; set; }

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

Property Value
Type Description
string

PullTiming

public TimeSpan PullTiming { get; set; }

Output only. Stores timing information for pulling this build step's builder image only.

Property Value
Type Description
TimeSpan

Script

public string Script { get; set; }

A shell script to be executed in the step.

When script is provided, the user cannot specify the entrypoint or args.

Property Value
Type Description
string

SecretEnv

public RepeatedField<string> SecretEnv { get; }

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.

Property Value
Type Description
RepeatedFieldstring

Status

public Build.Types.Status Status { get; set; }

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.

Property Value
Type Description
BuildTypesStatus

Timeout

public Duration Timeout { get; set; }

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.

Property Value
Type Description
Duration

Timing

public TimeSpan Timing { get; set; }

Output only. Stores timing information for executing this build step.

Property Value
Type Description
TimeSpan

Volumes

public RepeatedField<Volume> Volumes { get; }

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.

Property Value
Type Description
RepeatedFieldVolume

WaitFor

public RepeatedField<string> WaitFor { get; }

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.

Property Value
Type Description
RepeatedFieldstring