Grafeas V1 Client - Class BuildOccurrence (0.9.0)

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`	`Grafeas\V1\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`	`Grafeas\V1\InTotoProvenance` Deprecated. See InTotoStatement for the replacement. In-toto Provenance representation as defined in spec.
`↳ intoto_statement`	`Grafeas\V1\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.

getProvenance

The actual provenance for the build.

Returns
Type	Description
`Grafeas\V1\BuildProvenance\|null`

hasProvenance

clearProvenance

setProvenance

The actual provenance for the build.

Parameter
Name	Description
`var`	`Grafeas\V1\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

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
`Grafeas\V1\InTotoProvenance\|null`

hasIntotoProvenance

clearIntotoProvenance

setIntotoProvenance

Deprecated. See InTotoStatement for the replacement.

In-toto Provenance representation as defined in spec.

Parameter
Name	Description
`var`	`Grafeas\V1\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
`Grafeas\V1\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`	`Grafeas\V1\InTotoStatement`

Returns
Type	Description
`$this`