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 where to store the built artifacts. 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.
  • $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.

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



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

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

Instance Attribute Details

#artifacts ⇒ Google::Apis::CloudbuildV1::Artifacts

Artifacts produced by a build that should be uploaded upon successful completion of all build steps. Corresponds to the JSON property artifacts

Returns:



109
110
111
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 109

def artifacts
  @artifacts
end

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


116
117
118
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 116

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) 


122
123
124
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 122

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) 


130
131
132
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 130

def finish_time
  @finish_time
end

#id ⇒ String

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

Returns:

  • (String) 


136
137
138
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 136

def id
  @id
end

#images ⇒ Array<String>

A list of images to be pushed upon the successful completion of all build steps. The images are 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 status is marked FAILURE. Corresponds to the JSON property images

Returns:

  • (Array<String>) 


147
148
149
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 147

def images
  @images
end

#log_url ⇒ String

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

Returns:

  • (String) 


153
154
155
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 153

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) 


162
163
164
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 162

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:



167
168
169
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 167

def options
  @options
end

#project_id ⇒ String

ID of the project. Corresponds to the JSON property projectId

Returns:

  • (String) 


173
174
175
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 173

def project_id
  @project_id
end

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

Artifacts created by the build pipeline. Corresponds to the JSON property results

Returns:



178
179
180
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 178

def results
  @results
end

#secrets ⇒ Array<Google::Apis::CloudbuildV1::Secret>

Secrets to decrypt using Cloud Key Management Service. Corresponds to the JSON property secrets

Returns:



183
184
185
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 183

def secrets
  @secrets
end

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

Location of the source in a supported storage service. Corresponds to the JSON property source

Returns:



188
189
190
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 188

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:



194
195
196
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 194

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) 


200
201
202
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 200

def start_time
  @start_time
end

#status ⇒ String

Status of the build. Corresponds to the JSON property status

Returns:

  • (String) 


206
207
208
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 206

def status
  @status
end

#status_detail ⇒ String

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

Returns:

  • (String) 


212
213
214
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 212

def status_detail
  @status_detail
end

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

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

Returns:



217
218
219
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 217

def steps
  @steps
end

#substitutions ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


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

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


227
228
229
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 227

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) 


235
236
237
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 235

def timeout
  @timeout
end

#timing ⇒ Hash<String,Google::Apis::CloudbuildV1::TimeSpan>

Stores timing information for phases of the build. Valid keys are:

  • BUILD: time to execute all build steps
  • PUSH: time to push all specified images.
  • FETCHSOURCE: time to fetch source. If the build does not specify source or images, these keys will not be included. Corresponds to the JSON property timing

Returns:



246
247
248
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 246

def timing
  @timing
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 253

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