recipe_engine

package
v0.0.0-...-9994f1b Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 22, 2025 License: BSD-3-Clause Imports: 5 Imported by: 0

README

arguments.proto is a copy of: https://github.com/luci/recipes-py/blob/5e16623c2af04706ed78dec9aa25fcf367a2f0bc/recipe_engine/arguments.proto result.proto is a copy of: https://github.com/luci/recipes-py/blob/5e16623c2af04706ed78dec9aa25fcf367a2f0bc/recipe_engine/result.proto

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_go_chromium_org_infra_tools_kitchen_third_party_recipe_engine_result_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Exception 

type Exception struct {

	// Traceback of an exception which occurred.
	Traceback []string `protobuf:"bytes,1,rep,name=traceback,proto3" json:"traceback,omitempty"`
	// contains filtered or unexported fields
}

An unexpected exception occurred during execution. Caused by the builtin Exception class.

func (*Exception) Descriptor deprecated 

func (*Exception) Descriptor() ([]byte, []int)

Deprecated: Use Exception.ProtoReflect.Descriptor instead.

func (*Exception) GetTraceback 

func (x *Exception) GetTraceback() []string

func (*Exception) ProtoMessage 

func (*Exception) ProtoMessage()

func (*Exception) ProtoReflect 

func (x *Exception) ProtoReflect() protoreflect.Message

func (*Exception) Reset 

func (x *Exception) Reset()

func (*Exception) String 

func (x *Exception) String() string

type Failure 

type Failure struct {

	// A reason readable by humans. Printed to the UI, and will be seen by users.
	HumanReason string `protobuf:"bytes,1,opt,name=human_reason,json=humanReason,proto3" json:"human_reason,omitempty"`
	// The cause of this failure.
	//
	// Types that are valid to be assigned to FailureType:
	//
	//	*Failure_Timeout
	//	*Failure_Exception
	//	*Failure_StepData
	//	*Failure_Failure
	FailureType isFailure_FailureType `protobuf_oneof:"failure_type"`
	// contains filtered or unexported fields
}

func (*Failure) Descriptor deprecated 

func (*Failure) Descriptor() ([]byte, []int)

Deprecated: Use Failure.ProtoReflect.Descriptor instead.

func (*Failure) GetException 

func (x *Failure) GetException() *Exception

func (*Failure) GetFailure 

func (x *Failure) GetFailure() *StepFailure

func (*Failure) GetFailureType 

func (x *Failure) GetFailureType() isFailure_FailureType

func (*Failure) GetHumanReason 

func (x *Failure) GetHumanReason() string

func (*Failure) GetStepData 

func (x *Failure) GetStepData() *StepData

func (*Failure) GetTimeout 

func (x *Failure) GetTimeout() *Timeout

func (*Failure) ProtoMessage 

func (*Failure) ProtoMessage()

func (*Failure) ProtoReflect 

func (x *Failure) ProtoReflect() protoreflect.Message

func (*Failure) Reset 

func (x *Failure) Reset()

func (*Failure) String 

func (x *Failure) String() string

type Failure_Exception 

type Failure_Exception struct {
	// Step threw an exception.
	Exception *Exception `protobuf:"bytes,3,opt,name=exception,proto3,oneof"`
}

type Failure_Failure 

type Failure_Failure struct {
	// Step failed (return code not ok).
	Failure *StepFailure `protobuf:"bytes,5,opt,name=failure,proto3,oneof"`
}

type Failure_StepData 

type Failure_StepData struct {
	// Step accessed invalid step data.
	StepData *StepData `protobuf:"bytes,4,opt,name=step_data,json=stepData,proto3,oneof"`
}

type Failure_Timeout 

type Failure_Timeout struct {
	// Step timed out.
	Timeout *Timeout `protobuf:"bytes,2,opt,name=timeout,proto3,oneof"`
}

type Result 

type Result struct {

	// Types that are valid to be assigned to OneofResult:
	//
	//	*Result_JsonResult
	//	*Result_Failure
	OneofResult isResult_OneofResult `protobuf_oneof:"oneof_result"`
	// contains filtered or unexported fields
}

