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

A step 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



506
507
508
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 506

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, 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

Returns:

  • (Array<String>) 


409
410
411
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 409

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) 


421
422
423
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 421

def dir
  @dir
end

#entrypoint ⇒ String

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

Returns:

  • (String) 


427
428
429
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 427

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


434
435
436
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 434

def env
  @env
end

#id ⇒ String

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) 


440
441
442
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 440

def id
  @id
end

#name ⇒ String

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. Corresponds to the JSON property name

Returns:

  • (String) 


459
460
461
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 459

def name
  @name
end

#secret_env ⇒ Array<String>

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

Returns:

  • (Array<String>) 


466
467
468
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 466

def secret_env
  @secret_env
end

#status ⇒ String

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

Returns:

  • (String) 


473
474
475
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 473

def status
  @status
end

#timeout ⇒ String

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

Returns:

  • (String) 


480
481
482
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 480

def timeout
  @timeout
end

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

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

Returns:



485
486
487
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 485

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:



495
496
497
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 495

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


504
505
506
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 504

def wait_for
  @wait_for
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



511
512
513
514
515
516
517
518
519
520
521
522
523
524
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 511

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