Property

Property

static

HashType  number

Specifies the hash algorithm, if any.

Properties

Name Type Optional Description

HASH_TYPE_UNSPECIFIED

 

 

Unknown.

SHA256

 

 

A SHA-256 hash.

Abstract types

static

Artifact

Artifact describes a build product.

Properties

Name Type Optional 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 gcr.io/projectID/imagename@sha256:123456.

names

Array of 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 docker push. Note that a single Artifact ID can have multiple names, for example if two tags are applied to one image.

See also

grafeas.v1beta1.provenance.Artifact definition in proto format

static

BuildProvenance

Provenance of a build. Contains all information needed to verify the full details about the build from source to completion.

Properties

Name Type Optional Description

id

string

 

Unique identifier of the build.

projectId

string

 

ID of the project.

commands

Array of Object

 

Commands requested by the build.

This object should have the same structure as Command

builtArtifacts

Array of 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 with string properties

 

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.

See also

grafeas.v1beta1.provenance.BuildProvenance definition in proto format

static

Command

Command describes a step performed as part of the build pipeline.

Properties

Name Type Optional 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 docker pull.

env

Array of string

 

Environment variables set before running this command.

args

Array of 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 of string

 

The ID(s) of the command(s) that this command depends on.

See also

grafeas.v1beta1.provenance.Command definition in proto format

static

FileHashes

Container message for hashes of byte content of files, used in Source messages to verify integrity of source input to the build.

Property

Name Type Optional Description

fileHash

Array of Object

 

Collection of file hashes.

This object should have the same structure as Hash

See also

grafeas.v1beta1.provenance.FileHashes definition in proto format

static

Hash

Container message for hash values.

Properties

Name Type Optional Description

type

number

 

The type of hash that was performed.

The number should be among the values of HashType

value

Buffer

 

The hash value.

See also

grafeas.v1beta1.provenance.Hash definition in proto format

static

Source

Source describes the location of the source used for the build.

Properties

Name Type Optional Description

artifactStorageSourceUri

string

 

If provided, the input binary artifacts for the build came from this location.

fileHashes

Object with Object properties

 

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 of 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

See also

grafeas.v1beta1.provenance.Source definition in proto format