v1

package
v1.62.0 Latest Latest
Warning

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

 Go to latest Published: Apr 11, 2024 License: MIT 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 (
	Service_GenerateIdentifiers_FullMethodName = "/bezeichner.v1.Service/GenerateIdentifiers"
	Service_MapIdentifiers_FullMethodName      = "/bezeichner.v1.Service/MapIdentifiers"
)

Variables

View Source 
var File_bezeichner_v1_service_proto protoreflect.FileDescriptor
View Source 
var Service_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "bezeichner.v1.Service",
	HandlerType: (*ServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GenerateIdentifiers",
			Handler:    _Service_GenerateIdentifiers_Handler,
		},
		{
			MethodName: "MapIdentifiers",
			Handler:    _Service_MapIdentifiers_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "bezeichner/v1/service.proto",
}

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

Functions

func RegisterServiceHandler 

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

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

func RegisterServiceHandlerClient 

func RegisterServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client ServiceClient) error

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

func RegisterServiceHandlerFromEndpoint 

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

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

func RegisterServiceHandlerServer 

func RegisterServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server ServiceServer) error

RegisterServiceHandlerServer registers the http handlers for service Service to "mux". UnaryRPC :call ServiceServer 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 RegisterServiceHandlerFromEndpoint instead.

func RegisterServiceServer 

func RegisterServiceServer(s grpc.ServiceRegistrar, srv ServiceServer)

Types

type GenerateIdentifiersRequest added in v1.8.0 

type GenerateIdentifiersRequest struct {
	Application string `protobuf:"bytes,1,opt,name=application,proto3" json:"application,omitempty"`
	Count       uint64 `protobuf:"varint,2,opt,name=count,proto3" json:"count,omitempty"`
	// contains filtered or unexported fields
}

GenerateIdentifiersRequest for a specific application.

func (*GenerateIdentifiersRequest) Descriptor deprecated added in v1.8.0 

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

Deprecated: Use GenerateIdentifiersRequest.ProtoReflect.Descriptor instead.

func (*GenerateIdentifiersRequest) GetApplication added in v1.8.0 

func (x *GenerateIdentifiersRequest) GetApplication() string

func (*GenerateIdentifiersRequest) GetCount added in v1.8.0 

func (x *GenerateIdentifiersRequest) GetCount() uint64

func (*GenerateIdentifiersRequest) ProtoMessage added in v1.8.0 

func (*GenerateIdentifiersRequest) ProtoMessage()

func (*GenerateIdentifiersRequest) ProtoReflect added in v1.8.0 

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

func (*GenerateIdentifiersRequest) Reset added in v1.8.0 

func (x *GenerateIdentifiersRequest) Reset()

func (*GenerateIdentifiersRequest) String added in v1.8.0 

func (x *GenerateIdentifiersRequest) String() string

type GenerateIdentifiersResponse added in v1.8.0 

type GenerateIdentifiersResponse struct {
	Meta map[string]string `` /* 149-byte string literal not displayed */
	Ids  []string          `protobuf:"bytes,2,rep,name=ids,proto3" json:"ids,omitempty"`
	// contains filtered or unexported fields
}

GenerateIdentifiersResponse for a specific application.

func (*GenerateIdentifiersResponse) Descriptor deprecated added in v1.8.0 

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

Deprecated: Use GenerateIdentifiersResponse.ProtoReflect.Descriptor instead.

func (*GenerateIdentifiersResponse) GetIds added in v1.8.0 

func (x *GenerateIdentifiersResponse) GetIds() []string

func (*GenerateIdentifiersResponse) GetMeta added in v1.30.0 

func (x *GenerateIdentifiersResponse) GetMeta() map[string]string

func (*GenerateIdentifiersResponse) ProtoMessage added in v1.8.0 

func (*GenerateIdentifiersResponse) ProtoMessage()

func (*GenerateIdentifiersResponse) ProtoReflect added in v1.8.0 

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

func (*GenerateIdentifiersResponse) Reset added in v1.8.0 

func (x *GenerateIdentifiersResponse) Reset()

func (*GenerateIdentifiersResponse) String added in v1.8.0 

func (x *GenerateIdentifiersResponse) String() string

type MapIdentifiersRequest added in v1.8.0 

type MapIdentifiersRequest struct {
	Ids []string `protobuf:"bytes,1,rep,name=ids,proto3" json:"ids,omitempty"`
	// contains filtered or unexported fields
}

MapIdentifiersRequest for some identifiers.

func (*MapIdentifiersRequest) Descriptor deprecated added in v1.8.0 

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

Deprecated: Use MapIdentifiersRequest.ProtoReflect.Descriptor instead.

func (*MapIdentifiersRequest) GetIds added in v1.8.0 

func (x *MapIdentifiersRequest) GetIds() []string

func (*MapIdentifiersRequest) ProtoMessage added in v1.8.0 

func (*MapIdentifiersRequest) ProtoMessage()

func (*MapIdentifiersRequest) ProtoReflect added in v1.8.0 

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

func (*MapIdentifiersRequest) Reset added in v1.8.0 

func (x *MapIdentifiersRequest) Reset()

func (*MapIdentifiersRequest) String added in v1.8.0 

func (x *MapIdentifiersRequest) String() string

type MapIdentifiersResponse added in v1.8.0 

type MapIdentifiersResponse struct {
	Meta map[string]string `` /* 149-byte string literal not displayed */
	Ids  []string          `protobuf:"bytes,2,rep,name=ids,proto3" json:"ids,omitempty"`
	// contains filtered or unexported fields
}

MapIdentifiersResponse for some identifiers.

func (*MapIdentifiersResponse) Descriptor deprecated added in v1.8.0 

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

Deprecated: Use MapIdentifiersResponse.ProtoReflect.Descriptor instead.

func (*MapIdentifiersResponse) GetIds added in v1.8.0 

func (x *MapIdentifiersResponse) GetIds() []string

func (*MapIdentifiersResponse) GetMeta added in v1.30.0 

func (x *MapIdentifiersResponse) GetMeta() map[string]string

func (*MapIdentifiersResponse) ProtoMessage added in v1.8.0 

func (*MapIdentifiersResponse) ProtoMessage()

func (*MapIdentifiersResponse) ProtoReflect added in v1.8.0 

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

func (*MapIdentifiersResponse) Reset added in v1.8.0 

func (x *MapIdentifiersResponse) Reset()

func (*MapIdentifiersResponse) String added in v1.8.0 

func (x *MapIdentifiersResponse) String() string

type ServiceClient 

type ServiceClient interface {
	// GenerateIdentifiers for a specific application.
	GenerateIdentifiers(ctx context.Context, in *GenerateIdentifiersRequest, opts ...grpc.CallOption) (*GenerateIdentifiersResponse, error)
	// MapIdentifiers for some identifiers.
	MapIdentifiers(ctx context.Context, in *MapIdentifiersRequest, opts ...grpc.CallOption) (*MapIdentifiersResponse, error)
}

ServiceClient is the client API for Service 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 NewServiceClient 

func NewServiceClient(cc grpc.ClientConnInterface) ServiceClient

type ServiceServer 

type ServiceServer interface {
	// GenerateIdentifiers for a specific application.
	GenerateIdentifiers(context.Context, *GenerateIdentifiersRequest) (*GenerateIdentifiersResponse, error)
	// MapIdentifiers for some identifiers.
	MapIdentifiers(context.Context, *MapIdentifiersRequest) (*MapIdentifiersResponse, error)
	// contains filtered or unexported methods
}

ServiceServer is the server API for Service service. All implementations must embed UnimplementedServiceServer for forward compatibility

type UnimplementedServiceServer 

type UnimplementedServiceServer struct {
}

UnimplementedServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedServiceServer) GenerateIdentifiers added in v1.8.0 

func (UnimplementedServiceServer) GenerateIdentifiers(context.Context, *GenerateIdentifiersRequest) (*GenerateIdentifiersResponse, error)

func (UnimplementedServiceServer) MapIdentifiers added in v1.8.0 

func (UnimplementedServiceServer) MapIdentifiers(context.Context, *MapIdentifiersRequest) (*MapIdentifiersResponse, error)

type UnsafeServiceServer 

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

UnsafeServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ServiceServer 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.