v1

package
v0.1.1 Latest Latest
Warning

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

 Go to latest Published: Nov 8, 2023 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Overview

Package v1 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source 
const (
	Registry_ListModules_FullMethodName     = "/pbufregistry.v1.Registry/ListModules"
	Registry_GetModule_FullMethodName       = "/pbufregistry.v1.Registry/GetModule"
	Registry_RegisterModule_FullMethodName  = "/pbufregistry.v1.Registry/RegisterModule"
	Registry_PullModule_FullMethodName      = "/pbufregistry.v1.Registry/PullModule"
	Registry_PushModule_FullMethodName      = "/pbufregistry.v1.Registry/PushModule"
	Registry_DeleteModule_FullMethodName    = "/pbufregistry.v1.Registry/DeleteModule"
	Registry_DeleteModuleTag_FullMethodName = "/pbufregistry.v1.Registry/DeleteModuleTag"
)

Variables

View Source 
var File_v1_registry_proto protoreflect.FileDescriptor
View Source 
var Registry_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "pbufregistry.v1.Registry",
	HandlerType: (*RegistryServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ListModules",
			Handler:    _Registry_ListModules_Handler,
		},
		{
			MethodName: "GetModule",
			Handler:    _Registry_GetModule_Handler,
		},
		{
			MethodName: "RegisterModule",
			Handler:    _Registry_RegisterModule_Handler,
		},
		{
			MethodName: "PullModule",
			Handler:    _Registry_PullModule_Handler,
		},
		{
			MethodName: "PushModule",
			Handler:    _Registry_PushModule_Handler,
		},
		{
			MethodName: "DeleteModule",
			Handler:    _Registry_DeleteModule_Handler,
		},
		{
			MethodName: "DeleteModuleTag",
			Handler:    _Registry_DeleteModuleTag_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "v1/registry.proto",
}

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

Functions

func RegisterRegistryHandler 

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

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

func RegisterRegistryHandlerClient 

func RegisterRegistryHandlerClient(ctx context.Context, mux *runtime.ServeMux, client RegistryClient) error

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

func RegisterRegistryHandlerFromEndpoint 

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

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

func RegisterRegistryHandlerServer 

func RegisterRegistryHandlerServer(ctx context.Context, mux *runtime.ServeMux, server RegistryServer) error

RegisterRegistryHandlerServer registers the http handlers for service Registry to "mux". UnaryRPC :call RegistryServer 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 RegisterRegistryHandlerFromEndpoint instead.

func RegisterRegistryServer 

func RegisterRegistryServer(s grpc.ServiceRegistrar, srv RegistryServer)

Types

type DeleteModuleRequest 

type DeleteModuleRequest struct {

	// The name of the module to delete.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

DeleteModuleRequest is the request message for DeleteModule.

func (*DeleteModuleRequest) Descriptor deprecated 

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

Deprecated: Use DeleteModuleRequest.ProtoReflect.Descriptor instead.

func (*DeleteModuleRequest) GetName 

func (x *DeleteModuleRequest) GetName() string

func (*DeleteModuleRequest) ProtoMessage 

func (*DeleteModuleRequest) ProtoMessage()

func (*DeleteModuleRequest) ProtoReflect 

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

func (*DeleteModuleRequest) Reset 

func (x *DeleteModuleRequest) Reset()

func (*DeleteModuleRequest) String 

func (x *DeleteModuleRequest) String() string

type DeleteModuleResponse 

type DeleteModuleResponse struct {

	// The name of the deleted module.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

DeleteModuleResponse is the response message for DeleteModule.

func (*DeleteModuleResponse) Descriptor deprecated 

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

Deprecated: Use DeleteModuleResponse.ProtoReflect.Descriptor instead.

func (*DeleteModuleResponse) GetName 

func (x *DeleteModuleResponse) GetName() string

func (*DeleteModuleResponse) ProtoMessage 

func (*DeleteModuleResponse) ProtoMessage()

func (*DeleteModuleResponse) ProtoReflect 

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

func (*DeleteModuleResponse) Reset 

func (x *DeleteModuleResponse) Reset()

func (*DeleteModuleResponse) String 

func (x *DeleteModuleResponse) String() string

type DeleteModuleTagRequest 

type DeleteModuleTagRequest struct {

	// The name of the module to delete.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The tag of the module to delete.
	Tag string `protobuf:"bytes,2,opt,name=tag,proto3" json:"tag,omitempty"`
	// contains filtered or unexported fields
}

DeleteModuleTagRequest is the request message for DeleteModuleTag.

func (*DeleteModuleTagRequest) Descriptor deprecated 

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

Deprecated: Use DeleteModuleTagRequest.ProtoReflect.Descriptor instead.

func (*DeleteModuleTagRequest) GetName 

func (x *DeleteModuleTagRequest) GetName() string

func (*DeleteModuleTagRequest) GetTag 

func (x *DeleteModuleTagRequest) GetTag() string

func (*DeleteModuleTagRequest) ProtoMessage 

func (*DeleteModuleTagRequest) ProtoMessage()

func (*DeleteModuleTagRequest) ProtoReflect 

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

func (*DeleteModuleTagRequest) Reset 

func (x *DeleteModuleTagRequest) Reset()

func (*DeleteModuleTagRequest) String 

func (x *DeleteModuleTagRequest) String() string

type DeleteModuleTagResponse 

type DeleteModuleTagResponse struct {

	// The name of the deleted module.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The tag of the deleted module.
	Tag string `protobuf:"bytes,2,opt,name=tag,proto3" json:"tag,omitempty"`
	// contains filtered or unexported fields
}

DeleteModuleTagResponse is the response message for DeleteModuleTag.

func (*DeleteModuleTagResponse) Descriptor deprecated 

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

Deprecated: Use DeleteModuleTagResponse.ProtoReflect.Descriptor instead.

func (*DeleteModuleTagResponse) GetName 

func (x *DeleteModuleTagResponse) GetName() string

func (*DeleteModuleTagResponse) GetTag 

func (x *DeleteModuleTagResponse) GetTag() string

func (*DeleteModuleTagResponse) ProtoMessage 

func (*DeleteModuleTagResponse) ProtoMessage()

func (*DeleteModuleTagResponse) ProtoReflect 

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

func (*DeleteModuleTagResponse) Reset 

func (x *DeleteModuleTagResponse) Reset()

func (*DeleteModuleTagResponse) String 

func (x *DeleteModuleTagResponse) String() string

type GetModuleRequest 

type GetModuleRequest struct {

	// The name of the module to retrieve.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

GetModuleRequest is the request message for GetModule.

func (*GetModuleRequest) Descriptor deprecated 

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

Deprecated: Use GetModuleRequest.ProtoReflect.Descriptor instead.

func (*GetModuleRequest) GetName 

func (x *GetModuleRequest) GetName() string

func (*GetModuleRequest) ProtoMessage 

func (*GetModuleRequest) ProtoMessage()

func (*GetModuleRequest) ProtoReflect 

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

func (*GetModuleRequest) Reset 

func (x *GetModuleRequest) Reset()

func (*GetModuleRequest) String 

func (x *GetModuleRequest) String() string

type ListModulesRequest 

type ListModulesRequest struct {

	// The maximum number of modules to return.
	// The service may return fewer than this value.
	// If unspecified, at most 50 modules will be returned.
	// The maximum value is 1000; values above 1000 will be coerced to 1000.
	PageSize int32 `protobuf:"varint,1,opt,name=page_size,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous `ListModules` call.
	// Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to `ListModules` must match
	// the call that provided the page token.
	PageToken string `protobuf:"bytes,2,opt,name=page_token,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

ListModulesRequest is the request message for ListModules.

func (*ListModulesRequest) Descriptor deprecated 

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

Deprecated: Use ListModulesRequest.ProtoReflect.Descriptor instead.

func (*ListModulesRequest) GetPageSize 

func (x *ListModulesRequest) GetPageSize() int32

func (*ListModulesRequest) GetPageToken 

func (x *ListModulesRequest) GetPageToken() string

func (*ListModulesRequest) ProtoMessage 

func (*ListModulesRequest) ProtoMessage()

func (*ListModulesRequest) ProtoReflect 

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

func (*ListModulesRequest) Reset 

func (x *ListModulesRequest) Reset()

func (*ListModulesRequest) String 

func (x *ListModulesRequest) String() string

type ListModulesResponse 

type ListModulesResponse struct {

	// The modules requested.
	Modules []*Module `protobuf:"bytes,1,rep,name=modules,proto3" json:"modules,omitempty"`
	// A token, which can be sent as `page_token` to retrieve the next page.
	// If this field is omitted, there are no subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

ListModulesResponse is the response message for ListModules.

func (*ListModulesResponse) Descriptor deprecated 

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

Deprecated: Use ListModulesResponse.ProtoReflect.Descriptor instead.

func (*ListModulesResponse) GetModules 

func (x *ListModulesResponse) GetModules() []*Module

func (*ListModulesResponse) GetNextPageToken 

func (x *ListModulesResponse) GetNextPageToken() string

func (*ListModulesResponse) ProtoMessage 

func (*ListModulesResponse) ProtoMessage()

func (*ListModulesResponse) ProtoReflect 

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

func (*ListModulesResponse) Reset 

func (x *ListModulesResponse) Reset()

func (*ListModulesResponse) String 

func (x *ListModulesResponse) String() string

type Module 

type Module struct {

	// id is the unique identifier of the module.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The name of the module.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// The tags of the module.
	Tags []string `protobuf:"bytes,3,rep,name=tags,proto3" json:"tags,omitempty"`
	// contains filtered or unexported fields
}

Module is a module registered in the registry.

func (*Module) Descriptor deprecated 

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

Deprecated: Use Module.ProtoReflect.Descriptor instead.

func (*Module) GetId added in v0.1.0 

func (x *Module) GetId() string

func (*Module) GetName 

func (x *Module) GetName() string

func (*Module) GetTags 

func (x *Module) GetTags() []string

func (*Module) ProtoMessage 

func (*Module) ProtoMessage()

func (*Module) ProtoReflect 

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

func (*Module) Reset 

func (x *Module) Reset()

func (*Module) String 

func (x *Module) String() string

type ProtoFile added in v0.1.0 

type ProtoFile struct {

	// The filename of the proto file.
	Filename string `protobuf:"bytes,1,opt,name=filename,proto3" json:"filename,omitempty"`
	// The content of the proto file.
	Content string `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
	// contains filtered or unexported fields
}

ProtoFile is a proto file registered in the registry.

func (*ProtoFile) Descriptor deprecated added in v0.1.0 

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

Deprecated: Use ProtoFile.ProtoReflect.Descriptor instead.

func (*ProtoFile) GetContent added in v0.1.0 

func (x *ProtoFile) GetContent() string

func (*ProtoFile) GetFilename added in v0.1.0 

func (x *ProtoFile) GetFilename() string

func (*ProtoFile) ProtoMessage added in v0.1.0 

func (*ProtoFile) ProtoMessage()

func (*ProtoFile) ProtoReflect added in v0.1.0 

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

func (*ProtoFile) Reset added in v0.1.0 

func (x *ProtoFile) Reset()

func (*ProtoFile) String added in v0.1.0 

func (x *ProtoFile) String() string

type PullModuleRequest 

type PullModuleRequest struct {

	// The name of the module to retrieve.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The tag of the module to retrieve.
	Tag string `protobuf:"bytes,2,opt,name=tag,proto3" json:"tag,omitempty"`
	// contains filtered or unexported fields
}

PullModuleRequest is the request message for PullModule.

func (*PullModuleRequest) Descriptor deprecated 

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

Deprecated: Use PullModuleRequest.ProtoReflect.Descriptor instead.

func (*PullModuleRequest) GetName 

func (x *PullModuleRequest) GetName() string

func (*PullModuleRequest) GetTag 

func (x *PullModuleRequest) GetTag() string

func (*PullModuleRequest) ProtoMessage 

func (*PullModuleRequest) ProtoMessage()

func (*PullModuleRequest) ProtoReflect 

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

func (*PullModuleRequest) Reset 

func (x *PullModuleRequest) Reset()

func (*PullModuleRequest) String 

func (x *PullModuleRequest) String() string

type PullModuleResponse added in v0.1.0 

type PullModuleResponse struct {

	// The module requested.
	Module *Module `protobuf:"bytes,1,opt,name=module,proto3" json:"module,omitempty"`
	// The protofiles of the module.
	Protofiles []*ProtoFile `protobuf:"bytes,2,rep,name=protofiles,proto3" json:"protofiles,omitempty"`
	// contains filtered or unexported fields
}

PullModuleResponse is the response message for PullModule.

func (*PullModuleResponse) Descriptor deprecated added in v0.1.0 

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

Deprecated: Use PullModuleResponse.ProtoReflect.Descriptor instead.

func (*PullModuleResponse) GetModule added in v0.1.0 

func (x *PullModuleResponse) GetModule() *Module

func (*PullModuleResponse) GetProtofiles added in v0.1.0 

func (x *PullModuleResponse) GetProtofiles() []*ProtoFile

func (*PullModuleResponse) ProtoMessage added in v0.1.0 

func (*PullModuleResponse) ProtoMessage()

func (*PullModuleResponse) ProtoReflect added in v0.1.0 

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

func (*PullModuleResponse) Reset added in v0.1.0 

func (x *PullModuleResponse) Reset()

func (*PullModuleResponse) String added in v0.1.0 

func (x *PullModuleResponse) String() string

type PushModuleRequest 

type PushModuleRequest struct {

	// The module to register.
	ModuleName string `protobuf:"bytes,1,opt,name=module_name,proto3" json:"module_name,omitempty"`
	// The tag of the module to register.
	Tag string `protobuf:"bytes,2,opt,name=tag,proto3" json:"tag,omitempty"`
	// Protofiles
	Protofiles []*ProtoFile `protobuf:"bytes,3,rep,name=protofiles,proto3" json:"protofiles,omitempty"`
	// contains filtered or unexported fields
}

PushModuleRequest is the request message for PushModule.

func (*PushModuleRequest) Descriptor deprecated 

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

Deprecated: Use PushModuleRequest.ProtoReflect.Descriptor instead.

func (*PushModuleRequest) GetModuleName added in v0.1.0 

func (x *PushModuleRequest) GetModuleName() string

func (*PushModuleRequest) GetProtofiles added in v0.1.0 

func (x *PushModuleRequest) GetProtofiles() []*ProtoFile

func (*PushModuleRequest) GetTag added in v0.1.0 

func (x *PushModuleRequest) GetTag() string

func (*PushModuleRequest) ProtoMessage 

func (*PushModuleRequest) ProtoMessage()

func (*PushModuleRequest) ProtoReflect 

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

func (*PushModuleRequest) Reset 

func (x *PushModuleRequest) Reset()

func (*PushModuleRequest) String 

func (x *PushModuleRequest) String() string

type RegisterModuleRequest 

type RegisterModuleRequest struct {

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

RegisterModuleRequest is the request message for RegisterModule.

func (*RegisterModuleRequest) Descriptor deprecated 

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

Deprecated: Use RegisterModuleRequest.ProtoReflect.Descriptor instead.

func (*RegisterModuleRequest) GetName 

func (x *RegisterModuleRequest) GetName() string

func (*RegisterModuleRequest) ProtoMessage 

func (*RegisterModuleRequest) ProtoMessage()

func (*RegisterModuleRequest) ProtoReflect 

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

func (*RegisterModuleRequest) Reset 

func (x *RegisterModuleRequest) Reset()

func (*RegisterModuleRequest) String 

func (x *RegisterModuleRequest) String() string

type RegistryClient 

type RegistryClient interface {
	// List all registered modules
	ListModules(ctx context.Context, in *ListModulesRequest, opts ...grpc.CallOption) (*ListModulesResponse, error)
	// Get a module by name
	GetModule(ctx context.Context, in *GetModuleRequest, opts ...grpc.CallOption) (*Module, error)
	// Register a module
	RegisterModule(ctx context.Context, in *RegisterModuleRequest, opts ...grpc.CallOption) (*Module, error)
	// Pull a module tag
	PullModule(ctx context.Context, in *PullModuleRequest, opts ...grpc.CallOption) (*PullModuleResponse, error)
	// Push a module
	PushModule(ctx context.Context, in *PushModuleRequest, opts ...grpc.CallOption) (*Module, error)
	// Delete a module by name
	DeleteModule(ctx context.Context, in *DeleteModuleRequest, opts ...grpc.CallOption) (*DeleteModuleResponse, error)
	// Delete a specific module tag
	DeleteModuleTag(ctx context.Context, in *DeleteModuleTagRequest, opts ...grpc.CallOption) (*DeleteModuleTagResponse, error)
}

RegistryClient is the client API for Registry 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 NewRegistryClient 

func NewRegistryClient(cc grpc.ClientConnInterface) RegistryClient

type RegistryServer 

type RegistryServer interface {
	// List all registered modules
	ListModules(context.Context, *ListModulesRequest) (*ListModulesResponse, error)
	// Get a module by name
	GetModule(context.Context, *GetModuleRequest) (*Module, error)
	// Register a module
	RegisterModule(context.Context, *RegisterModuleRequest) (*Module, error)
	// Pull a module tag
	PullModule(context.Context, *PullModuleRequest) (*PullModuleResponse, error)
	// Push a module
	PushModule(context.Context, *PushModuleRequest) (*Module, error)
	// Delete a module by name
	DeleteModule(context.Context, *DeleteModuleRequest) (*DeleteModuleResponse, error)
	// Delete a specific module tag
	DeleteModuleTag(context.Context, *DeleteModuleTagRequest) (*DeleteModuleTagResponse, error)
	// contains filtered or unexported methods
}

RegistryServer is the server API for Registry service. All implementations must embed UnimplementedRegistryServer for forward compatibility

type UnimplementedRegistryServer 

type UnimplementedRegistryServer struct {
}

UnimplementedRegistryServer must be embedded to have forward compatible implementations.

func (UnimplementedRegistryServer) DeleteModule 

func (UnimplementedRegistryServer) DeleteModule(context.Context, *DeleteModuleRequest) (*DeleteModuleResponse, error)

func (UnimplementedRegistryServer) DeleteModuleTag 

func (UnimplementedRegistryServer) DeleteModuleTag(context.Context, *DeleteModuleTagRequest) (*DeleteModuleTagResponse, error)

func (UnimplementedRegistryServer) GetModule 

func (UnimplementedRegistryServer) GetModule(context.Context, *GetModuleRequest) (*Module, error)

func (UnimplementedRegistryServer) ListModules 

func (UnimplementedRegistryServer) ListModules(context.Context, *ListModulesRequest) (*ListModulesResponse, error)

func (UnimplementedRegistryServer) PullModule 

func (UnimplementedRegistryServer) PullModule(context.Context, *PullModuleRequest) (*PullModuleResponse, error)

func (UnimplementedRegistryServer) PushModule 

func (UnimplementedRegistryServer) PushModule(context.Context, *PushModuleRequest) (*Module, error)

func (UnimplementedRegistryServer) RegisterModule 

func (UnimplementedRegistryServer) RegisterModule(context.Context, *RegisterModuleRequest) (*Module, error)

type UnsafeRegistryServer 

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

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.