Class Recipe (2.45.0)

public final class Recipe extends GeneratedMessageV3 implements RecipeOrBuilder

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

Protobuf type grafeas.v1.Recipe

Implements

RecipeOrBuilder

Static Fields

ARGUMENTS_FIELD_NUMBER

public static final int ARGUMENTS_FIELD_NUMBER
Field Value
Type Description
int

DEFINED_IN_MATERIAL_FIELD_NUMBER

public static final int DEFINED_IN_MATERIAL_FIELD_NUMBER
Field Value
Type Description
int

ENTRY_POINT_FIELD_NUMBER

public static final int ENTRY_POINT_FIELD_NUMBER
Field Value
Type Description
int

ENVIRONMENT_FIELD_NUMBER

public static final int ENVIRONMENT_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Recipe getDefaultInstance()
Returns
Type Description
Recipe

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Recipe.Builder newBuilder()
Returns
Type Description
Recipe.Builder

newBuilder(Recipe prototype)

public static Recipe.Builder newBuilder(Recipe prototype)
Parameter
Name Description
prototype Recipe
Returns
Type Description
Recipe.Builder

parseDelimitedFrom(InputStream input)

public static Recipe parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Recipe
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Recipe parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Recipe
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Recipe parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Recipe
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Recipe parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Recipe
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Recipe parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Recipe
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Recipe parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Recipe
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Recipe parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Recipe
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Recipe parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Recipe
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Recipe parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Recipe
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Recipe parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Recipe
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Recipe parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Recipe
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Recipe parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Recipe
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Recipe> parser()
Returns
Type Description
Parser<Recipe>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getArguments(int index)

public Any getArguments(int index)

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".

repeated .google.protobuf.Any arguments = 4;

Parameter
Name Description
index int
Returns
Type Description
Any

getArgumentsCount()

public int getArgumentsCount()

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".

repeated .google.protobuf.Any arguments = 4;

Returns
Type Description
int

getArgumentsList()

public List<Any> getArgumentsList()

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".

repeated .google.protobuf.Any arguments = 4;

Returns
Type Description
List<Any>

getArgumentsOrBuilder(int index)

public AnyOrBuilder getArgumentsOrBuilder(int index)

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".

repeated .google.protobuf.Any arguments = 4;

Parameter
Name Description
index int
Returns
Type Description
AnyOrBuilder

getArgumentsOrBuilderList()

public List<? extends AnyOrBuilder> getArgumentsOrBuilderList()

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".

repeated .google.protobuf.Any arguments = 4;

Returns
Type Description
List<? extends com.google.protobuf.AnyOrBuilder>

getDefaultInstanceForType()

public Recipe getDefaultInstanceForType()
Returns
Type Description
Recipe

getDefinedInMaterial()

public long 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.

int64 defined_in_material = 2;

Returns
Type Description
long

The definedInMaterial.

getEntryPoint()

public String 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.

string entry_point = 3;

Returns
Type Description
String

The entryPoint.

getEntryPointBytes()

public ByteString getEntryPointBytes()

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.

string entry_point = 3;

Returns
Type Description
ByteString

The bytes for entryPoint.

getEnvironment(int index)

public Any getEnvironment(int index)

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".

repeated .google.protobuf.Any environment = 5;

Parameter
Name Description
index int
Returns
Type Description
Any

getEnvironmentCount()

public int getEnvironmentCount()

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".

repeated .google.protobuf.Any environment = 5;

Returns
Type Description
int

getEnvironmentList()

public List<Any> getEnvironmentList()

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".

repeated .google.protobuf.Any environment = 5;

Returns
Type Description
List<Any>

getEnvironmentOrBuilder(int index)

public AnyOrBuilder getEnvironmentOrBuilder(int index)

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".

repeated .google.protobuf.Any environment = 5;

Parameter
Name Description
index int
Returns
Type Description
AnyOrBuilder

getEnvironmentOrBuilderList()

public List<? extends AnyOrBuilder> getEnvironmentOrBuilderList()

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".

repeated .google.protobuf.Any environment = 5;

Returns
Type Description
List<? extends com.google.protobuf.AnyOrBuilder>

getParserForType()

public Parser<Recipe> getParserForType()
Returns
Type Description
Parser<Recipe>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getType()

public String getType()

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

string type = 1;

Returns
Type Description
String

The type.

getTypeBytes()

public ByteString getTypeBytes()

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

string type = 1;

Returns
Type Description
ByteString

The bytes for type.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Recipe.Builder newBuilderForType()
Returns
Type Description
Recipe.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Recipe.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Recipe.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Recipe.Builder toBuilder()
Returns
Type Description
Recipe.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException