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.


806
807
808
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 806

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

Instance Attribute Details

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

780
781
782
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 780

def args
  @args
end

#dirString

Working directory (relative to project source root) to use when running this operation's container. Corresponds to the JSON property dir

Returns:

  • (String)

804
805
806
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 804

def dir
  @dir
end

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

762
763
764
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 762

def env
  @env
end

#idString

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)

755
756
757
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 755

def id
  @id
end

#nameString

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)

798
799
800
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 798

def name
  @name
end

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

771
772
773
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 771

def wait_for
  @wait_for
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


811
812
813
814
815
816
817
818
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 811

def update!(**args)
  @id = args[:id] if args.key?(:id)
  @env = args[:env] if args.key?(:env)
  @wait_for = args[:wait_for] if args.key?(:wait_for)
  @args = args[:args] if args.key?(:args)
  @name = args[:name] if args.key?(:name)
  @dir = args[:dir] if args.key?(:dir)
end