Documentation
¶
Index ¶
- Constants
- Variables
- func RegisterActionsServer(s grpc.ServiceRegistrar, srv ActionsServer)
- type ActionsClient
- type ActionsServer
- type RunRequest
- func (*RunRequest) Descriptor() ([]byte, []int)deprecated
- func (x *RunRequest) GetState() *structpb.Struct
- func (x *RunRequest) GetStep() *Step
- func (x *RunRequest) GetWith() *structpb.Struct
- func (*RunRequest) ProtoMessage()
- func (x *RunRequest) ProtoReflect() protoreflect.Message
- func (x *RunRequest) Reset()
- func (x *RunRequest) String() string
- type RunResponse
- func (*RunResponse) Descriptor() ([]byte, []int)deprecated
- func (x *RunResponse) GetResult() *structpb.Struct
- func (x *RunResponse) GetState() *structpb.Struct
- func (*RunResponse) ProtoMessage()
- func (x *RunResponse) ProtoReflect() protoreflect.Message
- func (x *RunResponse) Reset()
- func (x *RunResponse) String() string
- type Step
- func (*Step) Descriptor() ([]byte, []int)deprecated
- func (x *Step) GetAttempt() int64
- func (x *Step) GetId() string
- func (x *Step) GetIndex() int64
- func (x *Step) GetJobId() string
- func (x *Step) GetJobName() string
- func (x *Step) GetName() string
- func (x *Step) GetRepeat() int64
- func (x *Step) GetRunId() string
- func (*Step) ProtoMessage()
- func (x *Step) ProtoReflect() protoreflect.Message
- func (x *Step) Reset()
- func (x *Step) String() string
- type UnimplementedActionsServer
- type UnsafeActionsServer
Constants ¶
const (
Actions_Run_FullMethodName = "/pb.Actions/Run"
)
Variables ¶
var Actions_ServiceDesc = grpc.ServiceDesc{ ServiceName: "pb.Actions", HandlerType: (*ActionsServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "Run", Handler: _Actions_Run_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "pb/actions.proto", }
Actions_ServiceDesc is the grpc.ServiceDesc for Actions service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var File_pb_actions_proto protoreflect.FileDescriptor
Functions ¶
func RegisterActionsServer ¶
func RegisterActionsServer(s grpc.ServiceRegistrar, srv ActionsServer)
Types ¶
type ActionsClient ¶
type ActionsClient interface {
Run(ctx context.Context, in *RunRequest, opts ...grpc.CallOption) (*RunResponse, error)
}
ActionsClient is the client API for Actions 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 NewActionsClient ¶
func NewActionsClient(cc grpc.ClientConnInterface) ActionsClient
type ActionsServer ¶
type ActionsServer interface {
Run(context.Context, *RunRequest) (*RunResponse, error)
}
ActionsServer is the server API for Actions service. All implementations should embed UnimplementedActionsServer for forward compatibility
type RunRequest ¶
type RunRequest struct {
With *structpb.Struct `protobuf:"bytes,2,opt,name=with,proto3" json:"with,omitempty"`
// The state the action left in the job before, for a stateful action.
State *structpb.Struct `protobuf:"bytes,3,opt,name=state,proto3" json:"state,omitempty"`
// The step the action runs for.
Step *Step `protobuf:"bytes,4,opt,name=step,proto3" json:"step,omitempty"`
// contains filtered or unexported fields
}
func (*RunRequest) Descriptor
deprecated
func (*RunRequest) Descriptor() ([]byte, []int)
Deprecated: Use RunRequest.ProtoReflect.Descriptor instead.
func (*RunRequest) GetState ¶ added in v1.19.0
func (x *RunRequest) GetState() *structpb.Struct
func (*RunRequest) GetStep ¶ added in v1.19.0
func (x *RunRequest) GetStep() *Step
func (*RunRequest) GetWith ¶
func (x *RunRequest) GetWith() *structpb.Struct
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 {
Result *structpb.Struct `protobuf:"bytes,1,opt,name=result,proto3" json:"result,omitempty"`
// The state the action leaves in the job, or none to keep it as it was.
State *structpb.Struct `protobuf:"bytes,3,opt,name=state,proto3" json:"state,omitempty"`
// contains filtered or unexported fields
}
func (*RunResponse) Descriptor
deprecated
func (*RunResponse) Descriptor() ([]byte, []int)
Deprecated: Use RunResponse.ProtoReflect.Descriptor instead.
func (*RunResponse) GetResult ¶
func (x *RunResponse) GetResult() *structpb.Struct
func (*RunResponse) GetState ¶ added in v1.19.0
func (x *RunResponse) GetState() *structpb.Struct
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 Step ¶ added in v1.19.0
type Step struct {
// The run of probe, the same for every step of every job in it.
RunId string `protobuf:"bytes,1,opt,name=run_id,json=runId,proto3" json:"run_id,omitempty"`
JobId string `protobuf:"bytes,2,opt,name=job_id,json=jobId,proto3" json:"job_id,omitempty"`
JobName string `protobuf:"bytes,3,opt,name=job_name,json=jobName,proto3" json:"job_name,omitempty"`
// The position of the step in the job, from 0.
Index int64 `protobuf:"varint,4,opt,name=index,proto3" json:"index,omitempty"`
// The id the step is given, or empty.
Id string `protobuf:"bytes,5,opt,name=id,proto3" json:"id,omitempty"`
Name string `protobuf:"bytes,6,opt,name=name,proto3" json:"name,omitempty"`
// Which run of a repeated job, from 0.
Repeat int64 `protobuf:"varint,7,opt,name=repeat,proto3" json:"repeat,omitempty"`
// Which attempt of a retried step, from 1.
Attempt int64 `protobuf:"varint,8,opt,name=attempt,proto3" json:"attempt,omitempty"`
// contains filtered or unexported fields
}
Step tells an action about the step it runs for, for it to use as it sees fit, such as to say where a request comes from.
func (*Step) Descriptor
deprecated
added in
v1.19.0
func (*Step) GetAttempt ¶ added in v1.19.0
func (*Step) GetJobName ¶ added in v1.19.0
func (*Step) ProtoMessage ¶ added in v1.19.0
func (*Step) ProtoMessage()
func (*Step) ProtoReflect ¶ added in v1.19.0
func (x *Step) ProtoReflect() protoreflect.Message
type UnimplementedActionsServer ¶
type UnimplementedActionsServer struct {
}
UnimplementedActionsServer should be embedded to have forward compatible implementations.
func (UnimplementedActionsServer) Run ¶
func (UnimplementedActionsServer) Run(context.Context, *RunRequest) (*RunResponse, error)
type UnsafeActionsServer ¶
type UnsafeActionsServer interface {
// contains filtered or unexported methods
}
UnsafeActionsServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ActionsServer will result in compilation errors.