Class: Google::Apis::CloudbuildV1alpha2::Build

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/cloudbuild_v1alpha2/classes.rb,
lib/google/apis/cloudbuild_v1alpha2/representations.rb,
lib/google/apis/cloudbuild_v1alpha2/representations.rb

Overview

A build resource in the Cloud Build 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. - $PROJECT_NUMBER: the project number 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

Constructor Details

#initialize(**args) ⇒ Build

Returns a new instance of Build.



299
300
301
 
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 299

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

Instance Attribute Details

#artifacts ⇒ Google::Apis::CloudbuildV1alpha2::Artifacts

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

Returns:



136
137
138
 
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 136

def artifacts
  @artifacts
end

#available_secrets ⇒ Google::Apis::CloudbuildV1alpha2::Secrets

Secrets and secret environment variables. Corresponds to the JSON property availableSecrets

Returns:



141
142
143
 
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 141

def available_secrets
  @available_secrets
end

#build_trigger_id ⇒ String

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

Returns:

  • (String) 


147
148
149
 
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 147

def build_trigger_id
  @build_trigger_id
end

#create_time ⇒ String

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

Returns:

  • (String) 


152
153
154
 
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 152

def create_time
  @create_time
end

#failure_info ⇒ Google::Apis::CloudbuildV1alpha2::FailureInfo

A fatal problem encountered during the execution of the build. Corresponds to the JSON property failureInfo

Returns:



157
158
159
 
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 157

def failure_info
  @failure_info
end

#finish_time ⇒ String

Output only. 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) 


163
164
165
 
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 163

def finish_time
  @finish_time
end

#id ⇒ String

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

Returns:

  • (String) 


168
169
170
 
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 168

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


177
178
179
 
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 177

def images
  @images
end

#log_url ⇒ String

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

Returns:

  • (String) 


182
183
184
 
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 182

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) 


189
190
191
 
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 189

def logs_bucket
  @logs_bucket
end

#name ⇒ String

Output only. The 'Build' name with format: projects/project/locations/ location/builds/build`, wherebuildis a unique identifier generated by the service. Corresponds to the JSON propertyname`

Returns:

  • (String) 


196
197
198
 
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 196

def name
  @name
end

#options ⇒ Google::Apis::CloudbuildV1alpha2::BuildOptions

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

Returns:



201
202
203
 
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 201

def options
  @options
end

#project_id ⇒ String

Output only. ID of the project. Corresponds to the JSON property projectId

Returns:

  • (String) 


206
207
208
 
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 206

def project_id
  @project_id
end

#queue_ttl ⇒ String

TTL in queue for this build. If provided and the build is enqueued longer than this value, the build will expire and the build status will be EXPIRED. The TTL starts ticking from create_time. Corresponds to the JSON property queueTtl

Returns:

  • (String) 


213
214
215
 
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 213

def queue_ttl
  @queue_ttl
end

#results ⇒ Google::Apis::CloudbuildV1alpha2::Results

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

Returns:



218
219
220
 
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 218

def results
  @results
end

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

Secrets to decrypt using Cloud Key Management Service. Note: Secret Manager is the recommended technique for managing sensitive data with Cloud Build. Use available_secrets to configure builds to access secrets from Secret Manager. For instructions, see: https://cloud.google.com/cloud-build/docs/securing- builds/use-secrets Corresponds to the JSON property secrets

Returns:



227
228
229
 
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 227

def secrets
  @secrets
end

#service_account ⇒ String

IAM service account whose credentials will be used at build runtime. Must be of the format projects/PROJECT_ID/serviceAccounts/ACCOUNT`. ACCOUNT can be email address or uniqueId of the service account. Corresponds to the JSON propertyserviceAccount`

Returns:

  • (String) 


234
235
236
 
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 234

def 
  @service_account
end

#source ⇒ Google::Apis::CloudbuildV1alpha2::Source

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

Returns:



239
240
241
 
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 239

def source
  @source
end

#source_provenance ⇒ Google::Apis::CloudbuildV1alpha2::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:



245
246
247
 
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 245

def source_provenance
  @source_provenance
end

#start_time ⇒ String

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

Returns:

  • (String) 


250
251
252
 
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 250

def start_time
  @start_time
end

#status ⇒ String

Output only. Status of the build. Corresponds to the JSON property status

Returns:

  • (String) 


255
256
257
 
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 255

def status
  @status
end

#status_detail ⇒ String

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

Returns:

  • (String) 


260
261
262
 
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 260

def status_detail
  @status_detail
end

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

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

Returns:



265
266
267
 
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 265

def steps
  @steps
end

#substitutions ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


270
271
272
 
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 270

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


275
276
277
 
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 275

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. timeout starts ticking from startTime. Default time is ten minutes. Corresponds to the JSON property timeout

Returns:

  • (String) 


283
284
285
 
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 283

def timeout
  @timeout
end

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

Output only. 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. * SETUPBUILD: time to set up build. If the build does not specify source or images, these keys will not be included. Corresponds to the JSON property timing

Returns:



292
293
294
 
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 292

def timing
  @timing
end

#warnings ⇒ Array<Google::Apis::CloudbuildV1alpha2::Warning>

Output only. Non-fatal problems encountered during the execution of the build. Corresponds to the JSON property warnings

Returns:



297
298
299
 
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 297

def warnings
  @warnings
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 304

def update!(**args)
  @artifacts = args[:artifacts] if args.key?(:artifacts)
  @available_secrets = args[:available_secrets] if args.key?(:available_secrets)
  @build_trigger_id = args[:build_trigger_id] if args.key?(:build_trigger_id)
  @create_time = args[:create_time] if args.key?(:create_time)
  @failure_info = args[:failure_info] if args.key?(:failure_info)
  @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)
  @name = args[:name] if args.key?(:name)
  @options = args[:options] if args.key?(:options)
  @project_id = args[:project_id] if args.key?(:project_id)
  @queue_ttl = args[:queue_ttl] if args.key?(:queue_ttl)
  @results = args[:results] if args.key?(:results)
  @secrets = args[:secrets] if args.key?(:secrets)
  @service_account = args[:service_account] if args.key?(:service_account)
  @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)
  @warnings = args[:warnings] if args.key?(:warnings)
end