Class: Google::Apis::CloudbuildV1alpha2::Build
- Inherits:
-
Object
- Object
- Google::Apis::CloudbuildV1alpha2::Build
- 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. - $LOCATION: the location/region 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
-
#approval ⇒ Google::Apis::CloudbuildV1alpha2::BuildApproval
BuildApproval describes a build's approval configuration, state, and result.
-
#artifacts ⇒ Google::Apis::CloudbuildV1alpha2::Artifacts
Artifacts produced by a build that should be uploaded upon successful completion of all build steps.
-
#available_secrets ⇒ Google::Apis::CloudbuildV1alpha2::Secrets
Secrets and secret environment variables.
-
#build_trigger_id ⇒ String
Output only.
-
#create_time ⇒ String
Output only.
-
#failure_info ⇒ Google::Apis::CloudbuildV1alpha2::FailureInfo
A fatal problem encountered during the execution of the build.
-
#finish_time ⇒ String
Output only.
-
#id ⇒ String
Output only.
-
#images ⇒ Array<String>
A list of images to be pushed upon the successful completion of all build steps.
-
#log_url ⇒ String
Output only.
-
#logs_bucket ⇒ String
Google Cloud Storage bucket where logs should be written (see Bucket Name Requirements ).
-
#name ⇒ String
Output only.
-
#options ⇒ Google::Apis::CloudbuildV1alpha2::BuildOptions
Optional arguments to enable specific features of builds.
-
#project_id ⇒ String
Output only.
-
#queue_ttl ⇒ String
TTL in queue for this build.
-
#results ⇒ Google::Apis::CloudbuildV1alpha2::Results
Artifacts created by the build pipeline.
-
#secrets ⇒ Array<Google::Apis::CloudbuildV1alpha2::Secret>
Secrets to decrypt using Cloud Key Management Service.
-
#service_account ⇒ String
IAM service account whose credentials will be used at build runtime.
-
#source ⇒ Google::Apis::CloudbuildV1alpha2::Source
Location of the source in a supported storage service.
-
#source_provenance ⇒ Google::Apis::CloudbuildV1alpha2::SourceProvenance
Provenance of the source.
-
#start_time ⇒ String
Output only.
-
#status ⇒ String
Output only.
-
#status_detail ⇒ String
Output only.
-
#steps ⇒ Array<Google::Apis::CloudbuildV1alpha2::BuildStep>
Required.
-
#substitutions ⇒ Hash<String,String>
Substitutions data for
Build
resource. -
#tags ⇒ Array<String>
Tags for annotation of a
Build
. -
#timeout ⇒ String
Amount of time that this build should be allowed to run, to second granularity.
-
#timing ⇒ Hash<String,Google::Apis::CloudbuildV1alpha2::TimeSpan>
Output only.
-
#warnings ⇒ Array<Google::Apis::CloudbuildV1alpha2::Warning>
Output only.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Build
constructor
A new instance of Build.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ Build
Returns a new instance of Build.
500 501 502 |
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 500 def initialize(**args) update!(**args) end |
Instance Attribute Details
#approval ⇒ Google::Apis::CloudbuildV1alpha2::BuildApproval
BuildApproval describes a build's approval configuration, state, and result.
Corresponds to the JSON property approval
331 332 333 |
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 331 def approval @approval end |
#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
337 338 339 |
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 337 def artifacts @artifacts end |
#available_secrets ⇒ Google::Apis::CloudbuildV1alpha2::Secrets
Secrets and secret environment variables.
Corresponds to the JSON property availableSecrets
342 343 344 |
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 342 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
348 349 350 |
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 348 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
353 354 355 |
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 353 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
358 359 360 |
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 358 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
364 365 366 |
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 364 def finish_time @finish_time end |
#id ⇒ String
Output only. Unique identifier of the build.
Corresponds to the JSON property id
369 370 371 |
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 369 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
378 379 380 |
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 378 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
383 384 385 |
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 383 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
390 391 392 |
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 390 def logs_bucket @logs_bucket end |
#name ⇒ String
Output only. The 'Build' name with format: projects/
project/locations/
location/builds/
build`, where
buildis a unique identifier generated by
the service.
Corresponds to the JSON property
name`
397 398 399 |
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 397 def name @name end |
#options ⇒ Google::Apis::CloudbuildV1alpha2::BuildOptions
Optional arguments to enable specific features of builds.
Corresponds to the JSON property options
402 403 404 |
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 402 def @options end |
#project_id ⇒ String
Output only. ID of the project.
Corresponds to the JSON property projectId
407 408 409 |
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 407 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
414 415 416 |
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 414 def queue_ttl @queue_ttl end |
#results ⇒ Google::Apis::CloudbuildV1alpha2::Results
Artifacts created by the build pipeline.
Corresponds to the JSON property results
419 420 421 |
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 419 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
428 429 430 |
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 428 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 property
serviceAccount`
435 436 437 |
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 435 def service_account @service_account end |
#source ⇒ Google::Apis::CloudbuildV1alpha2::Source
Location of the source in a supported storage service.
Corresponds to the JSON property source
440 441 442 |
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 440 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
446 447 448 |
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 446 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
451 452 453 |
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 451 def start_time @start_time end |
#status ⇒ String
Output only. Status of the build.
Corresponds to the JSON property status
456 457 458 |
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 456 def status @status end |
#status_detail ⇒ String
Output only. Customer-readable message about the current status.
Corresponds to the JSON property statusDetail
461 462 463 |
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 461 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
466 467 468 |
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 466 def steps @steps end |
#substitutions ⇒ Hash<String,String>
Substitutions data for Build
resource.
Corresponds to the JSON property substitutions
471 472 473 |
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 471 def substitutions @substitutions end |
#tags ⇒ Array<String>
Tags for annotation of a Build
. These are not docker tags.
Corresponds to the JSON property tags
476 477 478 |
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 476 def @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
484 485 486 |
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 484 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
493 494 495 |
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 493 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
498 499 500 |
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 498 def warnings @warnings end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 |
# File 'lib/google/apis/cloudbuild_v1alpha2/classes.rb', line 505 def update!(**args) @approval = args[:approval] if args.key?(:approval) @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 |