protocolv1

package
v1.1.0 Latest Latest
Warning

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

Go to latest
Published: Sep 23, 2025 License: MPL-2.0 Imports: 8 Imported by: 5

Documentation

Index

Constants

View Source
const (
	PluginService_ExecuteActions_FullMethodName = "/protocol.v1.PluginService/ExecuteActions"
	PluginService_ExecuteFilters_FullMethodName = "/protocol.v1.PluginService/ExecuteFilters"
	PluginService_GetPlugin_FullMethodName      = "/protocol.v1.PluginService/GetPlugin"
	PluginService_OnPrClosed_FullMethodName     = "/protocol.v1.PluginService/OnPrClosed"
	PluginService_OnPrCreated_FullMethodName    = "/protocol.v1.PluginService/OnPrCreated"
	PluginService_OnPrMerged_FullMethodName     = "/protocol.v1.PluginService/OnPrMerged"
	PluginService_Shutdown_FullMethodName       = "/protocol.v1.PluginService/Shutdown"
)

Variables

View Source
var File_protocol_saturn_proto protoreflect.FileDescriptor
View Source
var PluginService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "protocol.v1.PluginService",
	HandlerType: (*PluginServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ExecuteActions",
			Handler:    _PluginService_ExecuteActions_Handler,
		},
		{
			MethodName: "ExecuteFilters",
			Handler:    _PluginService_ExecuteFilters_Handler,
		},
		{
			MethodName: "GetPlugin",
			Handler:    _PluginService_GetPlugin_Handler,
		},
		{
			MethodName: "OnPrClosed",
			Handler:    _PluginService_OnPrClosed_Handler,
		},
		{
			MethodName: "OnPrCreated",
			Handler:    _PluginService_OnPrCreated_Handler,
		},
		{
			MethodName: "OnPrMerged",
			Handler:    _PluginService_OnPrMerged_Handler,
		},
		{
			MethodName: "Shutdown",
			Handler:    _PluginService_Shutdown_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "protocol/saturn.proto",
}

PluginService_ServiceDesc is the grpc.ServiceDesc for PluginService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterPluginServiceServer

func RegisterPluginServiceServer(s grpc.ServiceRegistrar, srv PluginServiceServer)

Types

type Context

