triggers

package
v0.0.39 Latest Latest
Warning

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

Go to latest
Published: Jan 7, 2026 License: Apache-2.0 Imports: 20 Imported by: 0

Documentation

Overview

Package triggers is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source
const (
	Triggers_ListTriggers_FullMethodName    = "/Superplane.Triggers.Triggers/ListTriggers"
	Triggers_DescribeTrigger_FullMethodName = "/Superplane.Triggers.Triggers/DescribeTrigger"
)

Variables

View Source
var File_triggers_proto protoreflect.FileDescriptor
View Source
var Triggers_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "Superplane.Triggers.Triggers",
	HandlerType: (*TriggersServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ListTriggers",
			Handler:    _Triggers_ListTriggers_Handler,
		},
		{
			MethodName: "DescribeTrigger",
			Handler:    _Triggers_DescribeTrigger_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "triggers.proto",
}

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

Functions

func RegisterTriggersHandler

func RegisterTriggersHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterTriggersHandler registers the http handlers for service Triggers to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterTriggersHandlerClient

func RegisterTriggersHandlerClient(ctx context.Context, mux *runtime.ServeMux, client TriggersClient) error

RegisterTriggersHandlerClient registers the http handlers for service Triggers to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "TriggersClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "TriggersClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "TriggersClient" to call the correct interceptors. This client ignores the HTTP middlewares.

func RegisterTriggersHandlerFromEndpoint

func RegisterTriggersHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterTriggersHandlerFromEndpoint is same as RegisterTriggersHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterTriggersHandlerServer

func RegisterTriggersHandlerServer(ctx context.Context, mux *runtime.ServeMux, server TriggersServer) error

RegisterTriggersHandlerServer registers the http handlers for service Triggers to "mux". UnaryRPC :call TriggersServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterTriggersHandlerFromEndpoint instead. GRPC interceptors will not work for this type of registration. To use interceptors, you must use the "runtime.WithMiddlewares" option in the "runtime.NewServeMux" call.

func RegisterTriggersServer

func RegisterTriggersServer(s grpc.ServiceRegistrar, srv TriggersServer)

Types

type DescribeTriggerRequest

type DescribeTriggerRequest struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*DescribeTriggerRequest) Descriptor deprecated

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

Deprecated: Use DescribeTriggerRequest.ProtoReflect.Descriptor instead.

func (*DescribeTriggerRequest) GetName

func (x *DescribeTriggerRequest) GetName() string

func (*DescribeTriggerRequest) ProtoMessage

func (*DescribeTriggerRequest) ProtoMessage()

func (*DescribeTriggerRequest) ProtoReflect

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

func (*DescribeTriggerRequest) Reset

func (x *DescribeTriggerRequest) Reset()

func (*DescribeTriggerRequest) String

func (x *DescribeTriggerRequest) String() string

type DescribeTriggerResponse

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

func (*DescribeTriggerResponse) Descriptor deprecated

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

Deprecated: Use DescribeTriggerResponse.ProtoReflect.Descriptor instead.

func (*DescribeTriggerResponse) GetTrigger

func (x *DescribeTriggerResponse) GetTrigger() *Trigger

func (*DescribeTriggerResponse) ProtoMessage

func (*DescribeTriggerResponse) ProtoMessage()

func (*DescribeTriggerResponse) ProtoReflect

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

func (*DescribeTriggerResponse) Reset

func (x *DescribeTriggerResponse) Reset()

func (*DescribeTriggerResponse) String

func (x *DescribeTriggerResponse) String() string

type ListTriggersRequest

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

func (*ListTriggersRequest) Descriptor deprecated

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

Deprecated: Use ListTriggersRequest.ProtoReflect.Descriptor instead.

func (*ListTriggersRequest) ProtoMessage

func (*ListTriggersRequest) ProtoMessage()

func (*ListTriggersRequest) ProtoReflect

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

func (*ListTriggersRequest) Reset

func (x *ListTriggersRequest) Reset()

func (*ListTriggersRequest) String

func (x *ListTriggersRequest) String() string

type ListTriggersResponse

type ListTriggersResponse struct {
	Triggers []*Trigger `protobuf:"bytes,1,rep,name=triggers,proto3" json:"triggers,omitempty"`
	// contains filtered or unexported fields
}

func (*ListTriggersResponse) Descriptor deprecated

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

Deprecated: Use ListTriggersResponse.ProtoReflect.Descriptor instead.

func (*ListTriggersResponse) GetTriggers

func (x *ListTriggersResponse) GetTriggers() []*Trigger

func (*ListTriggersResponse) ProtoMessage

func (*ListTriggersResponse) ProtoMessage()

func (*ListTriggersResponse) ProtoReflect

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

func (*ListTriggersResponse) Reset

func (x *ListTriggersResponse) Reset()

func (*ListTriggersResponse) String

func (x *ListTriggersResponse) String() string

type Trigger

type Trigger struct {
	Name          string                 `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Label         string                 `protobuf:"bytes,2,opt,name=label,proto3" json:"label,omitempty"`
	Description   string                 `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	Icon          string                 `protobuf:"bytes,4,opt,name=icon,proto3" json:"icon,omitempty"`
	Color         string                 `protobuf:"bytes,5,opt,name=color,proto3" json:"color,omitempty"`
	Configuration []*configuration.Field `protobuf:"bytes,6,rep,name=configuration,proto3" json:"configuration,omitempty"`
	// contains filtered or unexported fields
}

func (*Trigger) Descriptor deprecated

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

Deprecated: Use Trigger.ProtoReflect.Descriptor instead.

func (*Trigger) GetColor

func (x *Trigger) GetColor() string

func (*Trigger) GetConfiguration

func (x *Trigger) GetConfiguration() []*configuration.Field

func (*Trigger) GetDescription

func (x *Trigger) GetDescription() string

func (*Trigger) GetIcon

func (x *Trigger) GetIcon() string

func (*Trigger) GetLabel

func (x *Trigger) GetLabel() string

func (*Trigger) GetName

func (x *Trigger) GetName() string

func (*Trigger) ProtoMessage

func (*Trigger) ProtoMessage()

func (*Trigger) ProtoReflect

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

func (*Trigger) Reset

func (x *Trigger) Reset()

func (*Trigger) String

func (x *Trigger) String() string

type TriggersClient

type TriggersClient interface {
	ListTriggers(ctx context.Context, in *ListTriggersRequest, opts ...grpc.CallOption) (*ListTriggersResponse, error)
	DescribeTrigger(ctx context.Context, in *DescribeTriggerRequest, opts ...grpc.CallOption) (*DescribeTriggerResponse, error)
}

TriggersClient is the client API for Triggers 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 NewTriggersClient

func NewTriggersClient(cc grpc.ClientConnInterface) TriggersClient

type TriggersServer

type TriggersServer interface {
	ListTriggers(context.Context, *ListTriggersRequest) (*ListTriggersResponse, error)
	DescribeTrigger(context.Context, *DescribeTriggerRequest) (*DescribeTriggerResponse, error)
}

TriggersServer is the server API for Triggers service. All implementations should embed UnimplementedTriggersServer for forward compatibility.

type UnimplementedTriggersServer

type UnimplementedTriggersServer struct{}

UnimplementedTriggersServer should be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedTriggersServer) DescribeTrigger

func (UnimplementedTriggersServer) ListTriggers

type UnsafeTriggersServer

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

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

Jump to

Keyboard shortcuts

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