Grafeas V1 Client - Class BuildOccurrence (1.1.2)

Reference documentation and code samples for the Grafeas V1 Client class BuildOccurrence.

Details of a build occurrence.

Generated from protobuf message grafeas.v1.BuildOccurrence

Namespace

Grafeas \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ provenance BuildProvenance

The actual provenance for the build.
↳ provenance_bytes string

Serialized JSON representation of the provenance, used in generating the build signature in the corresponding build note. After verifying the signature, provenance_bytes can be unmarshalled and compared to the provenance to confirm that it is unchanged. A base64-encoded string representation of the provenance bytes is used for the signature in order to interoperate with openssl which expects this format for signature verification. The serialized form is captured both to avoid ambiguity in how the provenance is marshalled to json as well to prevent incompatibilities with future changes.
↳ intoto_provenance InTotoProvenance

Deprecated. See InTotoStatement for the replacement. In-toto Provenance representation as defined in spec.
↳ intoto_statement InTotoStatement

In-toto Statement representation as defined in spec. The intoto_statement can contain any type of provenance. The serialized payload of the statement can be stored and signed in the Occurrence's envelope.
↳ in_toto_slsa_provenance_v1 InTotoSlsaProvenanceV1

In-Toto Slsa Provenance V1 represents a slsa provenance meeting the slsa spec, wrapped in an in-toto statement. This allows for direct jsonification of a to-spec in-toto slsa statement with a to-spec slsa provenance.

getProvenance

The actual provenance for the build.

Returns
Type Description
BuildProvenance|null

hasProvenance

clearProvenance

setProvenance

The actual provenance for the build.

Parameter
Name Description
var BuildProvenance
Returns
Type Description
$this

getProvenanceBytes

Serialized JSON representation of the provenance, used in generating the build signature in the corresponding build note. After verifying the signature, provenance_bytes can be unmarshalled and compared to the provenance to confirm that it is unchanged. A base64-encoded string representation of the provenance bytes is used for the signature in order to interoperate with openssl which expects this format for signature verification.

The serialized form is captured both to avoid ambiguity in how the provenance is marshalled to json as well to prevent incompatibilities with future changes.

Returns
Type Description
string

setProvenanceBytes

Serialized JSON representation of the provenance, used in generating the build signature in the corresponding build note. After verifying the signature, provenance_bytes can be unmarshalled and compared to the provenance to confirm that it is unchanged. A base64-encoded string representation of the provenance bytes is used for the signature in order to interoperate with openssl which expects this format for signature verification.

The serialized form is captured both to avoid ambiguity in how the provenance is marshalled to json as well to prevent incompatibilities with future changes.

Parameter
Name Description
var string
Returns
Type Description
$this

getIntotoProvenance

Deprecated. See InTotoStatement for the replacement.

In-toto Provenance representation as defined in spec.

Returns
Type Description
InTotoProvenance|null

hasIntotoProvenance

clearIntotoProvenance

setIntotoProvenance

Deprecated. See InTotoStatement for the replacement.

In-toto Provenance representation as defined in spec.

Parameter
Name Description
var InTotoProvenance
Returns
Type Description
$this

getIntotoStatement

In-toto Statement representation as defined in spec.

The intoto_statement can contain any type of provenance. The serialized payload of the statement can be stored and signed in the Occurrence's envelope.

Returns
Type Description
InTotoStatement|null

hasIntotoStatement

clearIntotoStatement

setIntotoStatement

In-toto Statement representation as defined in spec.

The intoto_statement can contain any type of provenance. The serialized payload of the statement can be stored and signed in the Occurrence's envelope.

Parameter
Name Description
var InTotoStatement
Returns
Type Description
$this

getInTotoSlsaProvenanceV1

In-Toto Slsa Provenance V1 represents a slsa provenance meeting the slsa spec, wrapped in an in-toto statement. This allows for direct jsonification of a to-spec in-toto slsa statement with a to-spec slsa provenance.

Returns
Type Description
InTotoSlsaProvenanceV1|null

hasInTotoSlsaProvenanceV1

clearInTotoSlsaProvenanceV1

setInTotoSlsaProvenanceV1

In-Toto Slsa Provenance V1 represents a slsa provenance meeting the slsa spec, wrapped in an in-toto statement. This allows for direct jsonification of a to-spec in-toto slsa statement with a to-spec slsa provenance.

Parameter
Name Description
var InTotoSlsaProvenanceV1
Returns
Type Description
$this