Documentation
¶
Overview ¶
Package healthcheckpb is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Variables
- func RegisterHealthCheckServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterHealthCheckServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client HealthCheckServiceClient) error
- func RegisterHealthCheckServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterHealthCheckServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server HealthCheckServiceServer) error
- func RegisterHealthCheckServiceServer(s grpc.ServiceRegistrar, srv HealthCheckServiceServer)
- type HealthCheckServiceClient
- type HealthCheckServiceServer
- type LivenessProbeRequest
- type LivenessProbeResponse
- type ReadinessProbeRequest
- type ReadinessProbeResponse
- type StartupProbeRequest
- type StartupProbeResponse
- type UnimplementedHealthCheckServiceServer
- func (UnimplementedHealthCheckServiceServer) LivenessProbe(context.Context, *LivenessProbeRequest) (*LivenessProbeResponse, error)
- func (UnimplementedHealthCheckServiceServer) ReadinessProbe(context.Context, *ReadinessProbeRequest) (*ReadinessProbeResponse, error)
- func (UnimplementedHealthCheckServiceServer) StartupProbe(context.Context, *StartupProbeRequest) (*StartupProbeResponse, error)
- type UnsafeHealthCheckServiceServer
Constants ¶
This section is empty.
Variables ¶
var File_proto_v1_healthcheck_healthcheck_proto protoreflect.FileDescriptor
var HealthCheckService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "healthcheckpb.v1.HealthCheckService", HandlerType: (*HealthCheckServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "LivenessProbe", Handler: _HealthCheckService_LivenessProbe_Handler, }, { MethodName: "ReadinessProbe", Handler: _HealthCheckService_ReadinessProbe_Handler, }, { MethodName: "StartupProbe", Handler: _HealthCheckService_StartupProbe_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "proto/v1/healthcheck/healthcheck.proto", }
HealthCheckService_ServiceDesc is the grpc.ServiceDesc for HealthCheckService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterHealthCheckServiceHandler ¶
func RegisterHealthCheckServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterHealthCheckServiceHandler registers the http handlers for service HealthCheckService to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterHealthCheckServiceHandlerClient ¶
func RegisterHealthCheckServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client HealthCheckServiceClient) error
RegisterHealthCheckServiceHandlerClient registers the http handlers for service HealthCheckService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "HealthCheckServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "HealthCheckServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "HealthCheckServiceClient" to call the correct interceptors.
func RegisterHealthCheckServiceHandlerFromEndpoint ¶
func RegisterHealthCheckServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterHealthCheckServiceHandlerFromEndpoint is same as RegisterHealthCheckServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterHealthCheckServiceHandlerServer ¶
func RegisterHealthCheckServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server HealthCheckServiceServer) error
RegisterHealthCheckServiceHandlerServer registers the http handlers for service HealthCheckService to "mux". UnaryRPC :call HealthCheckServiceServer 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 RegisterHealthCheckServiceHandlerFromEndpoint instead.
func RegisterHealthCheckServiceServer ¶
func RegisterHealthCheckServiceServer(s grpc.ServiceRegistrar, srv HealthCheckServiceServer)
Types ¶
type HealthCheckServiceClient ¶
type HealthCheckServiceClient interface {
LivenessProbe(ctx context.Context, in *LivenessProbeRequest, opts ...grpc.CallOption) (*LivenessProbeResponse, error)
ReadinessProbe(ctx context.Context, in *ReadinessProbeRequest, opts ...grpc.CallOption) (*ReadinessProbeResponse, error)
StartupProbe(ctx context.Context, in *StartupProbeRequest, opts ...grpc.CallOption) (*StartupProbeResponse, error)
}
HealthCheckServiceClient is the client API for HealthCheckService 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 NewHealthCheckServiceClient ¶
func NewHealthCheckServiceClient(cc grpc.ClientConnInterface) HealthCheckServiceClient
type HealthCheckServiceServer ¶
type HealthCheckServiceServer interface {
LivenessProbe(context.Context, *LivenessProbeRequest) (*LivenessProbeResponse, error)
ReadinessProbe(context.Context, *ReadinessProbeRequest) (*ReadinessProbeResponse, error)
StartupProbe(context.Context, *StartupProbeRequest) (*StartupProbeResponse, error)
}
HealthCheckServiceServer is the server API for HealthCheckService service. All implementations should embed UnimplementedHealthCheckServiceServer for forward compatibility
type LivenessProbeRequest ¶
type LivenessProbeRequest struct {
// contains filtered or unexported fields
}
func (*LivenessProbeRequest) Descriptor
deprecated
func (*LivenessProbeRequest) Descriptor() ([]byte, []int)
Deprecated: Use LivenessProbeRequest.ProtoReflect.Descriptor instead.
func (*LivenessProbeRequest) ProtoMessage ¶
func (*LivenessProbeRequest) ProtoMessage()
func (*LivenessProbeRequest) ProtoReflect ¶
func (x *LivenessProbeRequest) ProtoReflect() protoreflect.Message
func (*LivenessProbeRequest) Reset ¶
func (x *LivenessProbeRequest) Reset()
func (*LivenessProbeRequest) String ¶
func (x *LivenessProbeRequest) String() string
type LivenessProbeResponse ¶
type LivenessProbeResponse struct {
// contains filtered or unexported fields
}
func (*LivenessProbeResponse) Descriptor
deprecated
func (*LivenessProbeResponse) Descriptor() ([]byte, []int)
Deprecated: Use LivenessProbeResponse.ProtoReflect.Descriptor instead.
func (*LivenessProbeResponse) ProtoMessage ¶
func (*LivenessProbeResponse) ProtoMessage()
func (*LivenessProbeResponse) ProtoReflect ¶
func (x *LivenessProbeResponse) ProtoReflect() protoreflect.Message
func (*LivenessProbeResponse) Reset ¶
func (x *LivenessProbeResponse) Reset()
func (*LivenessProbeResponse) String ¶
func (x *LivenessProbeResponse) String() string
type ReadinessProbeRequest ¶
type ReadinessProbeRequest struct {
// contains filtered or unexported fields
}
func (*ReadinessProbeRequest) Descriptor
deprecated
func (*ReadinessProbeRequest) Descriptor() ([]byte, []int)
Deprecated: Use ReadinessProbeRequest.ProtoReflect.Descriptor instead.
func (*ReadinessProbeRequest) ProtoMessage ¶
func (*ReadinessProbeRequest) ProtoMessage()
func (*ReadinessProbeRequest) ProtoReflect ¶
func (x *ReadinessProbeRequest) ProtoReflect() protoreflect.Message
func (*ReadinessProbeRequest) Reset ¶
func (x *ReadinessProbeRequest) Reset()
func (*ReadinessProbeRequest) String ¶
func (x *ReadinessProbeRequest) String() string
type ReadinessProbeResponse ¶
type ReadinessProbeResponse struct {
// contains filtered or unexported fields
}
func (*ReadinessProbeResponse) Descriptor
deprecated
func (*ReadinessProbeResponse) Descriptor() ([]byte, []int)
Deprecated: Use ReadinessProbeResponse.ProtoReflect.Descriptor instead.
func (*ReadinessProbeResponse) ProtoMessage ¶
func (*ReadinessProbeResponse) ProtoMessage()
func (*ReadinessProbeResponse) ProtoReflect ¶
func (x *ReadinessProbeResponse) ProtoReflect() protoreflect.Message
func (*ReadinessProbeResponse) Reset ¶
func (x *ReadinessProbeResponse) Reset()
func (*ReadinessProbeResponse) String ¶
func (x *ReadinessProbeResponse) String() string
type StartupProbeRequest ¶
type StartupProbeRequest struct {
// contains filtered or unexported fields
}
func (*StartupProbeRequest) Descriptor
deprecated
func (*StartupProbeRequest) Descriptor() ([]byte, []int)
Deprecated: Use StartupProbeRequest.ProtoReflect.Descriptor instead.
func (*StartupProbeRequest) ProtoMessage ¶
func (*StartupProbeRequest) ProtoMessage()
func (*StartupProbeRequest) ProtoReflect ¶
func (x *StartupProbeRequest) ProtoReflect() protoreflect.Message
func (*StartupProbeRequest) Reset ¶
func (x *StartupProbeRequest) Reset()
func (*StartupProbeRequest) String ¶
func (x *StartupProbeRequest) String() string
type StartupProbeResponse ¶
type StartupProbeResponse struct {
// contains filtered or unexported fields
}
func (*StartupProbeResponse) Descriptor
deprecated
func (*StartupProbeResponse) Descriptor() ([]byte, []int)
Deprecated: Use StartupProbeResponse.ProtoReflect.Descriptor instead.
func (*StartupProbeResponse) ProtoMessage ¶
func (*StartupProbeResponse) ProtoMessage()
func (*StartupProbeResponse) ProtoReflect ¶
func (x *StartupProbeResponse) ProtoReflect() protoreflect.Message
func (*StartupProbeResponse) Reset ¶
func (x *StartupProbeResponse) Reset()
func (*StartupProbeResponse) String ¶
func (x *StartupProbeResponse) String() string
type UnimplementedHealthCheckServiceServer ¶
type UnimplementedHealthCheckServiceServer struct {
}
UnimplementedHealthCheckServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedHealthCheckServiceServer) LivenessProbe ¶
func (UnimplementedHealthCheckServiceServer) LivenessProbe(context.Context, *LivenessProbeRequest) (*LivenessProbeResponse, error)
func (UnimplementedHealthCheckServiceServer) ReadinessProbe ¶
func (UnimplementedHealthCheckServiceServer) ReadinessProbe(context.Context, *ReadinessProbeRequest) (*ReadinessProbeResponse, error)
func (UnimplementedHealthCheckServiceServer) StartupProbe ¶
func (UnimplementedHealthCheckServiceServer) StartupProbe(context.Context, *StartupProbeRequest) (*StartupProbeResponse, error)
type UnsafeHealthCheckServiceServer ¶
type UnsafeHealthCheckServiceServer interface {
// contains filtered or unexported methods
}
UnsafeHealthCheckServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to HealthCheckServiceServer will result in compilation errors.
Source Files