Class: Google::Apis::CloudbuildV1::Build

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 build resource in the Container Builder API. At a high level, a Build describes where to find source code, how to build it (for example, the builder image to run on the source), and what tag to apply to the built image when it is pushed to Google Container Registry. Fields can include the following variables which will be expanded when the build is created:

  • $PROJECT_ID: the project ID of the build.
  • $BUILD_ID: the autogenerated ID of the build.
  • $REPO_NAME: the source repository name specified by RepoSource.
  • $BRANCH_NAME: the branch name specified by RepoSource.
  • $TAG_NAME: the tag name specified by RepoSource.
  • $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag.

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

Returns a new instance of Build



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

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

Instance Attribute Details

#build_trigger_id ⇒ String

The ID of the BuildTrigger that triggered this build, if it was triggered automatically. Corresponds to the JSON property buildTriggerId

Returns:

  • (String) 


255
256
257
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 255

def build_trigger_id
  @build_trigger_id
end

#create_time ⇒ String

Time at which the request to create the build was received. Corresponds to the JSON property createTime

Returns:

  • (String) 


289
290
291
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 289

def create_time
  @create_time
end

#finish_time ⇒ String

Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. Corresponds to the JSON property finishTime

Returns:

  • (String) 


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

def finish_time
  @finish_time
end

#id ⇒ String

Unique identifier of the build. Corresponds to the JSON property id

Returns:

  • (String) 


266
267
268
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 266

def id
  @id
end

#images ⇒ Array<String>

A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. Corresponds to the JSON property images

Returns:

  • (Array<String>) 


299
300
301
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 299

def images
  @images
end

#log_url ⇒ String

URL to logs for this build in Google Cloud Logging. Corresponds to the JSON property logUrl

Returns:

  • (String) 


311
312
313
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 311

def log_url
  @log_url
end

#logs_bucket ⇒ String

Google Cloud Storage bucket where logs should be written (see Bucket Name Requirements ). Logs file names will be of the format $logs_bucket/log-$build_id.txt. Corresponds to the JSON property logsBucket

Returns:

  • (String) 


238
239
240
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 238

def logs_bucket
  @logs_bucket
end

#options ⇒ Google::Apis::CloudbuildV1::BuildOptions

Optional arguments to enable specific features of builds. Corresponds to the JSON property options

Returns:



330
331
332
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 330

def options
  @options
end

#project_id ⇒ String

ID of the project. Corresponds to the JSON property projectId

Returns:

  • (String) 


305
306
307
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 305

def project_id
  @project_id
end

#results ⇒ Google::Apis::CloudbuildV1::Results

Results describes the artifacts created by the build pipeline. Corresponds to the JSON property results

Returns:



243
244
245
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 243

def results
  @results
end

#source ⇒ Google::Apis::CloudbuildV1::Source

Source describes the location of the source in a supported storage service. Corresponds to the JSON property source

Returns:



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

def source
  @source
end

#source_provenance ⇒ Google::Apis::CloudbuildV1::SourceProvenance

Provenance of the source. Ways to find the original source, or verify that some source was used for this build. Corresponds to the JSON property sourceProvenance

Returns:



283
284
285
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 283

def source_provenance
  @source_provenance
end

#start_time ⇒ String

Time at which execution of the build was started. Corresponds to the JSON property startTime

Returns:

  • (String) 


277
278
279
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 277

def start_time
  @start_time
end

#status ⇒ String

Status of the build. Corresponds to the JSON property status

Returns:

  • (String) 


221
222
223
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 221

def status
  @status
end

#status_detail ⇒ String

Customer-readable message about the current status. Corresponds to the JSON property statusDetail

Returns:

  • (String) 


215
216
217
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 215

def status_detail
  @status_detail
end

#steps ⇒ Array<Google::Apis::CloudbuildV1::BuildStep>

Describes the operations to be performed on the workspace. Corresponds to the JSON property steps

Returns:



248
249
250
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 248

def steps
  @steps
end

#substitutions ⇒ Hash<String,String>

Substitutions data for Build resource. Corresponds to the JSON property substitutions

Returns:

  • (Hash<String,String>) 


271
272
273
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 271

def substitutions
  @substitutions
end

#tags ⇒ Array<String>

Tags for annotation of a Build. These are not docker tags. Corresponds to the JSON property tags

Returns:

  • (Array<String>) 


260
261
262
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 260

def tags
  @tags
end

#timeout ⇒ String

Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be TIMEOUT. Default time is ten minutes. Corresponds to the JSON property timeout

Returns:

  • (String) 


229
230
231
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 229

def timeout
  @timeout
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 337

def update!(**args)
  @status_detail = args[:status_detail] if args.key?(:status_detail)
  @status = args[:status] if args.key?(:status)
  @timeout = args[:timeout] if args.key?(:timeout)
  @logs_bucket = args[:logs_bucket] if args.key?(:logs_bucket)
  @results = args[:results] if args.key?(:results)
  @steps = args[:steps] if args.key?(:steps)
  @build_trigger_id = args[:build_trigger_id] if args.key?(:build_trigger_id)
  @tags = args[:tags] if args.key?(:tags)
  @id = args[:id] if args.key?(:id)
  @substitutions = args[:substitutions] if args.key?(:substitutions)
  @start_time = args[:start_time] if args.key?(:start_time)
  @source_provenance = args[:source_provenance] if args.key?(:source_provenance)
  @create_time = args[:create_time] if args.key?(:create_time)
  @images = args[:images] if args.key?(:images)
  @project_id = args[:project_id] if args.key?(:project_id)
  @log_url = args[:log_url] if args.key?(:log_url)
  @finish_time = args[:finish_time] if args.key?(:finish_time)
  @source = args[:source] if args.key?(:source)
  @options = args[:options] if args.key?(:options)
end