BuildResponse 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

BuildResponse({required Input<BuildApprovalResponse> approval, required Input<ArtifactsResponse> artifacts, required Input<SecretsResponse> availableSecrets, required Input<String> buildTriggerId, required Input<String> createTime, required Input<FailureInfoResponse> failureInfo, required Input<String> finishTime, required Input<List<String>> images, required Input<String> logUrl, required Input<String> logsBucket, required Input<String> name, required Input<BuildOptionsResponse> options, required Input<String> project, required Input<String> queueTtl, required Input<ResultsResponse> results, required Input<List<SecretResponse>> secrets, required Input<String> serviceAccount, required Input<SourceResponse> source, required Input<SourceProvenanceResponse> sourceProvenance, required Input<String> startTime, required Input<String> status, required Input<String> statusDetail, required Input<List<BuildStepResponse>> steps, required Input<Map<String, String>> substitutions, required Input<List<String>> tags, required Input<String> timeout, required Input<Map<String, String>> timing, required Input<List<WarningResponse>> warnings})
Creates a new BuildResponse. approval Describes this build's approval configuration, status, and result. artifacts Artifacts produced by the build that should be uploaded upon successful completion of all build steps. availableSecrets Secrets and secret environment variables. buildTriggerId The ID of the BuildTrigger that triggered this build, if it was triggered automatically. createTime Time at which the request to create the build was received. failureInfo Contains information about the build when status=FAILURE. finishTime 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. 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. logUrl URL to logs for this build in Google Cloud Console. 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. name The 'Build' name with format: projects/{project}/locations/{location}/builds/{build}, where {build} is a unique identifier generated by the service. options Special options for this build. project ID of the project. 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. results Results of the build. 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. sourceProvenance A permanent fixed identifier for source. startTime Time at which execution of the build was started. status Status of the build. statusDetail Customer-readable message about the current status. 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. timing Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps. * PUSH: time to push all artifacts including docker images and non docker artifacts. * 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. warnings Non-fatal problems encountered during the execution of the build.
const
BuildResponse.fromMap(Map<String, dynamic> map)
factory

Properties

approval → Input<BuildApprovalResponse>
Describes this build's approval configuration, status, and result.
final
artifacts → Input<ArtifactsResponse>
Artifacts produced by the build that should be uploaded upon successful completion of all build steps.
final
availableSecrets → Input<SecretsResponse>
Secrets and secret environment variables.
final
buildTriggerId → Input<String>
The ID of the BuildTrigger that triggered this build, if it was triggered automatically.
final
createTime → Input<String>
Time at which the request to create the build was received.
final
failureInfo → Input<FailureInfoResponse>
Contains information about the build when status=FAILURE.
final
finishTime → Input<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.
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
logUrl → Input<String>
URL to logs for this build in Google Cloud Console.
final
name → Input<String>
The 'Build' name with format: projects/{project}/locations/{location}/builds/{build}, where {build} is a unique identifier generated by the service.
final
options → Input<BuildOptionsResponse>
Special options for this build.
final
project → Input<String>
ID of the project.
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
results → Input<ResultsResponse>
Results of the build.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
secrets → Input<List<SecretResponse>>
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<SourceResponse>
The location of the source files to build.
final
sourceProvenance → Input<SourceProvenanceResponse>
A permanent fixed identifier for source.
final
startTime → Input<String>
Time at which execution of the build was started.
final
status → Input<String>
Status of the build.
final
statusDetail → Input<String>
Customer-readable message about the current status.
final
steps → Input<List<BuildStepResponse>>
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
timing → Input<Map<String, String>>
Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps. * PUSH: time to push all artifacts including docker images and non docker artifacts. * 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.
final
warnings → Input<List<WarningResponse>>
Non-fatal problems encountered during the execution of the build.
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