Grafeas v1 API - Class Recipe (3.5.0)

public sealed class Recipe : IMessage<Recipe>, IEquatable<Recipe>, IDeepCloneable<Recipe>, IBufferMessage, IMessage

Reference documentation and code samples for the Grafeas v1 API class Recipe.

Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe.

Inheritance

object > Recipe

Implements

IMessage Recipe, IEquatable Recipe, IDeepCloneable Recipe, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Grafeas.V1

Assembly

Grafeas.V1.dll

Constructors

Recipe()

public Recipe()

Recipe(Recipe)

public Recipe(Recipe other)

Parameter
Name	Description
`other`	`Recipe`

Properties

Arguments

public RepeatedField<Any> Arguments { get; }

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. Since the arguments field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".

Property Value
Type	Description
`RepeatedFieldAny`

DefinedInMaterial

public long DefinedInMaterial { get; set; }

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.

Property Value
Type	Description
`long`

EntryPoint

public string EntryPoint { get; set; }

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.

Property Value
Type	Description
`string`

Environment

public RepeatedField<Any> Environment { get; }

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. Since the environment field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".

Property Value
Type	Description
`RepeatedFieldAny`

Type

public string Type { get; set; }

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

Property Value
Type	Description
`string`