REST Resource: projects.builds

Resource: Build

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.
  • $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.
JSON representation
{
  "id": string,
  "projectId": string,
  "status": enum(Status),
  "statusDetail": string,
  "source": {
    object(Source)
  },
  "steps": [
    {
      object(BuildStep)
    }
  ],
  "results": {
    object(Results)
  },
  "createTime": string,
  "startTime": string,
  "finishTime": string,
  "timeout": string,
  "images": [
    string
  ],
  "artifacts": {
    object(Artifacts)
  },
  "logsBucket": string,
  "sourceProvenance": {
    object(SourceProvenance)
  },
  "buildTriggerId": string,
  "options": {
    object(BuildOptions)
  },
  "logUrl": string,
  "substitutions": {
    string: string,
    ...
  },
  "tags": [
    string
  ],
  "secrets": [
    {
      object(Secret)
    }
  ],
  "timing": {
    string: {
      object(TimeSpan)
    },
    ...
  }
}
Fields
id

string

Output only. Unique identifier of the build.

projectId

string

Output only. ID of the project.

status

enum(Status)

Output only. Status of the build.

statusDetail

string

Output only. Customer-readable message about the current status.

source

object(Source)

The location of the source files to build.

steps[]

object(BuildStep)

Required. The operations to be performed on the workspace.

results

object(Results)

Output only. Results of the build.

createTime

string (Timestamp format)

Output only. Time at which the request to create the build was received.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

startTime

string (Timestamp format)

Output only. Time at which execution of the build was started.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

finishTime

string (Timestamp format)

Output only. Time at which execution of the build was finished.

The difference between finishTime and startTime is the duration of the build's execution.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

timeout

string (Duration format)

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.

Default time is ten minutes.

A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

images[]

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.

artifacts

object(Artifacts)

Artifacts produced by the build that should be uploaded upon successful completion of all build steps.

logsBucket

string

Google Cloud Storage bucket where logs should be written (see Bucket Name Requirements). Logs file names will be of the format ${logsBucket}/log-${build_id}.txt.

sourceProvenance

object(SourceProvenance)

Output only. A permanent fixed identifier for source.

buildTriggerId

string

Output only. The ID of the BuildTrigger that triggered this build, if it was triggered automatically.

options

object(BuildOptions)

Special options for this build.

logUrl

string

Output only. URL to logs for this build in Google Cloud Console.

substitutions

map (key: string, value: string)

Substitutions data for Build resource.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

tags[]

string

Tags for annotation of a Build. These are not docker tags.

secrets[]

object(Secret)

Secrets to decrypt using Cloud Key Management Service.

timing

