Build class

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.

Constructors

Build({Input<Artifacts>? artifacts, Input<Secrets>? availableSecrets, Input<List<String>>? images, Input<String>? logsBucket, Input<BuildOptions>? options, Input<String>? queueTtl, Input<List<Secret>>? secrets, Input<String>? serviceAccount, Input<Source>? source, required Input<List<BuildStep>> steps, Input<Map<String, String>>? substitutions, Input<List<String>>? tags, Input<String>? timeout})
Creates a new Build. artifacts Artifacts produced by the build that should be uploaded upon successful completion of all build steps. availableSecrets Secrets and secret environment variables. images 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. logsBucket 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. options Special options for this build. queueTtl 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. secrets 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 serviceAccount 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. source The location of the source files to build. steps The operations to be performed on the workspace. substitutions Substitutions data for Build resource. tags Tags for annotation of a Build. These are not docker tags. timeout 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 60 minutes.
const
Build.fromMap(Map<String, dynamic> map)
factory

Properties

artifacts → Input<Artifacts>?
Artifacts produced by the build that should be uploaded upon successful completion of all build steps.
final
availableSecrets → Input<Secrets>?
Secrets and secret environment variables.
final
hashCode → int
The hash code for this object.
no setterinherited
images → Input<List<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.
final
logsBucket → Input<String>?
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.
final
options → Input<BuildOptions>?
Special options for this build.
final
queueTtl → Input<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.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
secrets → Input<List<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
final
serviceAccount → Input<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.
final
source → Input<Source>?
The location of the source files to build.
final
steps → Input<List<BuildStep>>
The operations to be performed on the workspace.
final
substitutions → Input<Map<String, String>>?
Substitutions data for Build resource.
final
tags → Input<List<String>>?
Tags for annotation of a Build. These are not docker tags.
final
timeout → Input<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 60 minutes.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited