Documentation
¶
Overview ¶
Package applications is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Constants
- Variables
- func RegisterApplicationsHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterApplicationsHandlerClient(ctx context.Context, mux *runtime.ServeMux, client ApplicationsClient) error
- func RegisterApplicationsHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterApplicationsHandlerServer(ctx context.Context, mux *runtime.ServeMux, server ApplicationsServer) error
- func RegisterApplicationsServer(s grpc.ServiceRegistrar, srv ApplicationsServer)
- type ApplicationDefinition
- func (*ApplicationDefinition) Descriptor() ([]byte, []int)deprecated
- func (x *ApplicationDefinition) GetComponents() []*components.Component
- func (x *ApplicationDefinition) GetConfiguration() []*configuration.Field
- func (x *ApplicationDefinition) GetDescription() string
- func (x *ApplicationDefinition) GetIcon() string
- func (x *ApplicationDefinition) GetLabel() string
- func (x *ApplicationDefinition) GetName() string
- func (x *ApplicationDefinition) GetTriggers() []*triggers.Trigger
- func (*ApplicationDefinition) ProtoMessage()
- func (x *ApplicationDefinition) ProtoReflect() protoreflect.Message
- func (x *ApplicationDefinition) Reset()
- func (x *ApplicationDefinition) String() string
- type ApplicationsClient
- type ApplicationsServer
- type ListApplicationsRequest
- type ListApplicationsResponse
- func (*ListApplicationsResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ListApplicationsResponse) GetApplications() []*ApplicationDefinition
- func (*ListApplicationsResponse) ProtoMessage()
- func (x *ListApplicationsResponse) ProtoReflect() protoreflect.Message
- func (x *ListApplicationsResponse) Reset()
- func (x *ListApplicationsResponse) String() string
- type UnimplementedApplicationsServer
- type UnsafeApplicationsServer
Constants ¶
const (
Applications_ListApplications_FullMethodName = "/Superplane.Applications.Applications/ListApplications"
)
Variables ¶
var Applications_ServiceDesc = grpc.ServiceDesc{ ServiceName: "Superplane.Applications.Applications", HandlerType: (*ApplicationsServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "ListApplications", Handler: _Applications_ListApplications_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "applications.proto", }
Applications_ServiceDesc is the grpc.ServiceDesc for Applications service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var File_applications_proto protoreflect.FileDescriptor
Functions ¶
func RegisterApplicationsHandler ¶
func RegisterApplicationsHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterApplicationsHandler registers the http handlers for service Applications to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterApplicationsHandlerClient ¶
func RegisterApplicationsHandlerClient(ctx context.Context, mux *runtime.ServeMux, client ApplicationsClient) error
RegisterApplicationsHandlerClient registers the http handlers for service Applications to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "ApplicationsClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "ApplicationsClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "ApplicationsClient" to call the correct interceptors. This client ignores the HTTP middlewares.
func RegisterApplicationsHandlerFromEndpoint ¶
func RegisterApplicationsHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterApplicationsHandlerFromEndpoint is same as RegisterApplicationsHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterApplicationsHandlerServer ¶
func RegisterApplicationsHandlerServer(ctx context.Context, mux *runtime.ServeMux, server ApplicationsServer) error
RegisterApplicationsHandlerServer registers the http handlers for service Applications to "mux". UnaryRPC :call ApplicationsServer 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 RegisterApplicationsHandlerFromEndpoint 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 RegisterApplicationsServer ¶
func RegisterApplicationsServer(s grpc.ServiceRegistrar, srv ApplicationsServer)
Types ¶
type ApplicationDefinition ¶
type ApplicationDefinition 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"`
// contains filtered or unexported fields
}
func (*ApplicationDefinition) Descriptor
deprecated
func (*ApplicationDefinition) Descriptor() ([]byte, []int)
Deprecated: Use ApplicationDefinition.ProtoReflect.Descriptor instead.
func (*ApplicationDefinition) GetComponents ¶
func (x *ApplicationDefinition) GetComponents() []*components.Component
func (*ApplicationDefinition) GetConfiguration ¶
func (x *ApplicationDefinition) GetConfiguration() []*configuration.Field
func (*ApplicationDefinition) GetDescription ¶
func (x *ApplicationDefinition) GetDescription() string
func (*ApplicationDefinition) GetIcon ¶
func (x *ApplicationDefinition) GetIcon() string
func (*ApplicationDefinition) GetLabel ¶
func (x *ApplicationDefinition) GetLabel() string
func (*ApplicationDefinition) GetName ¶
func (x *ApplicationDefinition) GetName() string
func (*ApplicationDefinition) GetTriggers ¶
func (x *ApplicationDefinition) GetTriggers() []*triggers.Trigger
func (*ApplicationDefinition) ProtoMessage ¶
func (*ApplicationDefinition) ProtoMessage()
func (*ApplicationDefinition) ProtoReflect ¶
func (x *ApplicationDefinition) ProtoReflect() protoreflect.Message
func (*ApplicationDefinition) Reset ¶
func (x *ApplicationDefinition) Reset()
func (*ApplicationDefinition) String ¶
func (x *ApplicationDefinition) String() string
type ApplicationsClient ¶
type ApplicationsClient interface {
ListApplications(ctx context.Context, in *ListApplicationsRequest, opts ...grpc.CallOption) (*ListApplicationsResponse, error)
}
ApplicationsClient is the client API for Applications 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 NewApplicationsClient ¶
func NewApplicationsClient(cc grpc.ClientConnInterface) ApplicationsClient
type ApplicationsServer ¶
type ApplicationsServer interface {
ListApplications(context.Context, *ListApplicationsRequest) (*ListApplicationsResponse, error)
}
ApplicationsServer is the server API for Applications service. All implementations should embed UnimplementedApplicationsServer for forward compatibility.
type ListApplicationsRequest ¶
type ListApplicationsRequest struct {
// contains filtered or unexported fields
}
func (*ListApplicationsRequest) Descriptor
deprecated
func (*ListApplicationsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListApplicationsRequest.ProtoReflect.Descriptor instead.
func (*ListApplicationsRequest) ProtoMessage ¶
func (*ListApplicationsRequest) ProtoMessage()
func (*ListApplicationsRequest) ProtoReflect ¶
func (x *ListApplicationsRequest) ProtoReflect() protoreflect.Message
func (*ListApplicationsRequest) Reset ¶
func (x *ListApplicationsRequest) Reset()
func (*ListApplicationsRequest) String ¶
func (x *ListApplicationsRequest) String() string
type ListApplicationsResponse ¶
type ListApplicationsResponse struct {
Applications []*ApplicationDefinition `protobuf:"bytes,1,rep,name=applications,proto3" json:"applications,omitempty"`
// contains filtered or unexported fields
}
func (*ListApplicationsResponse) Descriptor
deprecated
func (*ListApplicationsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListApplicationsResponse.ProtoReflect.Descriptor instead.
func (*ListApplicationsResponse) GetApplications ¶
func (x *ListApplicationsResponse) GetApplications() []*ApplicationDefinition
func (*ListApplicationsResponse) ProtoMessage ¶
func (*ListApplicationsResponse) ProtoMessage()
func (*ListApplicationsResponse) ProtoReflect ¶
func (x *ListApplicationsResponse) ProtoReflect() protoreflect.Message
func (*ListApplicationsResponse) Reset ¶
func (x *ListApplicationsResponse) Reset()
func (*ListApplicationsResponse) String ¶
func (x *ListApplicationsResponse) String() string
type UnimplementedApplicationsServer ¶
type UnimplementedApplicationsServer struct{}
UnimplementedApplicationsServer 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 (UnimplementedApplicationsServer) ListApplications ¶
func (UnimplementedApplicationsServer) ListApplications(context.Context, *ListApplicationsRequest) (*ListApplicationsResponse, error)
type UnsafeApplicationsServer ¶
type UnsafeApplicationsServer interface {
// contains filtered or unexported methods
}
UnsafeApplicationsServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ApplicationsServer will result in compilation errors.
Source Files