Class: Google::Apis::CloudbuildV1::BuildStep

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/cloudbuild_v1/classes.rb,
generated/google/apis/cloudbuild_v1/representations.rb,
generated/google/apis/cloudbuild_v1/representations.rb

Overview

BuildStep describes a step to perform in the build pipeline.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ BuildStep

Returns a new instance of BuildStep



388
389
390
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 388

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#args ⇒ Array<String>

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, these args will be used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args will be used as the entrypoint, and the remainder will be used as arguments. Corresponds to the JSON property args

Returns:

  • (Array<String>) 


307
308
309
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 307

def args
  @args
end

#dir ⇒ String

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

Returns:

  • (String) 


319
320
321
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 319

def dir
  @dir
end

#entrypoint ⇒ String

Optional entrypoint to be used instead of the build step image's default If unset, the image's default will be used. Corresponds to the JSON property entrypoint

Returns:

  • (String) 


325
326
327
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 325

def entrypoint
  @entrypoint
end

#env ⇒ Array<String>

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

Returns:

  • (Array<String>) 


332
333
334
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 332

def env
  @env
end

#id ⇒ String

Optional unique identifier for this build step, used in wait_for to reference this build step as a dependency. Corresponds to the JSON property id

Returns:

  • (String) 


338
339
340
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 338

def id
  @id
end

#name ⇒ String

The name of the container image that will run this particular build step. If the image is already 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. Corresponds to the JSON property name

Returns:

  • (String) 


356
357
358
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 356

def name
  @name
end

#secret_env ⇒ Array<String>

A list of environment variables which are encrypted using a Cloud KMS crypto key. These values must be specified in the build's secrets. Corresponds to the JSON property secretEnv

Returns:

  • (Array<String>) 


362
363
364
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 362

def secret_env
  @secret_env
end

#timing ⇒ Google::Apis::CloudbuildV1::TimeSpan

Stores start and end times for a build execution phase. Corresponds to the JSON property timing

Returns:



367
368
369
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 367

def timing
  @timing
end

#volumes ⇒ Array<Google::Apis::CloudbuildV1::Volume>

List of volumes to mount into the build step. Each volume will be created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents will be discarded. Using a named volume in only one step is not valid as it is indicative of a mis-configured build request. Corresponds to the JSON property volumes

Returns:



377
378
379
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 377

def volumes
  @volumes
end

#wait_for ⇒ Array<String>

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

Returns:

  • (Array<String>) 


386
387
388
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 386

def wait_for
  @wait_for
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 393

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)
  @secret_env = args[:secret_env] if args.key?(:secret_env)
  @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