map (key: string, value: object(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.

If the build does not specify source or images, these keys will not be included.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Status

Possible status of a build or build step.

Enums
STATUS_UNKNOWN Status of the build is unknown.
QUEUED Build or step is queued; work has not yet begun.
WORKING Build or step is being executed.
SUCCESS Build or step finished successfully.
FAILURE Build or step failed to complete successfully.
INTERNAL_ERROR Build or step failed due to an internal cause.
TIMEOUT Build or step took longer than was allowed.
CANCELLED Build or step was canceled by a user.

Source

Location of the source in a supported storage service.

JSON representation
{

  // Union field source can be only one of the following:
  "storageSource": {
    object(StorageSource)
  },
  "repoSource": {
    object(RepoSource)
  }
  // End of list of possible types for union field source.
}
Fields
Union field source. Location of source. source can be only one of the following:
storageSource

object(StorageSource)

If provided, get the source from this location in Google Cloud Storage.

repoSource

object(RepoSource)

If provided, get the source from this location in a Cloud Source Repository.

StorageSource

Location of the source in an archive file in Google Cloud Storage.

JSON representation
{
  "bucket": string,
  "object": string,
  "generation": string
}
Fields
bucket

string

Google Cloud Storage bucket containing the source (see Bucket Name Requirements).

object

string

Google Cloud Storage object containing the source.

This object must be a gzipped archive file (.tar.gz) containing source to build.

generation

string (int64 format)

Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.

BuildStep

A step in the build pipeline.

JSON representation
{
  "name": string,
  "env": [
    string
  ],
  "args": [
    string
  ],
  "dir": string,
  "id": string,
  "waitFor": [
    string
  ],
  "entrypoint": string,
  "secretEnv": [
    string
  ],
  "volumes": [
    {
      object(Volume)
    }
  ],
  "timing": {
    object(TimeSpan)
  },
  "timeout": string,
  "status": enum(Status)
}
Fields
name

string

Required. The name of the container image that will run this particular build step.

If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary.

The Docker daemon's cache will already have the latest versions of all of the officially supported build steps (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon will also have cached many of the layers for some popular images, like "ubuntu", "debian", but they will be refreshed at the time you attempt to use them.

If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step.

env[]

string

A list of environment variable definitions to be used when running a step.

The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE".

args[]

string

A list of arguments that will be presented to the step when it is started.

If the image used to run the step's container has an entrypoint, the args are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments.

dir

string

Working directory to use when running this step's container.

If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a volume for that path is specified.

If the build specifies a RepoSource with dir and a step with a dir, which specifies an absolute path, the RepoSource dir is ignored for the step's execution.

id

string

Unique identifier for this build step, used in waitFor to reference this build step as a dependency.

waitFor[]

string

The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in waitFor have completed successfully. If waitFor is empty, this build step will start when all previous build steps in the Build.Steps list have completed successfully.

entrypoint

string

Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used.

secretEnv[]

string

A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's Secret.

volumes[]

object(Volume)

List of volumes to mount into the build step.

Each volume will be created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents will be discarded.

Using a named volume in only one step is not valid as it is indicative of a mis-configured build request.

timing

object(TimeSpan)

Output only. Stores timing information for executing this build step.

timeout

string (Duration format)

Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.

A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

status

enum(Status)

Output only. Status of the build step. At this time, build step status is only updated on build completion; step status is not updated in real-time as the build progresses.

Volume

Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution.

JSON representation
{
  "name": string,
  "path": string
}
Fields
name

string

Name of the volume to mount.

Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.

path

string

Path at which to mount the volume.

Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths.

TimeSpan

Start and end times for a build execution phase.

JSON representation
{
  "startTime": string,
  "endTime": string
}
Fields
startTime

string (Timestamp format)

Start of time span.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

End of time span.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

Results

Artifacts created by the build pipeline.

JSON representation
{
  "images": [
    {
      object(BuiltImage)
    }
  ],
  "buildStepImages": [
    string
  ],
  "artifactManifest": string,
  "numArtifacts": string,
  "buildStepOutputs": [
    string
  ]
}
Fields
images[]

object(BuiltImage)

Container images that were built as a part of the build.

buildStepImages[]

string

List of build step digests, in the order corresponding to build step indices.

artifactManifest

string

Path to the artifact manifest. Only populated when artifacts are uploaded.

numArtifacts

string (int64 format)

Number of artifacts uploaded. Only populated when artifacts are uploaded.

buildStepOutputs[]

string (bytes format)

List of build step outputs, produced by builder images, in the order corresponding to build step indices.

Cloud Builders can produce this output by writing to $BUILDER_OUTPUT/output. Only the first 4KB of data is stored.

A base64-encoded string.

BuiltImage

An image built by the pipeline.

JSON representation
{
  "name": string,
  "digest": string,
  "pushTiming": {
    object(TimeSpan)
  }
}
Fields
name

string

Name used to push the container image to Google Container Registry, as presented to docker push.

digest

string

Docker Registry 2.0 digest.

pushTiming

object(TimeSpan)

Output only. Stores timing information for pushing the specified image.

Artifacts

Artifacts produced by a build that should be uploaded upon successful completion of all build steps.

JSON representation
{
  "images": [
    string
  ],
  "objects": {
    object(ArtifactObjects)
  }
}
Fields
images[]

string

A list of images to be pushed upon the successful completion of all build steps.

The images will be 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 is marked FAILURE.

objects

object(ArtifactObjects)

A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps.

Files in the workspace matching specified paths globs will be uploaded to the specified Cloud Storage location using the builder service account's credentials.

The location and generation of the uploaded objects will be stored in the Build resource's results field.

If any objects fail to be pushed, the build is marked FAILURE.

ArtifactObjects

Files in the workspace to upload to Cloud Storage upon successful completion of all build steps.

JSON representation
{
  "location": string,
  "paths": [
    string
  ],
  "timing": {
    object(TimeSpan)
  }
}
Fields
location

string

Cloud Storage bucket and optional object path, in the form "gs://bucket/path/to/somewhere/". (see Bucket Name Requirements).

Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix.

paths[]

string

Path globs used to match files in the build's workspace.

timing

object(TimeSpan)

Output only. Stores timing information for pushing all artifact objects.

SourceProvenance

Provenance of the source. Ways to find the original source, or verify that some source was used for this build.

JSON representation
{
  "resolvedStorageSource": {
    object(StorageSource)
  },
  "resolvedRepoSource": {
    object(RepoSource)
  },
  "fileHashes": {
    string: {
      object(FileHashes)
    },
    ...
  }
}
Fields
resolvedStorageSource

object(StorageSource)

A copy of the build's source.storage_source, if exists, with any generations resolved.

resolvedRepoSource

object(RepoSource)

A copy of the build's source.repo_source, if exists, with any revisions resolved.

fileHashes

map (key: string, value: object(FileHashes))

Output only. Hash(es) of the build source, which can be used to verify that the originalsource integrity was maintained in the build. Note that FileHashes willonly be populated if BuildOptions has requested a SourceProvenanceHash.

The keys to this map are file paths used as build source and the values contain the hash values for those files.

If the build source came in a single package such as a gzipped tarfile (.tar.gz), the FileHash will be for the single path to that file.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

BuildOptions

Optional arguments to enable specific features of builds.

JSON representation
{
  "sourceProvenanceHash": [
    enum(HashType)
  ],
  "requestedVerifyOption": enum(VerifyOption),
  "machineType": enum(MachineType),
  "diskSizeGb": string,
  "substitutionOption": enum(SubstitutionOption),
  "logStreamingOption": enum(LogStreamingOption),
  "logging": enum(LoggingMode)
}
Fields
sourceProvenanceHash[]

enum(HashType)

Requested hash for SourceProvenance.

requestedVerifyOption

enum(VerifyOption)

Requested verifiability options.

machineType

enum(MachineType)

Compute Engine machine type on which to run the build.

diskSizeGb

string (int64 format)

Requested disk size for the VM that runs the build. Note that this is NOT "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 1000GB; builds that request more than the maximum are rejected with an error.

substitutionOption

enum(SubstitutionOption)

Option to specify behavior when there is an error in the substitution checks.

logStreamingOption

enum(LogStreamingOption)

Option to define build log streaming behavior to Google Cloud Storage.

logging

enum(LoggingMode)

Option to specify the logging mode, which determines where the logs are stored.

HashType

Specifies the hash algorithm, if any.

Enums
NONE No hash requested.
SHA256 Use a sha256 hash.
MD5 Use a md5 hash.

VerifyOption

Specifies the manner in which the build should be verified, if at all.

Enums
NOT_VERIFIED Not a verifiable build. (default)
VERIFIED Verified build.

MachineType

Supported VM sizes.

Enums
UNSPECIFIED Standard machine type.
N1_HIGHCPU_8 Highcpu machine with 8 CPUs.
N1_HIGHCPU_32 Highcpu machine with 32 CPUs.

SubstitutionOption

Specifies the behavior when there is an error in the substitution checks.

Enums
MUST_MATCH Fails the build if error in substitutions checks, like missing a substitution in the template or in the map.
ALLOW_LOOSE Do not fail the build if error in substitutions checks.

LogStreamingOption

Specifies the behavior when writing build logs to Google Cloud Storage.

Enums
STREAM_DEFAULT Service may automatically determine build log streaming behavior.
STREAM_ON Build logs should be streamed to Google Cloud Storage.
STREAM_OFF Build logs should not be streamed to Google Cloud Storage; they will be written when the build is completed.

LoggingMode

Specifies the logging mode.

Enums
LOGGING_UNSPECIFIED The service determines the logging mode. The default is LEGACY
LEGACY Stackdriver logging and Cloud Storage logging are enabled.
GCS_ONLY Only Cloud Storage logging is enabled.

Secret

Pairs a set of secret environment variables containing encrypted values with the Cloud KMS key to use to decrypt the value.

JSON representation
{
  "kmsKeyName": string,
  "secretEnv": {
    string: string,
    ...
  }
}
Fields
kmsKeyName

string

Cloud KMS key name to use to decrypt these envs.

secretEnv

map (key: string, value: string (bytes format))

Map of environment variable name to its encrypted value.

Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 1 KB in size. There can be at most ten secret values across all of a build's secrets.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Methods

cancel

Cancels a build in progress.

create

Starts a build with the specified configuration.

get

Returns information about a previously requested build.

list

Lists previously requested builds.

retry

Creates a new build based on the specified build.
Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Build