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.



600
601
602
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 600

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

Instance Attribute Details

#create_time ⇒ String

Time at which the build was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


554
555
556
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 554

def create_time
  @create_time
end

#finish_time ⇒ String

Time at which execution of the build was finished. Corresponds to the JSON property finishTime

Returns:

  • (String) 


529
530
531
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 529

def finish_time
  @finish_time
end

#id ⇒ String

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

Returns:

  • (String) 


501
502
503
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 501

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


577
578
579
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 577

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) 


560
561
562
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 560

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) 


592
593
594
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 592

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:



523
524
525
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 523

def options
  @options
end

#project_id ⇒ String

ID of the project. Corresponds to the JSON property projectId

Returns:

  • (String) 


598
599
600
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 598

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:



512
513
514
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 512

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:



548
549
550
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 548

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:



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

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) 


583
584
585
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 583

def start_time
  @start_time
end

#status ⇒ String

Status of the build. Corresponds to the JSON property status

Returns:

  • (String) 


518
519
520
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 518

def status
  @status
end

#status_detail ⇒ String

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

Returns:

  • (String) 


566
567
568
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 566

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:



542
543
544
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 542

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


537
538
539
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 537

def timeout
  @timeout
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 605

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