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

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

Overview

A step in the build pipeline.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ BuildStep

Returns a new instance of BuildStep.



1229
1230
1231
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1229

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

Instance Attribute Details

#allow_exit_codes ⇒ Array<Fixnum>

Allow this build step to fail without failing the entire build if and only if the exit code is one of the specified codes. If allow_failure is also specified, this field will take precedence. Corresponds to the JSON property allowExitCodes

Returns:

  • (Array<Fixnum>) 


1098
1099
1100
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1098

def allow_exit_codes
  @allow_exit_codes
end

#allow_failure ⇒ Boolean Also known as: allow_failure?

Allow this build step to fail without failing the entire build. If false, the entire build will fail if this step fails. Otherwise, the build will succeed, but this step will still have a failure status. Error information will be reported in the failure_detail field. Corresponds to the JSON property allowFailure

Returns:

  • (Boolean) 


1106
1107
1108
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1106

def allow_failure
  @allow_failure
end

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


1116
1117
1118
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1116

def args
  @args
end

#automap_substitutions ⇒ Boolean Also known as: automap_substitutions?

Option to include built-in and custom substitutions as env variables for this build step. This option will override the global option in BuildOption. Corresponds to the JSON property automapSubstitutions

Returns:

  • (Boolean) 


1122
1123
1124
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1122

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


1134
1135
1136
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1134

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) 


1140
1141
1142
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1140

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


1147
1148
1149
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1147

def env
  @env
end

#exit_code ⇒ Fixnum

Output only. Return code from running the step. Corresponds to the JSON property exitCode

Returns:

  • (Fixnum) 


1152
1153
1154
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1152

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


1158
1159
1160
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1158

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) 


1173
1174
1175
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1173

def name
  @name
end

#pull_timing ⇒ Google::Apis::CloudbuildV1::TimeSpan

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

Returns:



1178
1179
1180
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1178

def pull_timing
  @pull_timing
end

#script ⇒ String

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

Returns:

  • (String) 


1184
1185
1186
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1184

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


1191
1192
1193
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1191

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) 


1198
1199
1200
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1198

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) 


1205
1206
1207
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1205

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:



1210
1211
1212
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1210

def timing
  @timing
end

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

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

Returns:



1219
1220
1221
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1219

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


1227
1228
1229
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1227

def wait_for
  @wait_for
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1234

def update!(**args)
  @allow_exit_codes = args[:allow_exit_codes] if args.key?(:allow_exit_codes)
  @allow_failure = args[:allow_failure] if args.key?(:allow_failure)
  @args = args[:args] if args.key?(:args)
  @automap_substitutions = args[:automap_substitutions] if args.key?(:automap_substitutions)
  @dir = args[:dir] if args.key?(:dir)
  @entrypoint = args[:entrypoint] if args.key?(:entrypoint)
  @env = args[:env] if args.key?(:env)
  @exit_code = args[:exit_code] if args.key?(:exit_code)
  @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