Members
(static) HashType :number
Specifies the hash algorithm, if any.
Properties:
| Name | Type | Description |
|---|---|---|
HASH_TYPE_UNSPECIFIED |
number |
Unknown. |
SHA256 |
number |
A SHA-256 hash. |
Type Definitions
Artifact
Artifact describes a build product.
Properties:
| Name | Type | Description |
|---|---|---|
checksum |
string |
Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container. |
id |
string |
Artifact ID, if any; for container images, this will be a URL by digest
like |
names |
Array.<string> |
Related artifact names. This may be the path to a binary or jar file, or in
the case of a container build, the name used to push the container image to
Google Container Registry, as presented to |
- Source:
- See:
BuildProvenance
Provenance of a build. Contains all information needed to verify the full details about the build from source to completion.
Properties:
| Name | Type | Description |
|---|---|---|
id |
string |
Unique identifier of the build. |
projectId |
string |
ID of the project. |
commands |
Array.<Object> |
Commands requested by the build. This object should have the same structure as Command |
builtArtifacts |
Array.<Object> |
Output of the build. This object should have the same structure as Artifact |
createTime |
Object |
Time at which the build was created. This object should have the same structure as Timestamp |
startTime |
Object |
Time at which execution of the build was started. This object should have the same structure as Timestamp |
endTime |
Object |
Time at which execution of the build was finished. This object should have the same structure as Timestamp |
creator |
string |
E-mail address of the user who initiated this build. Note that this was the user's e-mail address at the time the build was initiated; this address may not represent the same end-user for all time. |
logsUri |
string |
URI where any logs for this provenance were written. |
sourceProvenance |
Object |
Details of the Source input to the build. This object should have the same structure as Source |
triggerId |
string |
Trigger identifier if the build was triggered automatically; empty if not. |
buildOptions |
Object.<string, string> |
Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details. |
builderVersion |
string |
Version string of the builder at the time this build was executed. |
- Source:
- See:
Command
Command describes a step performed as part of the build pipeline.
Properties:
| Name | Type | Description |
|---|---|---|
name |
string |
Name of the command, as presented on the command line, or if the command is
packaged as a Docker container, as presented to |
env |
Array.<string> |
Environment variables set before running this command. |
args |
Array.<string> |
Command-line arguments used when executing this command. |
dir |
string |
Working directory (relative to project source root) used when running this command. |
id |
string |
Optional unique identifier for this command, used in wait_for to reference this command as a dependency. |
waitFor |
Array.<string> |
The ID(s) of the command(s) that this command depends on. |
- Source:
- See:
FileHashes
Container message for hashes of byte content of files, used in Source messages to verify integrity of source input to the build.
Properties:
| Name | Type | Description |
|---|---|---|
fileHash |
Array.<Object> |
Collection of file hashes. This object should have the same structure as Hash |
- Source:
- See:
Hash
Container message for hash values.
Properties:
| Name | Type | Description |
|---|---|---|
type |
number |
The type of hash that was performed. The number should be among the values of HashType |
value |
Buffer |
The hash value. |
- Source:
- See:
Source
Source describes the location of the source used for the build.
Properties:
| Name | Type | Description |
|---|---|---|
artifactStorageSourceUri |
string |
If provided, the input binary artifacts for the build came from this location. |
fileHashes |
Object.<string, Object> |
Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. 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. |
context |
Object |
If provided, the source code used for the build came from this location. This object should have the same structure as SourceContext |
additionalContexts |
Array.<Object> |
If provided, some of the source code used for the build may be found in these locations, in the case where the source repository had multiple remotes or submodules. This list will not include the context specified in the context field. This object should have the same structure as SourceContext |