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



872
873
874
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 872

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) 


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

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) 


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

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) 


870
871
872
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 870

def finish_time
  @finish_time
end

#id ⇒ String

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

Returns:

  • (String) 


817
818
819
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 817

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


850
851
852
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 850

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) 


862
863
864
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 862

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) 


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

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:



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

def options
  @options
end

#project_id ⇒ String

ID of the project. Corresponds to the JSON property projectId

Returns:

  • (String) 


856
857
858
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 856

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:



785
786
787
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 785

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:



760
761
762
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 760

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:



834
835
836
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 834

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) 


823
824
825
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 823

def start_time
  @start_time
end

#status ⇒ String

Status of the build. Corresponds to the JSON property status

Returns:

  • (String) 


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

def status
  @status
end

#status_detail ⇒ String

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

Returns:

  • (String) 


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

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:



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

def steps
  @steps
end

#substitutions ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


828
829
830
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 828

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


811
812
813
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 811

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) 


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

def timeout
  @timeout
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 877

def update!(**args)
  @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)
  @results = args[:results] if args.key?(:results)
  @logs_bucket = args[:logs_bucket] if args.key?(:logs_bucket)
  @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)
  @start_time = args[:start_time] if args.key?(:start_time)
  @substitutions = args[:substitutions] if args.key?(:substitutions)
  @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)
end