The result of a recipe execution.

func (*Result) Descriptor deprecated 

func (*Result) Descriptor() ([]byte, []int)

Deprecated: Use Result.ProtoReflect.Descriptor instead.

func (*Result) GetFailure 

func (x *Result) GetFailure() *Failure

func (*Result) GetJsonResult 

func (x *Result) GetJsonResult() string

func (*Result) GetOneofResult 

func (x *Result) GetOneofResult() isResult_OneofResult

func (*Result) ProtoMessage 

func (*Result) ProtoMessage()

func (*Result) ProtoReflect 

func (x *Result) ProtoReflect() protoreflect.Message

func (*Result) Reset 

func (x *Result) Reset()

func (*Result) String 

func (x *Result) String() string

type Result_Failure 

type Result_Failure struct {
	// The cause of the failure of a recipe.
	Failure *Failure `protobuf:"bytes,2,opt,name=failure,proto3,oneof"`
}

type Result_JsonResult 

type Result_JsonResult struct {
	// The json result of a recipe. Guaranteed to be a JSON 'object' (e.g.
	// "{...}") or omitted.
	JsonResult string `protobuf:"bytes,1,opt,name=json_result,json=jsonResult,proto3,oneof"`
}

type StepData 

type StepData struct {

	// The step which attempted to access invalid data.
	Step string `protobuf:"bytes,1,opt,name=step,proto3" json:"step,omitempty"`
	// contains filtered or unexported fields
}

A step attempted to access data which did not exist. Caused by StepDataAttributeError in types.py.

func (*StepData) Descriptor deprecated 

func (*StepData) Descriptor() ([]byte, []int)

Deprecated: Use StepData.ProtoReflect.Descriptor instead.

func (*StepData) GetStep 

func (x *StepData) GetStep() string

func (*StepData) ProtoMessage 

func (*StepData) ProtoMessage()

func (*StepData) ProtoReflect 

func (x *StepData) ProtoReflect() protoreflect.Message

func (*StepData) Reset 

func (x *StepData) Reset()

func (*StepData) String 

func (x *StepData) String() string

type StepFailure 

type StepFailure struct {

	// The step which failed.
	Step string `protobuf:"bytes,1,opt,name=step,proto3" json:"step,omitempty"`
	// contains filtered or unexported fields
}

A step failed to execute "correctly". Correct generally is indicated by a return code of 0, but the step can allow for other return codes as well.

func (*StepFailure) Descriptor deprecated 

func (*StepFailure) Descriptor() ([]byte, []int)

Deprecated: Use StepFailure.ProtoReflect.Descriptor instead.

func (*StepFailure) GetStep 

func (x *StepFailure) GetStep() string

func (*StepFailure) ProtoMessage 

func (*StepFailure) ProtoMessage()

func (*StepFailure) ProtoReflect 

func (x *StepFailure) ProtoReflect() protoreflect.Message

func (*StepFailure) Reset 

func (x *StepFailure) Reset()

func (*StepFailure) String 

func (x *StepFailure) String() string

type Timeout 

type Timeout struct {

	// The timeout set for the step.
	TimeoutS float32 `protobuf:"fixed32,1,opt,name=timeout_s,json=timeoutS,proto3" json:"timeout_s,omitempty"`
	// contains filtered or unexported fields
}

A step timed out during its execution. Caused by StepTimeout in recipe_api.py

func (*Timeout) Descriptor deprecated 

func (*Timeout) Descriptor() ([]byte, []int)

Deprecated: Use Timeout.ProtoReflect.Descriptor instead.

func (*Timeout) GetTimeoutS 

func (x *Timeout) GetTimeoutS() float32

func (*Timeout) ProtoMessage 

func (*Timeout) ProtoMessage()

func (*Timeout) ProtoReflect 

func (x *Timeout) ProtoReflect() protoreflect.Message

func (*Timeout) Reset 

func (x *Timeout) Reset()

func (*Timeout) String 

func (x *Timeout) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.