health

package
v0.0.0-...-4834045 Latest Latest
Warning

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

 Go to latest Published: Jul 15, 2024 License: MIT Imports: 18 Imported by: 0

Documentation

Overview

Package health ヘルスチェックリクエスト

Package health ヘルスチェックレスポンス

Package health is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source 
const (
	Health_Check_FullMethodName = "/api.admin.Health/Check"
)

Variables

View Source 
var File_health_health_check_request_proto protoreflect.FileDescriptor
View Source 
var File_health_health_check_response_proto protoreflect.FileDescriptor
View Source 
var File_health_health_handler_proto protoreflect.FileDescriptor
View Source 
var Health_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "api.admin.Health",
	HandlerType: (*HealthServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Check",
			Handler:    _Health_Check_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "health/health_handler.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)

Functions

func RegisterHealthHandler 

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

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)

Types

type HealthCheckRequest 

type HealthCheckRequest struct {
	HealthId int64 `protobuf:"varint,1,opt,name=health_id,json=healthId,proto3" json:"health_id,omitempty"`
	// contains filtered or unexported fields
}

func NewHealthCheckRequest 

func NewHealthCheckRequest() *HealthCheckRequest

func SetHealthCheckRequest 

func SetHealthCheckRequest(healthId int64) *HealthCheckRequest

func (*HealthCheckRequest) Descriptor deprecated 

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

Deprecated: Use HealthCheckRequest.ProtoReflect.Descriptor instead.

func (*HealthCheckRequest) GetHealthId 

func (x *HealthCheckRequest) GetHealthId() int64

func (*HealthCheckRequest) ProtoMessage 

func (*HealthCheckRequest) ProtoMessage()

func (*HealthCheckRequest) ProtoReflect 

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

func (*HealthCheckRequest) Reset 

func (x *HealthCheckRequest) Reset()

func (*HealthCheckRequest) String 

func (x *HealthCheckRequest) String() string

type HealthCheckRequests 

type HealthCheckRequests []*HealthCheckRequest

func NewHealthCheckRequests 

func NewHealthCheckRequests() HealthCheckRequests

type HealthCheckResponse 

type HealthCheckResponse struct {
	AdminHealth  *adminHealth.AdminHealth   `protobuf:"bytes,1,opt,name=admin_health,json=adminHealth,proto3,oneof" json:"admin_health,omitempty"`
	CommonHealth *commonHealth.CommonHealth `protobuf:"bytes,2,opt,name=common_health,json=commonHealth,proto3,oneof" json:"common_health,omitempty"`
	MasterHealth *masterHealth.MasterHealth `protobuf:"bytes,3,opt,name=master_health,json=masterHealth,proto3,oneof" json:"master_health,omitempty"`
	// contains filtered or unexported fields
}

func NewHealthCheckResponse 

func NewHealthCheckResponse() *HealthCheckResponse

func SetHealthCheckResponse 

func SetHealthCheckResponse(adminHealth *adminHealth.AdminHealth, commonHealth *commonHealth.CommonHealth, masterHealth *masterHealth.MasterHealth) *HealthCheckResponse

func (*HealthCheckResponse) Descriptor deprecated 

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

Deprecated: Use HealthCheckResponse.ProtoReflect.Descriptor instead.

func (*HealthCheckResponse) GetAdminHealth 

func (x *HealthCheckResponse) GetAdminHealth() *adminHealth.AdminHealth

func (*HealthCheckResponse) GetCommonHealth 

func (x *HealthCheckResponse) GetCommonHealth() *commonHealth.CommonHealth

func (*HealthCheckResponse) GetMasterHealth 

func (x *HealthCheckResponse) GetMasterHealth() *masterHealth.MasterHealth

func (*HealthCheckResponse) ProtoMessage 

func (*HealthCheckResponse) ProtoMessage()

func (*HealthCheckResponse) ProtoReflect 

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

func (*HealthCheckResponse) Reset 

func (x *HealthCheckResponse) Reset()

func (*HealthCheckResponse) String 

func (x *HealthCheckResponse) String() string

type HealthCheckResponses 

type HealthCheckResponses []*HealthCheckResponse

func NewHealthCheckResponses 

func NewHealthCheckResponses() HealthCheckResponses

type HealthClient 

type HealthClient interface {
	Check(ctx context.Context, in *HealthCheckRequest, opts ...grpc.CallOption) (*HealthCheckResponse, 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 HealthServer 

type HealthServer interface {
	Check(context.Context, *HealthCheckRequest) (*HealthCheckResponse, error)
}

HealthServer is the server API for Health service. All implementations should embed UnimplementedHealthServer for forward compatibility

type UnimplementedHealthServer 

type UnimplementedHealthServer struct {
}

UnimplementedHealthServer should be embedded to have forward compatible implementations.

func (UnimplementedHealthServer) Check 

func (UnimplementedHealthServer) Check(context.Context, *HealthCheckRequest) (*HealthCheckResponse, 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.

Source Files

View all Source files

Directories

Path Synopsis
Package adminHealth ヘルスチェック
 Package adminHealth ヘルスチェック
Package commonHealth ヘルスチェック
 Package commonHealth ヘルスチェック
Package masterHealth ヘルスチェック
 Package masterHealth ヘルスチェック

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.