Grafeas V1 Client - Class BuildProvenance (0.8.3)

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

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

Generated from protobuf message grafeas.v1.BuildProvenance

Namespace

Grafeas \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ id`	`string` Required. Unique identifier of the build.
`↳ project_id`	`string` ID of the project.
`↳ commands`	`array<Grafeas\V1\Command>` Commands requested by the build.
`↳ built_artifacts`	`array<Grafeas\V1\Artifact>` Output of the build.
`↳ create_time`	`Google\Protobuf\Timestamp` Time at which the build was created.
`↳ start_time`	`Google\Protobuf\Timestamp` Time at which execution of the build was started.
`↳ end_time`	`Google\Protobuf\Timestamp` Time at which execution of the build was finished.
`↳ 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.
`↳ logs_uri`	`string` URI where any logs for this provenance were written.
`↳ source_provenance`	`Grafeas\V1\Source` Details of the Source input to the build.
`↳ trigger_id`	`string` Trigger identifier if the build was triggered automatically; empty if not.
`↳ build_options`	`array\|Google\Protobuf\Internal\MapField` Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details.
`↳ builder_version`	`string` Version string of the builder at the time this build was executed.

getId

Required. Unique identifier of the build.

Returns
Type	Description
`string`

setId

Required. Unique identifier of the build.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getProjectId

ID of the project.

Returns
Type	Description
`string`

setProjectId

ID of the project.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCommands

Commands requested by the build.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setCommands

Commands requested by the build.

Parameter
Name	Description
`var`	`array<Grafeas\V1\Command>`

Returns
Type	Description
`$this`

getBuiltArtifacts

Output of the build.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setBuiltArtifacts

Output of the build.

Parameter
Name	Description
`var`	`array<Grafeas\V1\Artifact>`

Returns
Type	Description
`$this`

getCreateTime

Time at which the build was created.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Time at which the build was created.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getStartTime

Time at which execution of the build was started.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasStartTime

clearStartTime

setStartTime

Time at which execution of the build was started.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getEndTime

Time at which execution of the build was finished.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasEndTime

clearEndTime

setEndTime

Time at which execution of the build was finished.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getCreator

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.

Returns
Type	Description
`string`

setCreator

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.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getLogsUri

URI where any logs for this provenance were written.

Returns
Type	Description
`string`

setLogsUri

URI where any logs for this provenance were written.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSourceProvenance

Details of the Source input to the build.

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

hasSourceProvenance

clearSourceProvenance

setSourceProvenance

Details of the Source input to the build.

Parameter
Name	Description
`var`	`Grafeas\V1\Source`

Returns
Type	Description
`$this`

getTriggerId

Trigger identifier if the build was triggered automatically; empty if not.

Returns
Type	Description
`string`

setTriggerId

Trigger identifier if the build was triggered automatically; empty if not.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getBuildOptions

Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setBuildOptions

Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getBuilderVersion

Version string of the builder at the time this build was executed.

Returns
Type	Description
`string`

setBuilderVersion

Version string of the builder at the time this build was executed.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`