type Context struct {
	Repository  *Repository  `protobuf:"bytes,1,opt,name=repository,proto3" json:"repository,omitempty"`                            // Details on the repository to filter or apply actions to.
	PullRequest *PullRequest `protobuf:"bytes,2,opt,name=pull_request,json=pullRequest,proto3,oneof" json:"pull_request,omitempty"` // Details on the pull request. Set only if a pull request exists.
	// Run data contains dynamic, arbitrary data of the run.
	RunData map[string]string `` /* 170-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*Context) Descriptor deprecated

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

Deprecated: Use Context.ProtoReflect.Descriptor instead.

func (*Context) GetPullRequest

func (x *Context) GetPullRequest() *PullRequest

func (*Context) GetRepository

func (x *Context) GetRepository() *Repository

func (*Context) GetRunData

func (x *Context) GetRunData() map[string]string

func (*Context) ProtoMessage

func (*Context) ProtoMessage()

func (*Context) ProtoReflect

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

func (*Context) Reset

func (x *Context) Reset()

func (*Context) String

func (x *Context) String() string

type ExecuteActionsRequest

type ExecuteActionsRequest struct {
	Path    string   `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	Context *Context `protobuf:"bytes,2,opt,name=context,proto3" json:"context,omitempty"`
	// contains filtered or unexported fields
}

func (*ExecuteActionsRequest) Descriptor deprecated

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

Deprecated: Use ExecuteActionsRequest.ProtoReflect.Descriptor instead.

func (*ExecuteActionsRequest) GetContext

func (x *ExecuteActionsRequest) GetContext() *Context

func (*ExecuteActionsRequest) GetPath

func (x *ExecuteActionsRequest) GetPath() string

func (*ExecuteActionsRequest) ProtoMessage

func (*ExecuteActionsRequest) ProtoMessage()

func (*ExecuteActionsRequest) ProtoReflect

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

func (*ExecuteActionsRequest) Reset

func (x *ExecuteActionsRequest) Reset()

func (*ExecuteActionsRequest) String

func (x *ExecuteActionsRequest) String() string

type ExecuteActionsResponse

type ExecuteActionsResponse struct {
	Error *string `protobuf:"bytes,1,opt,name=error,proto3,oneof" json:"error,omitempty"`
	// Run data contains dynamic, arbitrary data of the run.
	// The plugin can add its own data here.
	// The data is then passed on to other plugins by Saturn and used in templating.
	RunData map[string]string `` /* 170-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*ExecuteActionsResponse) Descriptor deprecated

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

Deprecated: Use ExecuteActionsResponse.ProtoReflect.Descriptor instead.

func (*ExecuteActionsResponse) GetError

func (x *ExecuteActionsResponse) GetError() string

func (*ExecuteActionsResponse) GetRunData

func (x *ExecuteActionsResponse) GetRunData() map[string]string

func (*ExecuteActionsResponse) ProtoMessage

func (*ExecuteActionsResponse) ProtoMessage()

func (*ExecuteActionsResponse) ProtoReflect

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

func (*ExecuteActionsResponse) Reset

func (x *ExecuteActionsResponse) Reset()

func (*ExecuteActionsResponse) String

func (x *ExecuteActionsResponse) String() string

type ExecuteFiltersRequest

type ExecuteFiltersRequest struct {
	Context *Context `protobuf:"bytes,1,opt,name=context,proto3" json:"context,omitempty"`
	// contains filtered or unexported fields
}

func (*ExecuteFiltersRequest) Descriptor deprecated

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

Deprecated: Use ExecuteFiltersRequest.ProtoReflect.Descriptor instead.

func (*ExecuteFiltersRequest) GetContext

func (x *ExecuteFiltersRequest) GetContext() *Context

func (*ExecuteFiltersRequest) ProtoMessage

func (*ExecuteFiltersRequest) ProtoMessage()

func (*ExecuteFiltersRequest) ProtoReflect

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

func (*ExecuteFiltersRequest) Reset

func (x *ExecuteFiltersRequest) Reset()

func (*ExecuteFiltersRequest) String

func (x *ExecuteFiltersRequest) String() string

type ExecuteFiltersResponse

type ExecuteFiltersResponse struct {
	Match bool    `protobuf:"varint,1,opt,name=match,proto3" json:"match,omitempty"`
	Error *string `protobuf:"bytes,2,opt,name=error,proto3,oneof" json:"error,omitempty"`
	// Run data contains dynamic, arbitrary data of the run.
	// The plugin can add its own data here.
	// The data is then passed on to other plugins by Saturn and used in templating.
	RunData map[string]string `` /* 170-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*ExecuteFiltersResponse) Descriptor deprecated

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

Deprecated: Use ExecuteFiltersResponse.ProtoReflect.Descriptor instead.

func (*ExecuteFiltersResponse) GetError

func (x *ExecuteFiltersResponse) GetError() string

func (*ExecuteFiltersResponse) GetMatch

func (x *ExecuteFiltersResponse) GetMatch() bool

func (*ExecuteFiltersResponse) GetRunData

func (x *ExecuteFiltersResponse) GetRunData() map[string]string

func (*ExecuteFiltersResponse) ProtoMessage

func (*ExecuteFiltersResponse) ProtoMessage()

func (*ExecuteFiltersResponse) ProtoReflect

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

func (*ExecuteFiltersResponse) Reset

func (x *ExecuteFiltersResponse) Reset()

func (*ExecuteFiltersResponse) String

func (x *ExecuteFiltersResponse) String() string

type GetPluginRequest

type GetPluginRequest struct {
	Config map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*GetPluginRequest) Descriptor deprecated

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

Deprecated: Use GetPluginRequest.ProtoReflect.Descriptor instead.

func (*GetPluginRequest) GetConfig

func (x *GetPluginRequest) GetConfig() map[string]string

func (*GetPluginRequest) ProtoMessage

func (*GetPluginRequest) ProtoMessage()

func (*GetPluginRequest) ProtoReflect

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

func (*GetPluginRequest) Reset

func (x *GetPluginRequest) Reset()

func (*GetPluginRequest) String

func (x *GetPluginRequest) String() string

type GetPluginResponse

type GetPluginResponse struct {
	Name     string  `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Priority int32   `protobuf:"varint,2,opt,name=priority,proto3" json:"priority,omitempty"`
	Error    *string `protobuf:"bytes,3,opt,name=error,proto3,oneof" json:"error,omitempty"`
	// contains filtered or unexported fields
}

func (*GetPluginResponse) Descriptor deprecated

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

Deprecated: Use GetPluginResponse.ProtoReflect.Descriptor instead.

func (*GetPluginResponse) GetError

func (x *GetPluginResponse) GetError() string

func (*GetPluginResponse) GetName

func (x *GetPluginResponse) GetName() string

func (*GetPluginResponse) GetPriority

func (x *GetPluginResponse) GetPriority() int32

func (*GetPluginResponse) ProtoMessage

func (*GetPluginResponse) ProtoMessage()

func (*GetPluginResponse) ProtoReflect

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

func (*GetPluginResponse) Reset

func (x *GetPluginResponse) Reset()

func (*GetPluginResponse) String

func (x *GetPluginResponse) String() string

type OnPrClosedRequest

type OnPrClosedRequest struct {
	Context *Context `protobuf:"bytes,1,opt,name=context,proto3" json:"context,omitempty"`
	// contains filtered or unexported fields
}

func (*OnPrClosedRequest) Descriptor deprecated

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

Deprecated: Use OnPrClosedRequest.ProtoReflect.Descriptor instead.

func (*OnPrClosedRequest) GetContext

func (x *OnPrClosedRequest) GetContext() *Context

func (*OnPrClosedRequest) ProtoMessage

func (*OnPrClosedRequest) ProtoMessage()

func (*OnPrClosedRequest) ProtoReflect

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

func (*OnPrClosedRequest) Reset

func (x *OnPrClosedRequest) Reset()

func (*OnPrClosedRequest) String

func (x *OnPrClosedRequest) String() string

type OnPrClosedResponse

type OnPrClosedResponse struct {
	Error *string `protobuf:"bytes,1,opt,name=error,proto3,oneof" json:"error,omitempty"`
	// contains filtered or unexported fields
}

func (*OnPrClosedResponse) Descriptor deprecated

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

Deprecated: Use OnPrClosedResponse.ProtoReflect.Descriptor instead.

func (*OnPrClosedResponse) GetError

func (x *OnPrClosedResponse) GetError() string

func (*OnPrClosedResponse) ProtoMessage

func (*OnPrClosedResponse) ProtoMessage()

func (*OnPrClosedResponse) ProtoReflect

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

func (*OnPrClosedResponse) Reset

func (x *OnPrClosedResponse) Reset()

func (*OnPrClosedResponse) String

func (x *OnPrClosedResponse) String() string

type OnPrCreatedRequest

type OnPrCreatedRequest struct {
	Context *Context `protobuf:"bytes,1,opt,name=context,proto3" json:"context,omitempty"`
	// contains filtered or unexported fields
}

func (*OnPrCreatedRequest) Descriptor deprecated

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

Deprecated: Use OnPrCreatedRequest.ProtoReflect.Descriptor instead.

func (*OnPrCreatedRequest) GetContext

func (x *OnPrCreatedRequest) GetContext() *Context

func (*OnPrCreatedRequest) ProtoMessage

func (*OnPrCreatedRequest) ProtoMessage()

func (*OnPrCreatedRequest) ProtoReflect

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

func (*OnPrCreatedRequest) Reset

func (x *OnPrCreatedRequest) Reset()

func (*OnPrCreatedRequest) String

func (x *OnPrCreatedRequest) String() string

type OnPrCreatedResponse

type OnPrCreatedResponse struct {
	Error *string `protobuf:"bytes,1,opt,name=error,proto3,oneof" json:"error,omitempty"`
	// contains filtered or unexported fields
}

func (*OnPrCreatedResponse) Descriptor deprecated

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

Deprecated: Use OnPrCreatedResponse.ProtoReflect.Descriptor instead.

func (*OnPrCreatedResponse) GetError

func (x *OnPrCreatedResponse) GetError() string

func (*OnPrCreatedResponse) ProtoMessage

func (*OnPrCreatedResponse) ProtoMessage()

func (*OnPrCreatedResponse) ProtoReflect

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

func (*OnPrCreatedResponse) Reset

func (x *OnPrCreatedResponse) Reset()

func (*OnPrCreatedResponse) String

func (x *OnPrCreatedResponse) String() string

type OnPrMergedRequest

type OnPrMergedRequest struct {
	Context *Context `protobuf:"bytes,1,opt,name=context,proto3" json:"context,omitempty"`
	// contains filtered or unexported fields
}

func (*OnPrMergedRequest) Descriptor deprecated

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

Deprecated: Use OnPrMergedRequest.ProtoReflect.Descriptor instead.

func (*OnPrMergedRequest) GetContext

func (x *OnPrMergedRequest) GetContext() *Context

func (*OnPrMergedRequest) ProtoMessage

func (*OnPrMergedRequest) ProtoMessage()

func (*OnPrMergedRequest) ProtoReflect

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

func (*OnPrMergedRequest) Reset

func (x *OnPrMergedRequest) Reset()

func (*OnPrMergedRequest) String

func (x *OnPrMergedRequest) String() string

type OnPrMergedResponse

type OnPrMergedResponse struct {
	Error *string `protobuf:"bytes,1,opt,name=error,proto3,oneof" json:"error,omitempty"`
	// contains filtered or unexported fields
}

func (*OnPrMergedResponse) Descriptor deprecated

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

Deprecated: Use OnPrMergedResponse.ProtoReflect.Descriptor instead.

func (*OnPrMergedResponse) GetError

func (x *OnPrMergedResponse) GetError() string

func (*OnPrMergedResponse) ProtoMessage

func (*OnPrMergedResponse) ProtoMessage()

func (*OnPrMergedResponse) ProtoReflect

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

func (*OnPrMergedResponse) Reset

func (x *OnPrMergedResponse) Reset()

func (*OnPrMergedResponse) String

func (x *OnPrMergedResponse) String() string

type PluginServiceClient

type PluginServiceClient interface {
	ExecuteActions(ctx context.Context, in *ExecuteActionsRequest, opts ...grpc.CallOption) (*ExecuteActionsResponse, error)
	ExecuteFilters(ctx context.Context, in *ExecuteFiltersRequest, opts ...grpc.CallOption) (*ExecuteFiltersResponse, error)
	GetPlugin(ctx context.Context, in *GetPluginRequest, opts ...grpc.CallOption) (*GetPluginResponse, error)
	OnPrClosed(ctx context.Context, in *OnPrClosedRequest, opts ...grpc.CallOption) (*OnPrClosedResponse, error)
	OnPrCreated(ctx context.Context, in *OnPrCreatedRequest, opts ...grpc.CallOption) (*OnPrCreatedResponse, error)
	OnPrMerged(ctx context.Context, in *OnPrMergedRequest, opts ...grpc.CallOption) (*OnPrMergedResponse, error)
	Shutdown(ctx context.Context, in *ShutdownRequest, opts ...grpc.CallOption) (*ShutdownResponse, error)
}

PluginServiceClient is the client API for PluginService 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.

type PluginServiceServer

PluginServiceServer is the server API for PluginService service. All implementations must embed UnimplementedPluginServiceServer for forward compatibility

type PullRequest

type PullRequest struct {
	Number int64  `protobuf:"varint,1,opt,name=number,proto3" json:"number,omitempty"`              // Identifier of the pull request.
	WebUrl string `protobuf:"bytes,2,opt,name=web_url,json=webUrl,proto3" json:"web_url,omitempty"` // URL to view the pull request in a browser.
	// contains filtered or unexported fields
}

func (*PullRequest) Descriptor deprecated

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

Deprecated: Use PullRequest.ProtoReflect.Descriptor instead.

func (*PullRequest) GetNumber

func (x *PullRequest) GetNumber() int64

func (*PullRequest) GetWebUrl

func (x *PullRequest) GetWebUrl() string

func (*PullRequest) ProtoMessage

func (*PullRequest) ProtoMessage()

func (*PullRequest) ProtoReflect

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

func (*PullRequest) Reset

func (x *PullRequest) Reset()

func (*PullRequest) String

func (x *PullRequest) String() string

type Repository

type Repository struct {
	FullName     string `protobuf:"bytes,1,opt,name=full_name,json=fullName,proto3" json:"full_name,omitempty"`
	CloneUrlHttp string `protobuf:"bytes,2,opt,name=clone_url_http,json=cloneUrlHttp,proto3" json:"clone_url_http,omitempty"`
	CloneUrlSsh  string `protobuf:"bytes,3,opt,name=clone_url_ssh,json=cloneUrlSsh,proto3" json:"clone_url_ssh,omitempty"`
	WebUrl       string `protobuf:"bytes,4,opt,name=web_url,json=webUrl,proto3" json:"web_url,omitempty"`
	// contains filtered or unexported fields
}

func (*Repository) Descriptor deprecated

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

Deprecated: Use Repository.ProtoReflect.Descriptor instead.

func (*Repository) GetCloneUrlHttp

func (x *Repository) GetCloneUrlHttp() string

func (*Repository) GetCloneUrlSsh

func (x *Repository) GetCloneUrlSsh() string

func (*Repository) GetFullName

func (x *Repository) GetFullName() string

func (*Repository) GetWebUrl

func (x *Repository) GetWebUrl() string

func (*Repository) ProtoMessage

func (*Repository) ProtoMessage()

func (*Repository) ProtoReflect

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

func (*Repository) Reset

func (x *Repository) Reset()

func (*Repository) String

func (x *Repository) String() string

type ShutdownRequest

type ShutdownRequest struct {
	// contains filtered or unexported fields
}

func (*ShutdownRequest) Descriptor deprecated

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

Deprecated: Use ShutdownRequest.ProtoReflect.Descriptor instead.

func (*ShutdownRequest) ProtoMessage

func (*ShutdownRequest) ProtoMessage()

func (*ShutdownRequest) ProtoReflect

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

func (*ShutdownRequest) Reset

func (x *ShutdownRequest) Reset()

func (*ShutdownRequest) String

func (x *ShutdownRequest) String() string

type ShutdownResponse

type ShutdownResponse struct {
	// contains filtered or unexported fields
}

func (*ShutdownResponse) Descriptor deprecated

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

Deprecated: Use ShutdownResponse.ProtoReflect.Descriptor instead.

func (*ShutdownResponse) ProtoMessage

func (*ShutdownResponse) ProtoMessage()

func (*ShutdownResponse) ProtoReflect

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

func (*ShutdownResponse) Reset

func (x *ShutdownResponse) Reset()

func (*ShutdownResponse) String

func (x *ShutdownResponse) String() string

type UnimplementedPluginServiceServer

type UnimplementedPluginServiceServer struct {
}

UnimplementedPluginServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedPluginServiceServer) ExecuteActions

func (UnimplementedPluginServiceServer) ExecuteFilters

func (UnimplementedPluginServiceServer) GetPlugin

func (UnimplementedPluginServiceServer) OnPrClosed

func (UnimplementedPluginServiceServer) OnPrCreated

func (UnimplementedPluginServiceServer) OnPrMerged

func (UnimplementedPluginServiceServer) Shutdown

type UnsafePluginServiceServer

type UnsafePluginServiceServer interface {
	// contains filtered or unexported methods
}

UnsafePluginServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to PluginServiceServer will result in compilation errors.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL