Documentation ¶
Index ¶
- Constants
- Variables
- func RegisterStepRunnerServer(s grpc.ServiceRegistrar, srv StepRunnerServer)
- type CloseRequest
- type CloseResponse
- type Definition
- func (*Definition) Descriptor() ([]byte, []int)deprecated
- func (x *Definition) GetDelegate() string
- func (x *Definition) GetEnv() map[string]string
- func (x *Definition) GetExec() *Definition_Exec
- func (x *Definition) GetOutputs() map[string]*structpb.Value
- func (x *Definition) GetSteps() []*Step
- func (x *Definition) GetType() DefinitionType
- func (*Definition) ProtoMessage()
- func (x *Definition) ProtoReflect() protoreflect.Message
- func (x *Definition) Reset()
- func (x *Definition) String() string
- type DefinitionType
- func (DefinitionType) Descriptor() protoreflect.EnumDescriptor
- func (x DefinitionType) Enum() *DefinitionType
- func (DefinitionType) EnumDescriptor() ([]byte, []int)deprecated
- func (x DefinitionType) Number() protoreflect.EnumNumber
- func (x DefinitionType) String() string
- func (DefinitionType) Type() protoreflect.EnumType
- type Definition_Exec
- func (*Definition_Exec) Descriptor() ([]byte, []int)deprecated
- func (x *Definition_Exec) GetCommand() []string
- func (x *Definition_Exec) GetWorkDir() string
- func (*Definition_Exec) ProtoMessage()
- func (x *Definition_Exec) ProtoReflect() protoreflect.Message
- func (x *Definition_Exec) Reset()
- func (x *Definition_Exec) String() string
- type FollowLogsRequest
- func (*FollowLogsRequest) Descriptor() ([]byte, []int)deprecated
- func (x *FollowLogsRequest) GetId() string
- func (x *FollowLogsRequest) GetOffset() int64
- func (*FollowLogsRequest) ProtoMessage()
- func (x *FollowLogsRequest) ProtoReflect() protoreflect.Message
- func (x *FollowLogsRequest) Reset()
- func (x *FollowLogsRequest) String() string
- type FollowLogsResponse
- func (*FollowLogsResponse) Descriptor() ([]byte, []int)deprecated
- func (x *FollowLogsResponse) GetData() []byte
- func (*FollowLogsResponse) ProtoMessage()
- func (x *FollowLogsResponse) ProtoReflect() protoreflect.Message
- func (x *FollowLogsResponse) Reset()
- func (x *FollowLogsResponse) String() string
- type Job
- type OutputMethod
- func (OutputMethod) Descriptor() protoreflect.EnumDescriptor
- func (x OutputMethod) Enum() *OutputMethod
- func (OutputMethod) EnumDescriptor() ([]byte, []int)deprecated
- func (x OutputMethod) Number() protoreflect.EnumNumber
- func (x OutputMethod) String() string
- func (OutputMethod) Type() protoreflect.EnumType
- type RunRequest
- func (*RunRequest) Descriptor() ([]byte, []int)deprecated
- func (x *RunRequest) GetEnv() map[string]string
- func (x *RunRequest) GetId() string
- func (x *RunRequest) GetJob() *Job
- func (x *RunRequest) GetSteps() string
- func (x *RunRequest) GetWorkDir() string
- func (*RunRequest) ProtoMessage()
- func (x *RunRequest) ProtoReflect() protoreflect.Message
- func (x *RunRequest) Reset()
- func (x *RunRequest) String() string
- type RunResponse
- type Spec
- type SpecDefinition
- func (*SpecDefinition) Descriptor() ([]byte, []int)deprecated
- func (x *SpecDefinition) GetDefinition() *Definition
- func (x *SpecDefinition) GetDir() string
- func (x *SpecDefinition) GetSpec() *Spec
- func (*SpecDefinition) ProtoMessage()
- func (x *SpecDefinition) ProtoReflect() protoreflect.Message
- func (x *SpecDefinition) Reset()
- func (x *SpecDefinition) String() string
- type Spec_Content
- func (*Spec_Content) Descriptor() ([]byte, []int)deprecated
- func (x *Spec_Content) GetInputs() map[string]*Spec_Content_Input
- func (x *Spec_Content) GetOutputMethod() OutputMethod
- func (x *Spec_Content) GetOutputs() map[string]*Spec_Content_Output
- func (*Spec_Content) ProtoMessage()
- func (x *Spec_Content) ProtoReflect() protoreflect.Message
- func (x *Spec_Content) Reset()
- func (x *Spec_Content) String() string
- type Spec_Content_Input
- func (*Spec_Content_Input) Descriptor() ([]byte, []int)deprecated
- func (x *Spec_Content_Input) GetDefault() *structpb.Value
- func (x *Spec_Content_Input) GetSensitive() bool
- func (x *Spec_Content_Input) GetType() ValueType
- func (*Spec_Content_Input) ProtoMessage()
- func (x *Spec_Content_Input) ProtoReflect() protoreflect.Message
- func (x *Spec_Content_Input) Reset()
- func (x *Spec_Content_Input) String() string
- type Spec_Content_Output
- func (*Spec_Content_Output) Descriptor() ([]byte, []int)deprecated
- func (x *Spec_Content_Output) GetDefault() *structpb.Value
- func (x *Spec_Content_Output) GetSensitive() bool
- func (x *Spec_Content_Output) GetType() ValueType
- func (*Spec_Content_Output) ProtoMessage()
- func (x *Spec_Content_Output) ProtoReflect() protoreflect.Message
- func (x *Spec_Content_Output) Reset()
- func (x *Spec_Content_Output) String() string
- type Status
- func (*Status) Descriptor() ([]byte, []int)deprecated
- func (x *Status) GetEndTime() *timestamppb.Timestamp
- func (x *Status) GetId() string
- func (x *Status) GetMessage() string
- func (x *Status) GetStartTime() *timestamppb.Timestamp
- func (x *Status) GetStatus() StepResult_Status
- func (*Status) ProtoMessage()
- func (x *Status) ProtoReflect() protoreflect.Message
- func (x *Status) Reset()
- func (x *Status) String() string
- type StatusRequest
- type StatusResponse
- type Step
- func (*Step) Descriptor() ([]byte, []int)deprecated
- func (x *Step) GetEnv() map[string]string
- func (x *Step) GetInputs() map[string]*structpb.Value
- func (x *Step) GetName() string
- func (x *Step) GetStep() *Step_Reference
- func (*Step) ProtoMessage()
- func (x *Step) ProtoReflect() protoreflect.Message
- func (x *Step) Reset()
- func (x *Step) String() string
- type StepReferenceProtocol
- func (StepReferenceProtocol) Descriptor() protoreflect.EnumDescriptor
- func (x StepReferenceProtocol) Enum() *StepReferenceProtocol
- func (StepReferenceProtocol) EnumDescriptor() ([]byte, []int)deprecated
- func (x StepReferenceProtocol) Number() protoreflect.EnumNumber
- func (x StepReferenceProtocol) String() string
- func (StepReferenceProtocol) Type() protoreflect.EnumType
- type StepResult
- func (*StepResult) Descriptor() ([]byte, []int)deprecated
- func (x *StepResult) GetEnv() map[string]string
- func (x *StepResult) GetExecResult() *StepResult_ExecResult
- func (x *StepResult) GetExports() map[string]string
- func (x *StepResult) GetOutputs() map[string]*structpb.Value
- func (x *StepResult) GetSpecDefinition() *SpecDefinition
- func (x *StepResult) GetStatus() StepResult_Status
- func (x *StepResult) GetStep() *Step
- func (x *StepResult) GetSubStepResults() []*StepResult
- func (*StepResult) ProtoMessage()
- func (x *StepResult) ProtoReflect() protoreflect.Message
- func (x *StepResult) Reset()
- func (x *StepResult) String() string
- type StepResult_ExecResult
- func (*StepResult_ExecResult) Descriptor() ([]byte, []int)deprecated
- func (x *StepResult_ExecResult) GetCommand() []string
- func (x *StepResult_ExecResult) GetExitCode() int32
- func (x *StepResult_ExecResult) GetWorkDir() string
- func (*StepResult_ExecResult) ProtoMessage()
- func (x *StepResult_ExecResult) ProtoReflect() protoreflect.Message
- func (x *StepResult_ExecResult) Reset()
- func (x *StepResult_ExecResult) String() string
- type StepResult_Status
- func (StepResult_Status) Descriptor() protoreflect.EnumDescriptor
- func (x StepResult_Status) Enum() *StepResult_Status
- func (StepResult_Status) EnumDescriptor() ([]byte, []int)deprecated
- func (x StepResult_Status) Number() protoreflect.EnumNumber
- func (x StepResult_Status) String() string
- func (StepResult_Status) Type() protoreflect.EnumType
- type StepRunnerClient
- type StepRunnerServer
- type StepRunner_FollowLogsClient
- type StepRunner_FollowLogsServer
- type Step_Reference
- func (*Step_Reference) Descriptor() ([]byte, []int)deprecated
- func (x *Step_Reference) GetFilename() string
- func (x *Step_Reference) GetPath() []string
- func (x *Step_Reference) GetProtocol() StepReferenceProtocol
- func (x *Step_Reference) GetUrl() string
- func (x *Step_Reference) GetVersion() string
- func (*Step_Reference) ProtoMessage()
- func (x *Step_Reference) ProtoReflect() protoreflect.Message
- func (x *Step_Reference) Reset()
- func (x *Step_Reference) String() string
- type UnimplementedStepRunnerServer
- func (UnimplementedStepRunnerServer) Close(context.Context, *CloseRequest) (*CloseResponse, error)
- func (UnimplementedStepRunnerServer) FollowLogs(*FollowLogsRequest, StepRunner_FollowLogsServer) error
- func (UnimplementedStepRunnerServer) Run(context.Context, *RunRequest) (*RunResponse, error)
- func (UnimplementedStepRunnerServer) Status(context.Context, *StatusRequest) (*StatusResponse, error)
- type UnsafeStepRunnerServer
- type ValueType
- type Variable
- func (*Variable) Descriptor() ([]byte, []int)deprecated
- func (x *Variable) GetFile() bool
- func (x *Variable) GetKey() string
- func (x *Variable) GetMasked() bool
- func (x *Variable) GetValue() string
- func (*Variable) ProtoMessage()
- func (x *Variable) ProtoReflect() protoreflect.Message
- func (x *Variable) Reset()
- func (x *Variable) String() string
Constants ¶
const ( StepRunner_Run_FullMethodName = "/proto.StepRunner/Run" StepRunner_Close_FullMethodName = "/proto.StepRunner/Close" StepRunner_FollowLogs_FullMethodName = "/proto.StepRunner/FollowLogs" StepRunner_Status_FullMethodName = "/proto.StepRunner/Status" )
Variables ¶
var ( StepReferenceProtocol_name = map[int32]string{ 0: "step_reference_protocol_unspecified", 1: "local", 2: "git", 3: "zip", 4: "oci", } StepReferenceProtocol_value = map[string]int32{ "step_reference_protocol_unspecified": 0, "local": 1, "git": 2, "zip": 3, "oci": 4, } )
Enum value maps for StepReferenceProtocol.
var ( DefinitionType_name = map[int32]string{ 0: "definition_type_unspecified", 1: "exec", 2: "steps", } DefinitionType_value = map[string]int32{ "definition_type_unspecified": 0, "exec": 1, "steps": 2, } )
Enum value maps for DefinitionType.
var ( OutputMethod_name = map[int32]string{ 0: "output_method_unspecified", 1: "outputs", 2: "delegate", } OutputMethod_value = map[string]int32{ "output_method_unspecified": 0, "outputs": 1, "delegate": 2, } )
Enum value maps for OutputMethod.
var ( ValueType_name = map[int32]string{ 0: "value_type_unspecified", 2: "string", 3: "number", 4: "boolean", 5: "struct", 6: "array", } ValueType_value = map[string]int32{ "value_type_unspecified": 0, "string": 2, "number": 3, "boolean": 4, "struct": 5, "array": 6, } )
Enum value maps for ValueType.
var ( StepResult_Status_name = map[int32]string{ 0: "unspecified", 1: "running", 2: "success", 3: "failure", 4: "cancelled", } StepResult_Status_value = map[string]int32{ "unspecified": 0, "running": 1, "success": 2, "failure": 3, "cancelled": 4, } )
Enum value maps for StepResult_Status.
var File_step_proto protoreflect.FileDescriptor
var StepRunner_ServiceDesc = grpc.ServiceDesc{ ServiceName: "proto.StepRunner", HandlerType: (*StepRunnerServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "Run", Handler: _StepRunner_Run_Handler, }, { MethodName: "Close", Handler: _StepRunner_Close_Handler, }, { MethodName: "Status", Handler: _StepRunner_Status_Handler, }, }, Streams: []grpc.StreamDesc{ { StreamName: "FollowLogs", Handler: _StepRunner_FollowLogs_Handler, ServerStreams: true, }, }, Metadata: "step.proto", }
StepRunner_ServiceDesc is the grpc.ServiceDesc for StepRunner service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterStepRunnerServer ¶
func RegisterStepRunnerServer(s grpc.ServiceRegistrar, srv StepRunnerServer)
Types ¶
type CloseRequest ¶
type CloseRequest struct { Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // contains filtered or unexported fields }
func (*CloseRequest) Descriptor
deprecated
func (*CloseRequest) Descriptor() ([]byte, []int)
Deprecated: Use CloseRequest.ProtoReflect.Descriptor instead.
func (*CloseRequest) GetId ¶
func (x *CloseRequest) GetId() string
func (*CloseRequest) ProtoMessage ¶
func (*CloseRequest) ProtoMessage()
func (*CloseRequest) ProtoReflect ¶
func (x *CloseRequest) ProtoReflect() protoreflect.Message
func (*CloseRequest) Reset ¶
func (x *CloseRequest) Reset()
func (*CloseRequest) String ¶
func (x *CloseRequest) String() string
type CloseResponse ¶
type CloseResponse struct {
// contains filtered or unexported fields
}
func (*CloseResponse) Descriptor
deprecated
func (*CloseResponse) Descriptor() ([]byte, []int)
Deprecated: Use CloseResponse.ProtoReflect.Descriptor instead.
func (*CloseResponse) ProtoMessage ¶
func (*CloseResponse) ProtoMessage()
func (*CloseResponse) ProtoReflect ¶
func (x *CloseResponse) ProtoReflect() protoreflect.Message
func (*CloseResponse) Reset ¶
func (x *CloseResponse) Reset()
func (*CloseResponse) String ¶
func (x *CloseResponse) String() string
type Definition ¶
type Definition struct { // Type is the type of this step. Type DefinitionType `protobuf:"varint,1,opt,name=type,proto3,enum=proto.DefinitionType" json:"type,omitempty"` // Exec is a command to run for the `exec` type. Exec *Definition_Exec `protobuf:"bytes,2,opt,name=exec,proto3" json:"exec,omitempty"` // Steps is a list of sub-steps to run for the `steps` type. Steps []*Step `protobuf:"bytes,3,rep,name=steps,proto3" json:"steps,omitempty"` // Outputs are the output values for a `steps` type. They can reference the outputs of sub-steps. Outputs map[string]*structpb.Value `` /* 155-byte string literal not displayed */ // Env is a map of environment variable names to values for all steps Env map[string]string `` /* 147-byte string literal not displayed */ // Delegate selects a step by name which will produce the outputs for this step. Delegate string `protobuf:"bytes,6,opt,name=delegate,proto3" json:"delegate,omitempty"` // contains filtered or unexported fields }
Definition is the implementation of a step.
func (*Definition) Descriptor
deprecated
func (*Definition) Descriptor() ([]byte, []int)
Deprecated: Use Definition.ProtoReflect.Descriptor instead.
func (*Definition) GetDelegate ¶
func (x *Definition) GetDelegate() string
func (*Definition) GetEnv ¶
func (x *Definition) GetEnv() map[string]string
func (*Definition) GetExec ¶
func (x *Definition) GetExec() *Definition_Exec
func (*Definition) GetOutputs ¶
func (x *Definition) GetOutputs() map[string]*structpb.Value
func (*Definition) GetSteps ¶
func (x *Definition) GetSteps() []*Step
func (*Definition) GetType ¶
func (x *Definition) GetType() DefinitionType
func (*Definition) ProtoMessage ¶
func (*Definition) ProtoMessage()
func (*Definition) ProtoReflect ¶
func (x *Definition) ProtoReflect() protoreflect.Message
func (*Definition) Reset ¶
func (x *Definition) Reset()
func (*Definition) String ¶
func (x *Definition) String() string
type DefinitionType ¶
type DefinitionType int32
Definition type is either exec or steps.
const ( DefinitionType_definition_type_unspecified DefinitionType = 0 DefinitionType_exec DefinitionType = 1 DefinitionType_steps DefinitionType = 2 )
func (DefinitionType) Descriptor ¶
func (DefinitionType) Descriptor() protoreflect.EnumDescriptor
func (DefinitionType) Enum ¶
func (x DefinitionType) Enum() *DefinitionType
func (DefinitionType) EnumDescriptor
deprecated
func (DefinitionType) EnumDescriptor() ([]byte, []int)
Deprecated: Use DefinitionType.Descriptor instead.
func (DefinitionType) Number ¶
func (x DefinitionType) Number() protoreflect.EnumNumber
func (DefinitionType) String ¶
func (x DefinitionType) String() string
func (DefinitionType) Type ¶
func (DefinitionType) Type() protoreflect.EnumType
type Definition_Exec ¶
type Definition_Exec struct { // Command are the parameters to the system exec API. It does not invoke a shell. Command []string `protobuf:"bytes,1,rep,name=command,proto3" json:"command,omitempty"` // WorkDir is the working directly in which `command` will be exec'ed. WorkDir string `protobuf:"bytes,2,opt,name=work_dir,json=workDir,proto3" json:"work_dir,omitempty"` // contains filtered or unexported fields }
Exec is the details of an exec type step.
func (*Definition_Exec) Descriptor
deprecated
func (*Definition_Exec) Descriptor() ([]byte, []int)
Deprecated: Use Definition_Exec.ProtoReflect.Descriptor instead.
func (*Definition_Exec) GetCommand ¶
func (x *Definition_Exec) GetCommand() []string
func (*Definition_Exec) GetWorkDir ¶
func (x *Definition_Exec) GetWorkDir() string
func (*Definition_Exec) ProtoMessage ¶
func (*Definition_Exec) ProtoMessage()
func (*Definition_Exec) ProtoReflect ¶
func (x *Definition_Exec) ProtoReflect() protoreflect.Message
func (*Definition_Exec) Reset ¶
func (x *Definition_Exec) Reset()
func (*Definition_Exec) String ¶
func (x *Definition_Exec) String() string
type FollowLogsRequest ¶
type FollowLogsRequest struct { Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` Offset int64 `protobuf:"varint,2,opt,name=offset,proto3" json:"offset,omitempty"` // contains filtered or unexported fields }
func (*FollowLogsRequest) Descriptor
deprecated
func (*FollowLogsRequest) Descriptor() ([]byte, []int)
Deprecated: Use FollowLogsRequest.ProtoReflect.Descriptor instead.
func (*FollowLogsRequest) GetId ¶
func (x *FollowLogsRequest) GetId() string
func (*FollowLogsRequest) GetOffset ¶
func (x *FollowLogsRequest) GetOffset() int64
func (*FollowLogsRequest) ProtoMessage ¶
func (*FollowLogsRequest) ProtoMessage()
func (*FollowLogsRequest) ProtoReflect ¶
func (x *FollowLogsRequest) ProtoReflect() protoreflect.Message
func (*FollowLogsRequest) Reset ¶
func (x *FollowLogsRequest) Reset()
func (*FollowLogsRequest) String ¶
func (x *FollowLogsRequest) String() string
type FollowLogsResponse ¶
type FollowLogsResponse struct { Data []byte `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"` // contains filtered or unexported fields }
func (*FollowLogsResponse) Descriptor
deprecated
func (*FollowLogsResponse) Descriptor() ([]byte, []int)
Deprecated: Use FollowLogsResponse.ProtoReflect.Descriptor instead.
func (*FollowLogsResponse) GetData ¶
func (x *FollowLogsResponse) GetData() []byte
func (*FollowLogsResponse) ProtoMessage ¶
func (*FollowLogsResponse) ProtoMessage()
func (*FollowLogsResponse) ProtoReflect ¶
func (x *FollowLogsResponse) ProtoReflect() protoreflect.Message
func (*FollowLogsResponse) Reset ¶
func (x *FollowLogsResponse) Reset()
func (*FollowLogsResponse) String ¶
func (x *FollowLogsResponse) String() string
type Job ¶
type Job struct { Variables []*Variable `protobuf:"bytes,1,rep,name=variables,proto3" json:"variables,omitempty"` BuildDir string `protobuf:"bytes,4,opt,name=build_dir,json=buildDir,proto3" json:"build_dir,omitempty"` // contains filtered or unexported fields }
func (*Job) Descriptor
deprecated
func (*Job) GetBuildDir ¶
func (*Job) GetVariables ¶
func (*Job) ProtoMessage ¶
func (*Job) ProtoMessage()
func (*Job) ProtoReflect ¶
func (x *Job) ProtoReflect() protoreflect.Message
type OutputMethod ¶
type OutputMethod int32
OutputMethod is either outputs or delegate.
const ( OutputMethod_output_method_unspecified OutputMethod = 0 OutputMethod_outputs OutputMethod = 1 OutputMethod_delegate OutputMethod = 2 )
func (OutputMethod) Descriptor ¶
func (OutputMethod) Descriptor() protoreflect.EnumDescriptor
func (OutputMethod) Enum ¶
func (x OutputMethod) Enum() *OutputMethod
func (OutputMethod) EnumDescriptor
deprecated
func (OutputMethod) EnumDescriptor() ([]byte, []int)
Deprecated: Use OutputMethod.Descriptor instead.
func (OutputMethod) Number ¶
func (x OutputMethod) Number() protoreflect.EnumNumber
func (OutputMethod) String ¶
func (x OutputMethod) String() string
func (OutputMethod) Type ¶
func (OutputMethod) Type() protoreflect.EnumType
type RunRequest ¶
type RunRequest struct { Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` WorkDir string `protobuf:"bytes,2,opt,name=work_dir,json=workDir,proto3" json:"work_dir,omitempty"` Env map[string]string `` /* 147-byte string literal not displayed */ Job *Job `protobuf:"bytes,5,opt,name=job,proto3" json:"job,omitempty"` Steps string `protobuf:"bytes,6,opt,name=steps,proto3" json:"steps,omitempty"` // contains filtered or unexported fields }
func (*RunRequest) Descriptor
deprecated
func (*RunRequest) Descriptor() ([]byte, []int)
Deprecated: Use RunRequest.ProtoReflect.Descriptor instead.
func (*RunRequest) GetEnv ¶
func (x *RunRequest) GetEnv() map[string]string
func (*RunRequest) GetId ¶
func (x *RunRequest) GetId() string
func (*RunRequest) GetJob ¶
func (x *RunRequest) GetJob() *Job
func (*RunRequest) GetSteps ¶
func (x *RunRequest) GetSteps() string
func (*RunRequest) GetWorkDir ¶
func (x *RunRequest) GetWorkDir() string
func (*RunRequest) ProtoMessage ¶
func (*RunRequest) ProtoMessage()
func (*RunRequest) ProtoReflect ¶
func (x *RunRequest) ProtoReflect() protoreflect.Message
func (*RunRequest) Reset ¶
func (x *RunRequest) Reset()
func (*RunRequest) String ¶
func (x *RunRequest) String() string
type RunResponse ¶
type RunResponse struct {
// contains filtered or unexported fields
}
func (*RunResponse) Descriptor
deprecated
func (*RunResponse) Descriptor() ([]byte, []int)
Deprecated: Use RunResponse.ProtoReflect.Descriptor instead.
func (*RunResponse) ProtoMessage ¶
func (*RunResponse) ProtoMessage()
func (*RunResponse) ProtoReflect ¶
func (x *RunResponse) ProtoReflect() protoreflect.Message
func (*RunResponse) Reset ¶
func (x *RunResponse) Reset()
func (*RunResponse) String ¶
func (x *RunResponse) String() string
type Spec ¶
type Spec struct { // Content contains the inputs and outputs of the step. Spec *Spec_Content `protobuf:"bytes,1,opt,name=spec,proto3" json:"spec,omitempty"` // contains filtered or unexported fields }
Spec is a document describing the interface of the step.
func (*Spec) Descriptor
deprecated
func (*Spec) GetSpec ¶
func (x *Spec) GetSpec() *Spec_Content
func (*Spec) ProtoMessage ¶
func (*Spec) ProtoMessage()
func (*Spec) ProtoReflect ¶
func (x *Spec) ProtoReflect() protoreflect.Message
type SpecDefinition ¶
type SpecDefinition struct { // Spec is the first document in the file. Spec *Spec `protobuf:"bytes,1,opt,name=spec,proto3" json:"spec,omitempty"` // Definition is the second document in the file. Definition *Definition `protobuf:"bytes,2,opt,name=definition,proto3" json:"definition,omitempty"` // Dir is where the file was loaded from. Dir string `protobuf:"bytes,3,opt,name=dir,proto3" json:"dir,omitempty"` // contains filtered or unexported fields }
SpecDefinition is the spec and definition from an exec.yml file.
func (*SpecDefinition) Descriptor
deprecated
func (*SpecDefinition) Descriptor() ([]byte, []int)
Deprecated: Use SpecDefinition.ProtoReflect.Descriptor instead.
func (*SpecDefinition) GetDefinition ¶
func (x *SpecDefinition) GetDefinition() *Definition
func (*SpecDefinition) GetDir ¶
func (x *SpecDefinition) GetDir() string
func (*SpecDefinition) GetSpec ¶
func (x *SpecDefinition) GetSpec() *Spec
func (*SpecDefinition) ProtoMessage ¶
func (*SpecDefinition) ProtoMessage()
func (*SpecDefinition) ProtoReflect ¶
func (x *SpecDefinition) ProtoReflect() protoreflect.Message
func (*SpecDefinition) Reset ¶
func (x *SpecDefinition) Reset()
func (*SpecDefinition) String ¶
func (x *SpecDefinition) String() string
type Spec_Content ¶
type Spec_Content struct { // Inputs is a map of input names to their parameters. Inputs map[string]*Spec_Content_Input `` /* 153-byte string literal not displayed */ // Outputs is a map of output names to their parameters. Outputs map[string]*Spec_Content_Output `` /* 155-byte string literal not displayed */ // OutputMethod selects how this step will return its outputs. OutputMethod OutputMethod `protobuf:"varint,3,opt,name=output_method,json=outputMethod,proto3,enum=proto.OutputMethod" json:"output_method,omitempty"` // contains filtered or unexported fields }
func (*Spec_Content) Descriptor
deprecated
func (*Spec_Content) Descriptor() ([]byte, []int)
Deprecated: Use Spec_Content.ProtoReflect.Descriptor instead.
func (*Spec_Content) GetInputs ¶
func (x *Spec_Content) GetInputs() map[string]*Spec_Content_Input
func (*Spec_Content) GetOutputMethod ¶
func (x *Spec_Content) GetOutputMethod() OutputMethod
func (*Spec_Content) GetOutputs ¶
func (x *Spec_Content) GetOutputs() map[string]*Spec_Content_Output
func (*Spec_Content) ProtoMessage ¶
func (*Spec_Content) ProtoMessage()
func (*Spec_Content) ProtoReflect ¶
func (x *Spec_Content) ProtoReflect() protoreflect.Message
func (*Spec_Content) Reset ¶
func (x *Spec_Content) Reset()
func (*Spec_Content) String ¶
func (x *Spec_Content) String() string
type Spec_Content_Input ¶
type Spec_Content_Input struct { // Type is the value type of the input. Type ValueType `protobuf:"varint,1,opt,name=type,proto3,enum=proto.ValueType" json:"type,omitempty"` // Default is the default input value. Its type must match `type`. Default *structpb.Value `protobuf:"bytes,2,opt,name=default,proto3" json:"default,omitempty"` // Sensitive implies the input is of sensitive nature and effort should be made to prevent accidental disclosure. Sensitive bool `protobuf:"varint,3,opt,name=sensitive,proto3" json:"sensitive,omitempty"` // contains filtered or unexported fields }
Input describes a single step input.
func (*Spec_Content_Input) Descriptor
deprecated
func (*Spec_Content_Input) Descriptor() ([]byte, []int)
Deprecated: Use Spec_Content_Input.ProtoReflect.Descriptor instead.
func (*Spec_Content_Input) GetDefault ¶
func (x *Spec_Content_Input) GetDefault() *structpb.Value
func (*Spec_Content_Input) GetSensitive ¶
func (x *Spec_Content_Input) GetSensitive() bool
func (*Spec_Content_Input) GetType ¶
func (x *Spec_Content_Input) GetType() ValueType
func (*Spec_Content_Input) ProtoMessage ¶
func (*Spec_Content_Input) ProtoMessage()
func (*Spec_Content_Input) ProtoReflect ¶
func (x *Spec_Content_Input) ProtoReflect() protoreflect.Message
func (*Spec_Content_Input) Reset ¶
func (x *Spec_Content_Input) Reset()
func (*Spec_Content_Input) String ¶
func (x *Spec_Content_Input) String() string
type Spec_Content_Output ¶
type Spec_Content_Output struct { // Type is the value type of the output. Type ValueType `protobuf:"varint,1,opt,name=type,proto3,enum=proto.ValueType" json:"type,omitempty"` // Default is the default output value. Default *structpb.Value `protobuf:"bytes,2,opt,name=default,proto3" json:"default,omitempty"` // Sensitive implies the output is of sensitive nature and effort should be made to prevent accidental disclosure. Sensitive bool `protobuf:"varint,3,opt,name=sensitive,proto3" json:"sensitive,omitempty"` // contains filtered or unexported fields }
Output describes a single step output.
func (*Spec_Content_Output) Descriptor
deprecated
func (*Spec_Content_Output) Descriptor() ([]byte, []int)
Deprecated: Use Spec_Content_Output.ProtoReflect.Descriptor instead.
func (*Spec_Content_Output) GetDefault ¶
func (x *Spec_Content_Output) GetDefault() *structpb.Value
func (*Spec_Content_Output) GetSensitive ¶
func (x *Spec_Content_Output) GetSensitive() bool
func (*Spec_Content_Output) GetType ¶
func (x *Spec_Content_Output) GetType() ValueType
func (*Spec_Content_Output) ProtoMessage ¶
func (*Spec_Content_Output) ProtoMessage()
func (*Spec_Content_Output) ProtoReflect ¶
func (x *Spec_Content_Output) ProtoReflect() protoreflect.Message
func (*Spec_Content_Output) Reset ¶
func (x *Spec_Content_Output) Reset()
func (*Spec_Content_Output) String ¶
func (x *Spec_Content_Output) String() string
type Status ¶
type Status struct { Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"` Status StepResult_Status `protobuf:"varint,3,opt,name=status,proto3,enum=proto.StepResult_Status" json:"status,omitempty"` StartTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"` EndTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"` // contains filtered or unexported fields }
func (*Status) Descriptor
deprecated
func (*Status) GetEndTime ¶
func (x *Status) GetEndTime() *timestamppb.Timestamp
func (*Status) GetMessage ¶
func (*Status) GetStartTime ¶
func (x *Status) GetStartTime() *timestamppb.Timestamp
func (*Status) GetStatus ¶
func (x *Status) GetStatus() StepResult_Status
func (*Status) ProtoMessage ¶
func (*Status) ProtoMessage()
func (*Status) ProtoReflect ¶
func (x *Status) ProtoReflect() protoreflect.Message
type StatusRequest ¶
type StatusRequest struct { Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // contains filtered or unexported fields }
func (*StatusRequest) Descriptor
deprecated
func (*StatusRequest) Descriptor() ([]byte, []int)
Deprecated: Use StatusRequest.ProtoReflect.Descriptor instead.
func (*StatusRequest) GetId ¶
func (x *StatusRequest) GetId() string
func (*StatusRequest) ProtoMessage ¶
func (*StatusRequest) ProtoMessage()
func (*StatusRequest) ProtoReflect ¶
func (x *StatusRequest) ProtoReflect() protoreflect.Message
func (*StatusRequest) Reset ¶
func (x *StatusRequest) Reset()
func (*StatusRequest) String ¶
func (x *StatusRequest) String() string
type StatusResponse ¶
type StatusResponse struct { Jobs []*Status `protobuf:"bytes,1,rep,name=jobs,proto3" json:"jobs,omitempty"` // contains filtered or unexported fields }
func (*StatusResponse) Descriptor
deprecated
func (*StatusResponse) Descriptor() ([]byte, []int)
Deprecated: Use StatusResponse.ProtoReflect.Descriptor instead.
func (*StatusResponse) GetJobs ¶
func (x *StatusResponse) GetJobs() []*Status
func (*StatusResponse) ProtoMessage ¶
func (*StatusResponse) ProtoMessage()
func (*StatusResponse) ProtoReflect ¶
func (x *StatusResponse) ProtoReflect() protoreflect.Message
func (*StatusResponse) Reset ¶
func (x *StatusResponse) Reset()
func (*StatusResponse) String ¶
func (x *StatusResponse) String() string
type Step ¶
type Step struct { // Name is a unique identifier for this step. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Step is a reference to the step to invoke. Step *Step_Reference `protobuf:"bytes,2,opt,name=step,proto3" json:"step,omitempty"` // Env is a map of environment variable names to string values. Env map[string]string `` /* 147-byte string literal not displayed */ // Inputs is a map of step input names to structured values. Inputs map[string]*structpb.Value `` /* 153-byte string literal not displayed */ // contains filtered or unexported fields }
Step is a single step invocation.
func (*Step) Descriptor
deprecated
func (*Step) GetStep ¶
func (x *Step) GetStep() *Step_Reference
func (*Step) ProtoMessage ¶
func (*Step) ProtoMessage()
func (*Step) ProtoReflect ¶
func (x *Step) ProtoReflect() protoreflect.Message
type StepReferenceProtocol ¶
type StepReferenceProtocol int32
StepReferenceProtocol is the method of fetching the referenced step.
const ( StepReferenceProtocol_step_reference_protocol_unspecified StepReferenceProtocol = 0 StepReferenceProtocol_local StepReferenceProtocol = 1 StepReferenceProtocol_git StepReferenceProtocol = 2 StepReferenceProtocol_zip StepReferenceProtocol = 3 StepReferenceProtocol_oci StepReferenceProtocol = 4 )
func (StepReferenceProtocol) Descriptor ¶
func (StepReferenceProtocol) Descriptor() protoreflect.EnumDescriptor
func (StepReferenceProtocol) Enum ¶
func (x StepReferenceProtocol) Enum() *StepReferenceProtocol
func (StepReferenceProtocol) EnumDescriptor
deprecated
func (StepReferenceProtocol) EnumDescriptor() ([]byte, []int)
Deprecated: Use StepReferenceProtocol.Descriptor instead.
func (StepReferenceProtocol) Number ¶
func (x StepReferenceProtocol) Number() protoreflect.EnumNumber
func (StepReferenceProtocol) String ¶
func (x StepReferenceProtocol) String() string
func (StepReferenceProtocol) Type ¶
func (StepReferenceProtocol) Type() protoreflect.EnumType
type StepResult ¶
type StepResult struct { // Step is the invocation of this step with inputs. Expressions are expanded. Step *Step `protobuf:"bytes,1,opt,name=step,proto3" json:"step,omitempty"` // SpecDefinition is this step's spec and definition. Expressions are not expanded. SpecDefinition *SpecDefinition `protobuf:"bytes,2,opt,name=specDefinition,proto3" json:"specDefinition,omitempty"` // Status is the state of this step. Status StepResult_Status `protobuf:"varint,4,opt,name=status,proto3,enum=proto.StepResult_Status" json:"status,omitempty"` // Outputs are the output values returned from this step. Outputs map[string]*structpb.Value `` /* 155-byte string literal not displayed */ // Exports are the environment variables exported from this step. Exports map[string]string `` /* 155-byte string literal not displayed */ // Env is the environment at the step definition level. Expressions are expanded. Env map[string]string `` /* 147-byte string literal not displayed */ // ExecResult is the details of an exec type step. ExecResult *StepResult_ExecResult `protobuf:"bytes,8,opt,name=exec_result,json=execResult,proto3" json:"exec_result,omitempty"` // SubStepResults are the details of a steps type step. SubStepResults []*StepResult `protobuf:"bytes,9,rep,name=sub_step_results,json=subStepResults,proto3" json:"sub_step_results,omitempty"` // contains filtered or unexported fields }
StepResult is the result of executing a single step.
func (*StepResult) Descriptor
deprecated
func (*StepResult) Descriptor() ([]byte, []int)
Deprecated: Use StepResult.ProtoReflect.Descriptor instead.
func (*StepResult) GetEnv ¶
func (x *StepResult) GetEnv() map[string]string
func (*StepResult) GetExecResult ¶
func (x *StepResult) GetExecResult() *StepResult_ExecResult
func (*StepResult) GetExports ¶
func (x *StepResult) GetExports() map[string]string
func (*StepResult) GetOutputs ¶
func (x *StepResult) GetOutputs() map[string]*structpb.Value
func (*StepResult) GetSpecDefinition ¶
func (x *StepResult) GetSpecDefinition() *SpecDefinition
func (*StepResult) GetStatus ¶
func (x *StepResult) GetStatus() StepResult_Status
func (*StepResult) GetStep ¶
func (x *StepResult) GetStep() *Step
func (*StepResult) GetSubStepResults ¶
func (x *StepResult) GetSubStepResults() []*StepResult
func (*StepResult) ProtoMessage ¶
func (*StepResult) ProtoMessage()
func (*StepResult) ProtoReflect ¶
func (x *StepResult) ProtoReflect() protoreflect.Message
func (*StepResult) Reset ¶
func (x *StepResult) Reset()
func (*StepResult) String ¶
func (x *StepResult) String() string
type StepResult_ExecResult ¶
type StepResult_ExecResult struct { // Command are the exec parameters. Expressions are expanded. Command []string `protobuf:"bytes,1,rep,name=command,proto3" json:"command,omitempty"` // WorkDir is the exec working directory. Expressions are expanded. WorkDir string `protobuf:"bytes,2,opt,name=work_dir,json=workDir,proto3" json:"work_dir,omitempty"` // ExitCode is the exit code of the exec process. ExitCode int32 `protobuf:"varint,3,opt,name=exit_code,json=exitCode,proto3" json:"exit_code,omitempty"` // contains filtered or unexported fields }
ExecResult contains the details of an exec call.
func (*StepResult_ExecResult) Descriptor
deprecated
func (*StepResult_ExecResult) Descriptor() ([]byte, []int)
Deprecated: Use StepResult_ExecResult.ProtoReflect.Descriptor instead.
func (*StepResult_ExecResult) GetCommand ¶
func (x *StepResult_ExecResult) GetCommand() []string
func (*StepResult_ExecResult) GetExitCode ¶
func (x *StepResult_ExecResult) GetExitCode() int32
func (*StepResult_ExecResult) GetWorkDir ¶
func (x *StepResult_ExecResult) GetWorkDir() string
func (*StepResult_ExecResult) ProtoMessage ¶
func (*StepResult_ExecResult) ProtoMessage()
func (*StepResult_ExecResult) ProtoReflect ¶
func (x *StepResult_ExecResult) ProtoReflect() protoreflect.Message
func (*StepResult_ExecResult) Reset ¶
func (x *StepResult_ExecResult) Reset()
func (*StepResult_ExecResult) String ¶
func (x *StepResult_ExecResult) String() string
type StepResult_Status ¶
type StepResult_Status int32
Status is an enumerations of the states a step can be in during execution.
const ( StepResult_unspecified StepResult_Status = 0 StepResult_running StepResult_Status = 1 StepResult_success StepResult_Status = 2 StepResult_failure StepResult_Status = 3 StepResult_cancelled StepResult_Status = 4 )
func (StepResult_Status) Descriptor ¶
func (StepResult_Status) Descriptor() protoreflect.EnumDescriptor
func (StepResult_Status) Enum ¶
func (x StepResult_Status) Enum() *StepResult_Status
func (StepResult_Status) EnumDescriptor
deprecated
func (StepResult_Status) EnumDescriptor() ([]byte, []int)
Deprecated: Use StepResult_Status.Descriptor instead.
func (StepResult_Status) Number ¶
func (x StepResult_Status) Number() protoreflect.EnumNumber
func (StepResult_Status) String ¶
func (x StepResult_Status) String() string
func (StepResult_Status) Type ¶
func (StepResult_Status) Type() protoreflect.EnumType
type StepRunnerClient ¶
type StepRunnerClient interface { Run(ctx context.Context, in *RunRequest, opts ...grpc.CallOption) (*RunResponse, error) Close(ctx context.Context, in *CloseRequest, opts ...grpc.CallOption) (*CloseResponse, error) FollowLogs(ctx context.Context, in *FollowLogsRequest, opts ...grpc.CallOption) (StepRunner_FollowLogsClient, error) Status(ctx context.Context, in *StatusRequest, opts ...grpc.CallOption) (*StatusResponse, error) }
StepRunnerClient is the client API for StepRunner service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewStepRunnerClient ¶
func NewStepRunnerClient(cc grpc.ClientConnInterface) StepRunnerClient
type StepRunnerServer ¶
type StepRunnerServer interface { Run(context.Context, *RunRequest) (*RunResponse, error) Close(context.Context, *CloseRequest) (*CloseResponse, error) FollowLogs(*FollowLogsRequest, StepRunner_FollowLogsServer) error Status(context.Context, *StatusRequest) (*StatusResponse, error) // contains filtered or unexported methods }
StepRunnerServer is the server API for StepRunner service. All implementations must embed UnimplementedStepRunnerServer for forward compatibility
type StepRunner_FollowLogsClient ¶
type StepRunner_FollowLogsClient interface { Recv() (*FollowLogsResponse, error) grpc.ClientStream }
type StepRunner_FollowLogsServer ¶
type StepRunner_FollowLogsServer interface { Send(*FollowLogsResponse) error grpc.ServerStream }
type Step_Reference ¶
type Step_Reference struct { // Protocol determines which step reference protocol to use when fetching the step. Protocol StepReferenceProtocol `protobuf:"varint,1,opt,name=protocol,proto3,enum=proto.StepReferenceProtocol" json:"protocol,omitempty"` // Url is the location of the referenced step. Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"` // Path is the location of the step spec and definition within the URL. Path []string `protobuf:"bytes,3,rep,name=path,proto3" json:"path,omitempty"` // Filename is the name of the file which contains the step spec and definition. Filename string `protobuf:"bytes,4,opt,name=filename,proto3" json:"filename,omitempty"` // Version is which version of the step to use. Version string `protobuf:"bytes,5,opt,name=version,proto3" json:"version,omitempty"` // contains filtered or unexported fields }
Reference is a reference to a step. References can contain either a short or a full form.
func (*Step_Reference) Descriptor
deprecated
func (*Step_Reference) Descriptor() ([]byte, []int)
Deprecated: Use Step_Reference.ProtoReflect.Descriptor instead.
func (*Step_Reference) GetFilename ¶
func (x *Step_Reference) GetFilename() string
func (*Step_Reference) GetPath ¶
func (x *Step_Reference) GetPath() []string
func (*Step_Reference) GetProtocol ¶
func (x *Step_Reference) GetProtocol() StepReferenceProtocol
func (*Step_Reference) GetUrl ¶
func (x *Step_Reference) GetUrl() string
func (*Step_Reference) GetVersion ¶
func (x *Step_Reference) GetVersion() string
func (*Step_Reference) ProtoMessage ¶
func (*Step_Reference) ProtoMessage()
func (*Step_Reference) ProtoReflect ¶
func (x *Step_Reference) ProtoReflect() protoreflect.Message
func (*Step_Reference) Reset ¶
func (x *Step_Reference) Reset()
func (*Step_Reference) String ¶
func (x *Step_Reference) String() string
type UnimplementedStepRunnerServer ¶
type UnimplementedStepRunnerServer struct { }
UnimplementedStepRunnerServer must be embedded to have forward compatible implementations.
func (UnimplementedStepRunnerServer) Close ¶
func (UnimplementedStepRunnerServer) Close(context.Context, *CloseRequest) (*CloseResponse, error)
func (UnimplementedStepRunnerServer) FollowLogs ¶
func (UnimplementedStepRunnerServer) FollowLogs(*FollowLogsRequest, StepRunner_FollowLogsServer) error
func (UnimplementedStepRunnerServer) Run ¶
func (UnimplementedStepRunnerServer) Run(context.Context, *RunRequest) (*RunResponse, error)
func (UnimplementedStepRunnerServer) Status ¶
func (UnimplementedStepRunnerServer) Status(context.Context, *StatusRequest) (*StatusResponse, error)
type UnsafeStepRunnerServer ¶
type UnsafeStepRunnerServer interface {
// contains filtered or unexported methods
}
UnsafeStepRunnerServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to StepRunnerServer will result in compilation errors.
type ValueType ¶
type ValueType int32
ValueType is an enumerations of the possible types a value can have.
func (ValueType) Descriptor ¶
func (ValueType) Descriptor() protoreflect.EnumDescriptor
func (ValueType) EnumDescriptor
deprecated
func (ValueType) Number ¶
func (x ValueType) Number() protoreflect.EnumNumber
func (ValueType) Type ¶
func (ValueType) Type() protoreflect.EnumType
type Variable ¶
type Variable struct { Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"` Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"` File bool `protobuf:"varint,3,opt,name=file,proto3" json:"file,omitempty"` Masked bool `protobuf:"varint,4,opt,name=masked,proto3" json:"masked,omitempty"` // contains filtered or unexported fields }
func (*Variable) Descriptor
deprecated
func (*Variable) ProtoMessage ¶
func (*Variable) ProtoMessage()
func (*Variable) ProtoReflect ¶
func (x *Variable) ProtoReflect() protoreflect.Message