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



842
843
844
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 842

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) 


750
751
752
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 750

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) 


773
774
775
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 773

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) 


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

def finish_time
  @finish_time
end

#id ⇒ String

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

Returns:

  • (String) 


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

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


789
790
791
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 789

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) 


809
810
811
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 809

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) 


733
734
735
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 733

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:



814
815
816
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 814

def options
  @options
end

#project_id ⇒ String

ID of the project. Corresponds to the JSON property projectId

Returns:

  • (String) 


795
796
797
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 795

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:



738
739
740
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 738

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:



820
821
822
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 820

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:



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

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) 


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

def start_time
  @start_time
end

#status ⇒ String

Status of the build. Corresponds to the JSON property status

Returns:

  • (String) 


832
833
834
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 832

def status
  @status
end

#status_detail ⇒ String

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

Returns:

  • (String) 


826
827
828
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 826

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:



743
744
745
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 743

def steps
  @steps
end

#substitutions ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


767
768
769
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 767

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


840
841
842
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 840

def timeout
  @timeout
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 847

def update!(**args)
  @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)
  @id = args[:id] if args.key?(:id)
  @start_time = args[:start_time] if args.key?(:start_time)
  @substitutions = args[:substitutions] if args.key?(:substitutions)
  @create_time = args[:create_time] if args.key?(:create_time)
  @source_provenance = args[:source_provenance] if args.key?(:source_provenance)
  @images = args[:images] if args.key?(:images)
  @project_id = args[:project_id] if args.key?(:project_id)
  @finish_time = args[:finish_time] if args.key?(:finish_time)
  @log_url = args[:log_url] if args.key?(:log_url)
  @options = args[:options] if args.key?(:options)
  @source = args[:source] if args.key?(:source)
  @status_detail = args[:status_detail] if args.key?(:status_detail)
  @status = args[:status] if args.key?(:status)
  @timeout = args[:timeout] if args.key?(:timeout)
end