class Google::Apis::CloudbuildV1::BuildStep

A step in the build pipeline.

Attributes

args[RW]

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. Corresponds to the JSON property `args` @return [Array<String>]

dir[RW]

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. Corresponds to the JSON property `dir` @return [String]

entrypoint[RW]

Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used. Corresponds to the JSON property `entrypoint` @return [String]

env[RW]

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”. Corresponds to the JSON property `env` @return [Array<String>]

id[RW]

Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency. Corresponds to the JSON property `id` @return [String]

name[RW]

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 ([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. Corresponds to the JSON property `name` @return [String]

pull_timing[RW]

Start and end times for a build execution phase. Corresponds to the JSON property `pullTiming` @return [Google::Apis::CloudbuildV1::TimeSpan]

script[RW]

A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. Corresponds to the JSON property `script` @return [String]

secret_env[RW]

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`. Corresponds to the JSON property `secretEnv` @return [Array<String>]

status[RW]

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. Corresponds to the JSON property `status` @return [String]

timeout[RW]

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. Corresponds to the JSON property `timeout` @return [String]

timing[RW]

Start and end times for a build execution phase. Corresponds to the JSON property `timing` @return [Google::Apis::CloudbuildV1::TimeSpan]

volumes[RW]

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. Corresponds to the JSON property `volumes` @return [Array<Google::Apis::CloudbuildV1::Volume>]

wait_for[RW]

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. Corresponds to the JSON property `waitFor` @return [Array<String>]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/cloudbuild_v1/classes.rb, line 721
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/cloudbuild_v1/classes.rb, line 726
def update!(**args)
  @args = args[:args] if args.key?(:args)
  @dir = args[:dir] if args.key?(:dir)
  @entrypoint = args[:entrypoint] if args.key?(:entrypoint)
  @env = args[:env] if args.key?(:env)
  @id = args[:id] if args.key?(:id)
  @name = args[:name] if args.key?(:name)
  @pull_timing = args[:pull_timing] if args.key?(:pull_timing)
  @script = args[:script] if args.key?(:script)
  @secret_env = args[:secret_env] if args.key?(:secret_env)
  @status = args[:status] if args.key?(:status)
  @timeout = args[:timeout] if args.key?(:timeout)
  @timing = args[:timing] if args.key?(:timing)
  @volumes = args[:volumes] if args.key?(:volumes)
  @wait_for = args[:wait_for] if args.key?(:wait_for)
end