Documentation
¶
Overview ¶
Package integrations is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Constants
- Variables
- func RegisterIntegrationsHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterIntegrationsHandlerClient(ctx context.Context, mux *runtime.ServeMux, client IntegrationsClient) error
- func RegisterIntegrationsHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterIntegrationsHandlerServer(ctx context.Context, mux *runtime.ServeMux, server IntegrationsServer) error
- func RegisterIntegrationsServer(s grpc.ServiceRegistrar, srv IntegrationsServer)
- type IntegrationDefinition
- func (*IntegrationDefinition) Descriptor() ([]byte, []int)deprecated
- func (x *IntegrationDefinition) GetComponents() []*components.Component
- func (x *IntegrationDefinition) GetConfiguration() []*configuration.Field
- func (x *IntegrationDefinition) GetDescription() string
- func (x *IntegrationDefinition) GetIcon() string
- func (x *IntegrationDefinition) GetInstructions() string
- func (x *IntegrationDefinition) GetLabel() string
- func (x *IntegrationDefinition) GetName() string
- func (x *IntegrationDefinition) GetTriggers() []*triggers.Trigger
- func (*IntegrationDefinition) ProtoMessage()
- func (x *IntegrationDefinition) ProtoReflect() protoreflect.Message
- func (x *IntegrationDefinition) Reset()
- func (x *IntegrationDefinition) String() string
- type IntegrationsClient
- type IntegrationsServer
- type ListIntegrationsRequest
- type ListIntegrationsResponse
- func (*ListIntegrationsResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ListIntegrationsResponse) GetIntegrations() []*IntegrationDefinition
- func (*ListIntegrationsResponse) ProtoMessage()
- func (x *ListIntegrationsResponse) ProtoReflect() protoreflect.Message
- func (x *ListIntegrationsResponse) Reset()
- func (x *ListIntegrationsResponse) String() string
- type UnimplementedIntegrationsServer
- type UnsafeIntegrationsServer
Constants ¶
const (
Integrations_ListIntegrations_FullMethodName = "/Superplane.Integrations.Integrations/ListIntegrations"
)
Variables ¶
var File_integrations_proto protoreflect.FileDescriptor
var Integrations_ServiceDesc = grpc.ServiceDesc{ ServiceName: "Superplane.Integrations.Integrations", HandlerType: (*IntegrationsServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "ListIntegrations", Handler: _Integrations_ListIntegrations_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "integrations.proto", }
Integrations_ServiceDesc is the grpc.ServiceDesc for Integrations service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterIntegrationsHandler ¶
func RegisterIntegrationsHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterIntegrationsHandler registers the http handlers for service Integrations to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterIntegrationsHandlerClient ¶
func RegisterIntegrationsHandlerClient(ctx context.Context, mux *runtime.ServeMux, client IntegrationsClient) error
RegisterIntegrationsHandlerClient registers the http handlers for service Integrations to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "IntegrationsClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "IntegrationsClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "IntegrationsClient" to call the correct interceptors. This client ignores the HTTP middlewares.
func RegisterIntegrationsHandlerFromEndpoint ¶
func RegisterIntegrationsHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterIntegrationsHandlerFromEndpoint is same as RegisterIntegrationsHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterIntegrationsHandlerServer ¶
func RegisterIntegrationsHandlerServer(ctx context.Context, mux *runtime.ServeMux, server IntegrationsServer) error
RegisterIntegrationsHandlerServer registers the http handlers for service Integrations to "mux". UnaryRPC :call IntegrationsServer 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 RegisterIntegrationsHandlerFromEndpoint 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 RegisterIntegrationsServer ¶
func RegisterIntegrationsServer(s grpc.ServiceRegistrar, srv IntegrationsServer)
Types ¶
type IntegrationDefinition ¶ added in v0.5.0
type IntegrationDefinition 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"`
Icon string `protobuf:"bytes,3,opt,name=icon,proto3" json:"icon,omitempty"`
Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
Configuration []*configuration.Field `protobuf:"bytes,5,rep,name=configuration,proto3" json:"configuration,omitempty"`
Components []*components.Component `protobuf:"bytes,6,rep,name=components,proto3" json:"components,omitempty"`
Triggers []*triggers.Trigger `protobuf:"bytes,7,rep,name=triggers,proto3" json:"triggers,omitempty"`
Instructions string `protobuf:"bytes,8,opt,name=instructions,proto3" json:"instructions,omitempty"`
// contains filtered or unexported fields
}
func (*IntegrationDefinition) Descriptor
deprecated
added in
v0.5.0
func (*IntegrationDefinition) Descriptor() ([]byte, []int)
Deprecated: Use IntegrationDefinition.ProtoReflect.Descriptor instead.
func (*IntegrationDefinition) GetComponents ¶ added in v0.5.0
func (x *IntegrationDefinition) GetComponents() []*components.Component
func (*IntegrationDefinition) GetConfiguration ¶ added in v0.5.0
func (x *IntegrationDefinition) GetConfiguration() []*configuration.Field
func (*IntegrationDefinition) GetDescription ¶ added in v0.5.0
func (x *IntegrationDefinition) GetDescription() string
func (*IntegrationDefinition) GetIcon ¶ added in v0.5.0
func (x *IntegrationDefinition) GetIcon() string
func (*IntegrationDefinition) GetInstructions ¶ added in v0.5.0
func (x *IntegrationDefinition) GetInstructions() string
func (*IntegrationDefinition) GetLabel ¶ added in v0.5.0
func (x *IntegrationDefinition) GetLabel() string
func (*IntegrationDefinition) GetName ¶ added in v0.5.0
func (x *IntegrationDefinition) GetName() string
func (*IntegrationDefinition) GetTriggers ¶ added in v0.5.0
func (x *IntegrationDefinition) GetTriggers() []*triggers.Trigger
func (*IntegrationDefinition) ProtoMessage ¶ added in v0.5.0
func (*IntegrationDefinition) ProtoMessage()
func (*IntegrationDefinition) ProtoReflect ¶ added in v0.5.0
func (x *IntegrationDefinition) ProtoReflect() protoreflect.Message
func (*IntegrationDefinition) Reset ¶ added in v0.5.0
func (x *IntegrationDefinition) Reset()
func (*IntegrationDefinition) String ¶ added in v0.5.0
func (x *IntegrationDefinition) String() string
type IntegrationsClient ¶
type IntegrationsClient interface {
ListIntegrations(ctx context.Context, in *ListIntegrationsRequest, opts ...grpc.CallOption) (*ListIntegrationsResponse, error)
}
IntegrationsClient is the client API for Integrations 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 NewIntegrationsClient ¶
func NewIntegrationsClient(cc grpc.ClientConnInterface) IntegrationsClient
type IntegrationsServer ¶
type IntegrationsServer interface {
ListIntegrations(context.Context, *ListIntegrationsRequest) (*ListIntegrationsResponse, error)
}
IntegrationsServer is the server API for Integrations service. All implementations should embed UnimplementedIntegrationsServer for forward compatibility.
type ListIntegrationsRequest ¶
type ListIntegrationsRequest struct {
// contains filtered or unexported fields
}
func (*ListIntegrationsRequest) Descriptor
deprecated
func (*ListIntegrationsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListIntegrationsRequest.ProtoReflect.Descriptor instead.
func (*ListIntegrationsRequest) ProtoMessage ¶
func (*ListIntegrationsRequest) ProtoMessage()
func (*ListIntegrationsRequest) ProtoReflect ¶
func (x *ListIntegrationsRequest) ProtoReflect() protoreflect.Message
func (*ListIntegrationsRequest) Reset ¶
func (x *ListIntegrationsRequest) Reset()
func (*ListIntegrationsRequest) String ¶
func (x *ListIntegrationsRequest) String() string
type ListIntegrationsResponse ¶
type ListIntegrationsResponse struct {
Integrations []*IntegrationDefinition `protobuf:"bytes,1,rep,name=integrations,proto3" json:"integrations,omitempty"`
// contains filtered or unexported fields
}
func (*ListIntegrationsResponse) Descriptor
deprecated
func (*ListIntegrationsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListIntegrationsResponse.ProtoReflect.Descriptor instead.
func (*ListIntegrationsResponse) GetIntegrations ¶
func (x *ListIntegrationsResponse) GetIntegrations() []*IntegrationDefinition
func (*ListIntegrationsResponse) ProtoMessage ¶
func (*ListIntegrationsResponse) ProtoMessage()
func (*ListIntegrationsResponse) ProtoReflect ¶
func (x *ListIntegrationsResponse) ProtoReflect() protoreflect.Message
func (*ListIntegrationsResponse) Reset ¶
func (x *ListIntegrationsResponse) Reset()
func (*ListIntegrationsResponse) String ¶
func (x *ListIntegrationsResponse) String() string
type UnimplementedIntegrationsServer ¶
type UnimplementedIntegrationsServer struct{}
UnimplementedIntegrationsServer 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 (UnimplementedIntegrationsServer) ListIntegrations ¶
func (UnimplementedIntegrationsServer) ListIntegrations(context.Context, *ListIntegrationsRequest) (*ListIntegrationsResponse, error)
type UnsafeIntegrationsServer ¶
type UnsafeIntegrationsServer interface {
// contains filtered or unexported methods
}
UnsafeIntegrationsServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to IntegrationsServer will result in compilation errors.
Source Files