Documentation
¶
Overview ¶
Package class is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Constants
- Variables
- func RegisterClassServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterClassServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client ClassServiceClient) error
- func RegisterClassServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterClassServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server ClassServiceServer) error
- func RegisterClassServiceServer(s grpc.ServiceRegistrar, srv ClassServiceServer)
- type ClassServiceClient
- type ClassServiceServer
- type Font
- type GetClassLogoRequest
- func (*GetClassLogoRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GetClassLogoRequest) GetFont() Font
- func (x *GetClassLogoRequest) GetIncludeString() bool
- func (*GetClassLogoRequest) ProtoMessage()
- func (x *GetClassLogoRequest) ProtoReflect() protoreflect.Message
- func (x *GetClassLogoRequest) Reset()
- func (x *GetClassLogoRequest) String() string
- type GetClassLogoResponse
- func (*GetClassLogoResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetClassLogoResponse) GetLogoBytes() []byte
- func (x *GetClassLogoResponse) GetLogoString() string
- func (*GetClassLogoResponse) ProtoMessage()
- func (x *GetClassLogoResponse) ProtoReflect() protoreflect.Message
- func (x *GetClassLogoResponse) Reset()
- func (x *GetClassLogoResponse) String() string
- type UnimplementedClassServiceServer
- type UnsafeClassServiceServer
Constants ¶
const (
ClassService_GetClassLogo_FullMethodName = "/class.v1alpha1.ClassService/GetClassLogo"
)
Variables ¶
var ( Font_name = map[int32]string{}/* 144 elements not displayed */ Font_value = map[string]int32{}/* 144 elements not displayed */ )
Enum value maps for Font.
var ClassService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "class.v1alpha1.ClassService", HandlerType: (*ClassServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "GetClassLogo", Handler: _ClassService_GetClassLogo_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "class/v1alpha1/class.proto", }
ClassService_ServiceDesc is the grpc.ServiceDesc for ClassService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var File_class_v1alpha1_class_proto protoreflect.FileDescriptor
Functions ¶
func RegisterClassServiceHandler ¶
func RegisterClassServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterClassServiceHandler registers the http handlers for service ClassService to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterClassServiceHandlerClient ¶
func RegisterClassServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client ClassServiceClient) error
RegisterClassServiceHandlerClient registers the http handlers for service ClassService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "ClassServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "ClassServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "ClassServiceClient" to call the correct interceptors. This client ignores the HTTP middlewares.
func RegisterClassServiceHandlerFromEndpoint ¶
func RegisterClassServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterClassServiceHandlerFromEndpoint is same as RegisterClassServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterClassServiceHandlerServer ¶
func RegisterClassServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server ClassServiceServer) error
RegisterClassServiceHandlerServer registers the http handlers for service ClassService to "mux". UnaryRPC :call ClassServiceServer 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 RegisterClassServiceHandlerFromEndpoint 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 RegisterClassServiceServer ¶
func RegisterClassServiceServer(s grpc.ServiceRegistrar, srv ClassServiceServer)
Types ¶
type ClassServiceClient ¶
type ClassServiceClient interface {
GetClassLogo(ctx context.Context, in *GetClassLogoRequest, opts ...grpc.CallOption) (*GetClassLogoResponse, error)
}
ClassServiceClient is the client API for ClassService 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 NewClassServiceClient ¶
func NewClassServiceClient(cc grpc.ClientConnInterface) ClassServiceClient
type ClassServiceServer ¶
type ClassServiceServer interface { GetClassLogo(context.Context, *GetClassLogoRequest) (*GetClassLogoResponse, error) // contains filtered or unexported methods }
ClassServiceServer is the server API for ClassService service. All implementations must embed UnimplementedClassServiceServer for forward compatibility.
type Font ¶
type Font int32
const ( Font_FONT_UNSPECIFIED Font = 0 Font_FONT_3X5 Font = 2 Font_FONT_5LINEOBLIQUE Font = 3 Font_FONT_ACROBATIC Font = 4 Font_FONT_ALLIGATOR Font = 5 Font_FONT_ALLIGATOR2 Font = 6 Font_FONT_ALPHABET Font = 7 Font_FONT_AVATAR Font = 8 Font_FONT_BANNER Font = 9 Font_FONT_BANNER3 Font = 11 Font_FONT_BANNER4 Font = 12 Font_FONT_BARBWIRE Font = 13 Font_FONT_BASIC Font = 14 Font_FONT_BELL Font = 15 Font_FONT_BIG Font = 16 Font_FONT_BIGCHIEF Font = 17 Font_FONT_BINARY Font = 18 Font_FONT_BLOCK Font = 19 Font_FONT_BUBBLE Font = 20 Font_FONT_BULBHEAD Font = 21 Font_FONT_CALGPHY2 Font = 22 Font_FONT_CALIGRAPHY Font = 23 Font_FONT_CATWALK Font = 24 Font_FONT_CHUNKY Font = 25 Font_FONT_COINSTAK Font = 26 Font_FONT_COLOSSAL Font = 27 Font_FONT_COMPUTER Font = 28 Font_FONT_CONTESSA Font = 29 Font_FONT_CONTRAST Font = 30 Font_FONT_COSMIC Font = 31 Font_FONT_COSMIKE Font = 32 Font_FONT_CRICKET Font = 33 Font_FONT_CURSIVE Font = 34 Font_FONT_CYBERLARGE Font = 35 Font_FONT_CYBERMEDIUM Font = 36 Font_FONT_CYBERSMALL Font = 37 Font_FONT_DIAMOND Font = 38 Font_FONT_DIGITAL Font = 39 Font_FONT_DOH Font = 40 Font_FONT_DOOM Font = 41 Font_FONT_DOTMATRIX Font = 42 Font_FONT_DRPEPPER Font = 43 Font_FONT_EFTICHESS Font = 44 Font_FONT_EFTIFONT Font = 45 Font_FONT_EFTIPITI Font = 46 Font_FONT_EFTIROBOT Font = 47 Font_FONT_EFTITALIC Font = 48 Font_FONT_EFTIWALL Font = 49 Font_FONT_EFTIWATER Font = 50 Font_FONT_EPIC Font = 51 Font_FONT_FENDER Font = 52 Font_FONT_FOURTOPS Font = 53 Font_FONT_FUZZY Font = 54 Font_FONT_GOOFY Font = 55 Font_FONT_GOTHIC Font = 56 Font_FONT_GRAFFITI Font = 57 Font_FONT_HOLLYWOOD Font = 58 Font_FONT_INVITA Font = 59 Font_FONT_ISOMETRIC1 Font = 60 Font_FONT_ISOMETRIC2 Font = 61 Font_FONT_ISOMETRIC3 Font = 62 Font_FONT_ISOMETRIC4 Font = 63 Font_FONT_ITALIC Font = 64 Font_FONT_IVRIT Font = 65 Font_FONT_JAZMINE Font = 66 Font_FONT_JERUSALEM Font = 67 Font_FONT_KATAKANA Font = 68 Font_FONT_KBAN Font = 69 Font_FONT_LARRY3D Font = 70 Font_FONT_LCD Font = 71 Font_FONT_LEAN Font = 72 Font_FONT_LETTERS Font = 73 Font_FONT_LINUX Font = 74 Font_FONT_LOCKERGNOME Font = 75 Font_FONT_MADRID Font = 76 Font_FONT_MARQUEE Font = 77 Font_FONT_MAXFOUR Font = 78 Font_FONT_MIKE Font = 79 Font_FONT_MINI Font = 80 Font_FONT_MIRROR Font = 81 Font_FONT_MNEMONIC Font = 82 Font_FONT_MORSE Font = 83 Font_FONT_MOSCOW Font = 84 Font_FONT_NANCYJ Font = 87 Font_FONT_NIPPLES Font = 88 Font_FONT_NTGREEK Font = 89 Font_FONT_O8 Font = 90 Font_FONT_OGRE Font = 91 Font_FONT_PAWP Font = 92 Font_FONT_PEAKS Font = 93 Font_FONT_PEBBLES Font = 94 Font_FONT_PEPPER Font = 95 Font_FONT_POISON Font = 96 Font_FONT_PUFFY Font = 97 Font_FONT_PYRAMID Font = 98 Font_FONT_RECTANGLES Font = 99 Font_FONT_RELIEF Font = 100 Font_FONT_RELIEF2 Font = 101 Font_FONT_REV Font = 102 Font_FONT_ROMAN Font = 103 Font_FONT_ROT13 Font = 104 Font_FONT_ROUNDED Font = 105 Font_FONT_ROWANCAP Font = 106 Font_FONT_ROZZO Font = 107 Font_FONT_RUNIC Font = 108 Font_FONT_RUNYC Font = 109 Font_FONT_SBLOOD Font = 110 Font_FONT_SCRIPT Font = 111 Font_FONT_SERIFCAP Font = 112 Font_FONT_SHADOW Font = 113 Font_FONT_SHORT Font = 114 Font_FONT_SLANT Font = 115 Font_FONT_SLIDE Font = 116 Font_FONT_SLSCRIPT Font = 117 Font_FONT_SMALL Font = 118 Font_FONT_SMISOME1 Font = 119 Font_FONT_SMKEYBOARD Font = 120 Font_FONT_SMSCRIPT Font = 121 Font_FONT_SMSHADOW Font = 122 Font_FONT_SMSLANT Font = 123 Font_FONT_SMTENGWAR Font = 124 Font_FONT_SPEED Font = 125 Font_FONT_STAMPATELLO Font = 126 Font_FONT_STANDARD Font = 127 Font_FONT_STARWARS Font = 128 Font_FONT_STELLAR Font = 129 Font_FONT_STOP Font = 130 Font_FONT_STRAIGHT Font = 131 Font_FONT_TANJA Font = 132 Font_FONT_TENGWAR Font = 133 Font_FONT_TERM Font = 134 Font_FONT_THICK Font = 135 Font_FONT_THIN Font = 136 Font_FONT_THREEPOINT Font = 137 Font_FONT_TICKS Font = 138 Font_FONT_TICKSSLANT Font = 139 Font_FONT_TOMBSTONE Font = 141 Font_FONT_TREK Font = 142 Font_FONT_TSALAGI Font = 143 Font_FONT_TWOPOINT Font = 144 Font_FONT_UNIVERS Font = 145 Font_FONT_USAFLAG Font = 146 Font_FONT_WAVY Font = 147 Font_FONT_WEIRD Font = 148 )
func (Font) Descriptor ¶
func (Font) Descriptor() protoreflect.EnumDescriptor
func (Font) EnumDescriptor
deprecated
func (Font) Number ¶
func (x Font) Number() protoreflect.EnumNumber
func (Font) Type ¶
func (Font) Type() protoreflect.EnumType
type GetClassLogoRequest ¶
type GetClassLogoRequest struct { Font Font `protobuf:"varint,1,opt,name=font,proto3,enum=class.v1alpha1.Font" json:"font,omitempty"` IncludeString *bool `protobuf:"varint,2,opt,name=include_string,json=includeString,proto3,oneof" json:"include_string,omitempty"` // contains filtered or unexported fields }
func (*GetClassLogoRequest) Descriptor
deprecated
func (*GetClassLogoRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetClassLogoRequest.ProtoReflect.Descriptor instead.
func (*GetClassLogoRequest) GetFont ¶
func (x *GetClassLogoRequest) GetFont() Font
func (*GetClassLogoRequest) GetIncludeString ¶
func (x *GetClassLogoRequest) GetIncludeString() bool
func (*GetClassLogoRequest) ProtoMessage ¶
func (*GetClassLogoRequest) ProtoMessage()
func (*GetClassLogoRequest) ProtoReflect ¶
func (x *GetClassLogoRequest) ProtoReflect() protoreflect.Message
func (*GetClassLogoRequest) Reset ¶
func (x *GetClassLogoRequest) Reset()
func (*GetClassLogoRequest) String ¶
func (x *GetClassLogoRequest) String() string
type GetClassLogoResponse ¶
type GetClassLogoResponse struct { LogoBytes []byte `protobuf:"bytes,1,opt,name=logo_bytes,json=logoBytes,proto3" json:"logo_bytes,omitempty"` LogoString string `protobuf:"bytes,2,opt,name=logo_string,json=logoString,proto3" json:"logo_string,omitempty"` // contains filtered or unexported fields }
func (*GetClassLogoResponse) Descriptor
deprecated
func (*GetClassLogoResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetClassLogoResponse.ProtoReflect.Descriptor instead.
func (*GetClassLogoResponse) GetLogoBytes ¶
func (x *GetClassLogoResponse) GetLogoBytes() []byte
func (*GetClassLogoResponse) GetLogoString ¶
func (x *GetClassLogoResponse) GetLogoString() string
func (*GetClassLogoResponse) ProtoMessage ¶
func (*GetClassLogoResponse) ProtoMessage()
func (*GetClassLogoResponse) ProtoReflect ¶
func (x *GetClassLogoResponse) ProtoReflect() protoreflect.Message
func (*GetClassLogoResponse) Reset ¶
func (x *GetClassLogoResponse) Reset()
func (*GetClassLogoResponse) String ¶
func (x *GetClassLogoResponse) String() string
type UnimplementedClassServiceServer ¶
type UnimplementedClassServiceServer struct{}
UnimplementedClassServiceServer must 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 (UnimplementedClassServiceServer) GetClassLogo ¶
func (UnimplementedClassServiceServer) GetClassLogo(context.Context, *GetClassLogoRequest) (*GetClassLogoResponse, error)
type UnsafeClassServiceServer ¶
type UnsafeClassServiceServer interface {
// contains filtered or unexported methods
}
UnsafeClassServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ClassServiceServer will result in compilation errors.