CloudbuildTriggerBuildStep class

One build.step[] entry. name is the container image that runs the step (e.g. 'gcr.io/cloud-builders/docker'); the rest mirrors the docker RUN semantics.

The volumes sub-block (per-step volume mounts) is exposed via advancedExtra rather than as a typed helper.

Annotations
  • @immutable

Constructors

CloudbuildTriggerBuildStep({required TfArg<String> name, TfArg<String>? id, TfArg<List<String>>? args, TfArg<List<String>>? env, TfArg<String>? entrypoint, TfArg<String>? dir, TfArg<List<String>>? secretEnv, TfArg<String>? timeout, TfArg<List<String>>? waitFor, TfArg<String>? script, TfArg<bool>? allowFailure, TfArg<List<int>>? allowExitCodes, Map<String, Object?>? advancedExtra})
const

Properties

advancedExtra → Map<String, Object?>?
Escape hatch for the uncurated nested blocks of step:
final
allowExitCodes → TfArg<List<int>>?
Specific non-zero exit codes that count as success. Implies allowFailure.
final
allowFailure → TfArg<bool>?
When true, the step may exit non-zero without failing the build. allowExitCodes takes precedence when both are set.
final
args → TfArg<List<String>>?
Args appended to the image's entrypoint (or used AS the entrypoint when the image has none).
final
dir → TfArg<String>?
Working directory relative to the build's /workspace. Absolute paths leave the workspace and are NOT persisted across steps.
final
entrypoint → TfArg<String>?
Entrypoint override (replaces the image's ENTRYPOINT).
final
env → TfArg<List<String>>?
Env vars in 'KEY=VALUE' form.
final
hashCode → int
The hash code for this object.
no setterinherited
id → TfArg<String>?
Step id, referenced from waitFor / wait_for for ordering.
final
name → TfArg<String>
Container image URL. Cloud Build's prebuilt gcr.io/cloud-builders/* images cover docker / gcloud / git / gsutil / kubectl / mvn / npm and a few others.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
script → TfArg<String>?
Inline shell script. When set, entrypoint / args must NOT be set — the provider rejects the combination.
final
secretEnv → TfArg<List<String>>?
Names of KMS-encrypted env vars (defined under CloudbuildTriggerBuild.advancedExtra's secret block) to inject into this step.
final
timeout → TfArg<String>?
Per-step timeout ('90s', '1m30s', ...). Defaults to no limit (i.e. capped only by CloudbuildTriggerBuild.timeout).
final
waitFor → TfArg<List<String>>?
Step ids that must complete before this step runs. Empty list ([]) means "run as soon as the build starts" (i.e. fan out from the start).
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toArgMap() → Map<String, Object?>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited