Documentation
¶
Overview ¶
Package protos is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Package protos is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Variables
- func RegisterHealthHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterHealthHandlerClient(ctx context.Context, mux *runtime.ServeMux, client HealthClient) error
- func RegisterHealthHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterHealthHandlerServer(ctx context.Context, mux *runtime.ServeMux, server HealthServer) error
- func RegisterHealthServer(s grpc.ServiceRegistrar, srv HealthServer)
- func RegisterVersionHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterVersionHandlerClient(ctx context.Context, mux *runtime.ServeMux, client VersionClient) error
- func RegisterVersionHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterVersionHandlerServer(ctx context.Context, mux *runtime.ServeMux, server VersionServer) error
- func RegisterVersionServer(s grpc.ServiceRegistrar, srv VersionServer)
- type HealthClient
- type HealthRequest
- type HealthResponse
- func (*HealthResponse) Descriptor() ([]byte, []int)deprecated
- func (x *HealthResponse) GetMessage() string
- func (x *HealthResponse) GetStatusCode() int32
- func (*HealthResponse) ProtoMessage()
- func (x *HealthResponse) ProtoReflect() protoreflect.Message
- func (x *HealthResponse) Reset()
- func (x *HealthResponse) String() string
- type HealthServer
- type UnimplementedHealthServer
- type UnimplementedVersionServer
- type UnsafeHealthServer
- type UnsafeVersionServer
- type VersionClient
- type VersionRequest
- type VersionResponse
- func (*VersionResponse) Descriptor() ([]byte, []int)deprecated
- func (x *VersionResponse) GetMessage() string
- func (x *VersionResponse) GetStatusCode() int32
- func (*VersionResponse) ProtoMessage()
- func (x *VersionResponse) ProtoReflect() protoreflect.Message
- func (x *VersionResponse) Reset()
- func (x *VersionResponse) String() string
- type VersionServer
Constants ¶
This section is empty.
Variables ¶
var File_health_proto protoreflect.FileDescriptor
var File_version_proto protoreflect.FileDescriptor
var Health_ServiceDesc = grpc.ServiceDesc{ ServiceName: "Health", HandlerType: (*HealthServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "Health", Handler: _Health_Health_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "health.proto", }
Health_ServiceDesc is the grpc.ServiceDesc for Health service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var Version_ServiceDesc = grpc.ServiceDesc{ ServiceName: "Version", HandlerType: (*VersionServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "Version", Handler: _Version_Version_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "version.proto", }
Version_ServiceDesc is the grpc.ServiceDesc for Version service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterHealthHandler ¶
RegisterHealthHandler registers the http handlers for service Health to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterHealthHandlerClient ¶
func RegisterHealthHandlerClient(ctx context.Context, mux *runtime.ServeMux, client HealthClient) error
RegisterHealthHandlerClient registers the http handlers for service Health to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "HealthClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "HealthClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "HealthClient" to call the correct interceptors.
func RegisterHealthHandlerFromEndpoint ¶
func RegisterHealthHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterHealthHandlerFromEndpoint is same as RegisterHealthHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterHealthHandlerServer ¶
func RegisterHealthHandlerServer(ctx context.Context, mux *runtime.ServeMux, server HealthServer) error
RegisterHealthHandlerServer registers the http handlers for service Health to "mux". UnaryRPC :call HealthServer 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 RegisterHealthHandlerFromEndpoint instead.
func RegisterHealthServer ¶
func RegisterHealthServer(s grpc.ServiceRegistrar, srv HealthServer)
func RegisterVersionHandler ¶
func RegisterVersionHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterVersionHandler registers the http handlers for service Version to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterVersionHandlerClient ¶
func RegisterVersionHandlerClient(ctx context.Context, mux *runtime.ServeMux, client VersionClient) error
RegisterVersionHandlerClient registers the http handlers for service Version to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "VersionClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "VersionClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "VersionClient" to call the correct interceptors.
func RegisterVersionHandlerFromEndpoint ¶
func RegisterVersionHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterVersionHandlerFromEndpoint is same as RegisterVersionHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterVersionHandlerServer ¶
func RegisterVersionHandlerServer(ctx context.Context, mux *runtime.ServeMux, server VersionServer) error
RegisterVersionHandlerServer registers the http handlers for service Version to "mux". UnaryRPC :call VersionServer 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 RegisterVersionHandlerFromEndpoint instead.
func RegisterVersionServer ¶
func RegisterVersionServer(s grpc.ServiceRegistrar, srv VersionServer)
Types ¶
type HealthClient ¶
type HealthClient interface {
Health(ctx context.Context, in *HealthRequest, opts ...grpc.CallOption) (*HealthResponse, error)
}
HealthClient is the client API for Health 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 NewHealthClient ¶
func NewHealthClient(cc grpc.ClientConnInterface) HealthClient
type HealthRequest ¶
type HealthRequest struct {
ProjectName string `protobuf:"bytes,1,opt,name=projectName,proto3" json:"projectName,omitempty"`
// contains filtered or unexported fields
}
define empty message
func (*HealthRequest) Descriptor
deprecated
func (*HealthRequest) Descriptor() ([]byte, []int)
Deprecated: Use HealthRequest.ProtoReflect.Descriptor instead.
func (*HealthRequest) GetProjectName ¶
func (x *HealthRequest) GetProjectName() string
func (*HealthRequest) ProtoMessage ¶
func (*HealthRequest) ProtoMessage()
func (*HealthRequest) ProtoReflect ¶
func (x *HealthRequest) ProtoReflect() protoreflect.Message
func (*HealthRequest) Reset ¶
func (x *HealthRequest) Reset()
func (*HealthRequest) String ¶
func (x *HealthRequest) String() string
type HealthResponse ¶
type HealthResponse struct {
StatusCode int32 `protobuf:"varint,1,opt,name=statusCode,proto3" json:"statusCode,omitempty"`
Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
// contains filtered or unexported fields
}
func (*HealthResponse) Descriptor
deprecated
func (*HealthResponse) Descriptor() ([]byte, []int)
Deprecated: Use HealthResponse.ProtoReflect.Descriptor instead.
func (*HealthResponse) GetMessage ¶
func (x *HealthResponse) GetMessage() string
func (*HealthResponse) GetStatusCode ¶
func (x *HealthResponse) GetStatusCode() int32
func (*HealthResponse) ProtoMessage ¶
func (*HealthResponse) ProtoMessage()
func (*HealthResponse) ProtoReflect ¶
func (x *HealthResponse) ProtoReflect() protoreflect.Message
func (*HealthResponse) Reset ¶
func (x *HealthResponse) Reset()
func (*HealthResponse) String ¶
func (x *HealthResponse) String() string
type HealthServer ¶
type HealthServer interface {
Health(context.Context, *HealthRequest) (*HealthResponse, error)
// contains filtered or unexported methods
}
HealthServer is the server API for Health service. All implementations must embed UnimplementedHealthServer for forward compatibility
type UnimplementedHealthServer ¶
type UnimplementedHealthServer struct {
}
UnimplementedHealthServer must be embedded to have forward compatible implementations.
func (UnimplementedHealthServer) Health ¶
func (UnimplementedHealthServer) Health(context.Context, *HealthRequest) (*HealthResponse, error)
type UnimplementedVersionServer ¶
type UnimplementedVersionServer struct {
}
UnimplementedVersionServer must be embedded to have forward compatible implementations.
func (UnimplementedVersionServer) Version ¶
func (UnimplementedVersionServer) Version(context.Context, *VersionRequest) (*VersionResponse, error)
type UnsafeHealthServer ¶
type UnsafeHealthServer interface {
// contains filtered or unexported methods
}
UnsafeHealthServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to HealthServer will result in compilation errors.
type UnsafeVersionServer ¶
type UnsafeVersionServer interface {
// contains filtered or unexported methods
}
UnsafeVersionServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to VersionServer will result in compilation errors.
type VersionClient ¶
type VersionClient interface {
Version(ctx context.Context, in *VersionRequest, opts ...grpc.CallOption) (*VersionResponse, error)
}
VersionClient is the client API for Version 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 NewVersionClient ¶
func NewVersionClient(cc grpc.ClientConnInterface) VersionClient
type VersionRequest ¶
type VersionRequest struct {
ProjectName string `protobuf:"bytes,1,opt,name=projectName,proto3" json:"projectName,omitempty"`
// contains filtered or unexported fields
}
define empty message
func (*VersionRequest) Descriptor
deprecated
func (*VersionRequest) Descriptor() ([]byte, []int)
Deprecated: Use VersionRequest.ProtoReflect.Descriptor instead.
func (*VersionRequest) GetProjectName ¶
func (x *VersionRequest) GetProjectName() string
func (*VersionRequest) ProtoMessage ¶
func (*VersionRequest) ProtoMessage()
func (*VersionRequest) ProtoReflect ¶
func (x *VersionRequest) ProtoReflect() protoreflect.Message
func (*VersionRequest) Reset ¶
func (x *VersionRequest) Reset()
func (*VersionRequest) String ¶
func (x *VersionRequest) String() string
type VersionResponse ¶
type VersionResponse struct {
StatusCode int32 `protobuf:"varint,1,opt,name=statusCode,proto3" json:"statusCode,omitempty"`
Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
// contains filtered or unexported fields
}
func (*VersionResponse) Descriptor
deprecated
func (*VersionResponse) Descriptor() ([]byte, []int)
Deprecated: Use VersionResponse.ProtoReflect.Descriptor instead.
func (*VersionResponse) GetMessage ¶
func (x *VersionResponse) GetMessage() string
func (*VersionResponse) GetStatusCode ¶
func (x *VersionResponse) GetStatusCode() int32
func (*VersionResponse) ProtoMessage ¶
func (*VersionResponse) ProtoMessage()
func (*VersionResponse) ProtoReflect ¶
func (x *VersionResponse) ProtoReflect() protoreflect.Message
func (*VersionResponse) Reset ¶
func (x *VersionResponse) Reset()
func (*VersionResponse) String ¶
func (x *VersionResponse) String() string
type VersionServer ¶
type VersionServer interface {
Version(context.Context, *VersionRequest) (*VersionResponse, error)
// contains filtered or unexported methods
}
VersionServer is the server API for Version service. All implementations must embed UnimplementedVersionServer for forward compatibility