Grafeas V1 Client - Class SlsaRecipe (0.9.0)

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

Steps taken to build the artifact.

For a TaskRun, typically each container corresponds to one step in the recipe.

Generated from protobuf message grafeas.v1.SlsaProvenance.SlsaRecipe

Namespace

Grafeas \ V1 \ SlsaProvenance

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ type string

URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.

↳ defined_in_material int|string

Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.

↳ entry_point string

String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.

↳ arguments Google\Protobuf\Any

Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Depending on the recipe Type, the structure may be different.

↳ environment Google\Protobuf\Any

Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Depending on the recipe Type, the structure may be different.

getType

URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.

Returns
TypeDescription
string

setType

URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDefinedInMaterial

Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself.

Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.

Returns
TypeDescription
int|string

setDefinedInMaterial

Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself.

Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getEntryPoint

String identifying the entry point into the build.

This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.

Returns
TypeDescription
string

setEntryPoint

String identifying the entry point into the build.

This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getArguments

Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Depending on the recipe Type, the structure may be different.

Returns
TypeDescription
Google\Protobuf\Any|null

hasArguments

clearArguments

setArguments

Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Depending on the recipe Type, the structure may be different.

Parameter
NameDescription
var Google\Protobuf\Any
Returns
TypeDescription
$this

getEnvironment

Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Depending on the recipe Type, the structure may be different.

Returns
TypeDescription
Google\Protobuf\Any|null

hasEnvironment

clearEnvironment

setEnvironment

Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Depending on the recipe Type, the structure may be different.

Parameter
NameDescription
var Google\Protobuf\Any
Returns
TypeDescription
$this