Class Build (3.16.0)

Build(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

Attributes

NameDescription
name str
Output only. The 'Build' name with format: projects/{project}/locations/{location}/builds/{build}, where {build} is a unique identifier generated by the service.
id str
Output only. Unique identifier of the build.
project_id str
Output only. ID of the project.
status google.cloud.devtools.cloudbuild_v1.types.Build.Status
Output only. Status of the build.
status_detail str
Output only. Customer-readable message about the current status.
source google.cloud.devtools.cloudbuild_v1.types.Source
The location of the source files to build.
steps MutableSequence[google.cloud.devtools.cloudbuild_v1.types.BuildStep]
Required. The operations to be performed on the workspace.
results google.cloud.devtools.cloudbuild_v1.types.Results
Output only. Results of the build.
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. Time at which the request to create the build was received.
start_time google.protobuf.timestamp_pb2.Timestamp
Output only. Time at which execution of the build was started.
finish_time google.protobuf.timestamp_pb2.Timestamp
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.
timeout google.protobuf.duration_pb2.Duration
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.
images MutableSequence[str]
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.
queue_ttl google.protobuf.duration_pb2.Duration
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.
artifacts google.cloud.devtools.cloudbuild_v1.types.Artifacts
Artifacts produced by the build that should be uploaded upon successful completion of all build steps.
logs_bucket str
Google Cloud Storage bucket where logs should be written (see `Bucket Name Requirements
source_provenance google.cloud.devtools.cloudbuild_v1.types.SourceProvenance
Output only. A permanent fixed identifier for source.
build_trigger_id str
Output only. The ID of the BuildTrigger that triggered this build, if it was triggered automatically.
options google.cloud.devtools.cloudbuild_v1.types.BuildOptions
Special options for this build.
log_url str
Output only. URL to logs for this build in Google Cloud Console.
substitutions MutableMapping[str, str]
Substitutions data for Build resource.
tags MutableSequence[str]
Tags for annotation of a Build. These are not docker tags.
secrets MutableSequence[google.cloud.devtools.cloudbuild_v1.types.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
timing MutableMapping[str, google.cloud.devtools.cloudbuild_v1.types.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 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.
approval google.cloud.devtools.cloudbuild_v1.types.BuildApproval
Output only. Describes this build's approval configuration, status, and result.
service_account str
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.
available_secrets google.cloud.devtools.cloudbuild_v1.types.Secrets
Secrets and secret environment variables.
warnings MutableSequence[google.cloud.devtools.cloudbuild_v1.types.Build.Warning]
Output only. Non-fatal problems encountered during the execution of the build.
failure_info google.cloud.devtools.cloudbuild_v1.types.Build.FailureInfo
Output only. Contains information about the build when status=FAILURE.

Classes

FailureInfo

FailureInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A fatal problem encountered during the execution of the build.

Status

Status(value)

Possible status of a build or build step.

Values: STATUS_UNKNOWN (0): Status of the build is unknown. PENDING (10): Build has been created and is pending execution and queuing. It has not been queued. QUEUED (1): Build or step is queued; work has not yet begun. WORKING (2): Build or step is being executed. SUCCESS (3): Build or step finished successfully. FAILURE (4): Build or step failed to complete successfully. INTERNAL_ERROR (5): Build or step failed due to an internal cause. TIMEOUT (6): Build or step took longer than was allowed. CANCELLED (7): Build or step was canceled by a user. EXPIRED (9): Build was enqueued for longer than the value of queue_ttl.

SubstitutionsEntry

SubstitutionsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
NameDescription
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

TimingEntry

TimingEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
NameDescription
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

Warning

Warning(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A non-fatal problem encountered during the execution of the build.