health

Documentation

Index

• Variables
• func RegisterHealthServer(s grpc.ServiceRegistrar, srv HealthServer)
• type HealthCheckRequest
  • func (*HealthCheckRequest) Descriptor() ([]byte, []int)
  • func (x *HealthCheckRequest) GetService() string
  • func (*HealthCheckRequest) ProtoMessage()
  • func (x *HealthCheckRequest) ProtoReflect() protoreflect.Message
  • func (x *HealthCheckRequest) Reset()
  • func (x *HealthCheckRequest) String() string
• type HealthCheckResponse
  • func (*HealthCheckResponse) Descriptor() ([]byte, []int)
  • func (x *HealthCheckResponse) GetStatus() HealthCheckResponse_ServingStatus
  • func (*HealthCheckResponse) ProtoMessage()
  • func (x *HealthCheckResponse) ProtoReflect() protoreflect.Message
  • func (x *HealthCheckResponse) Reset()
  • func (x *HealthCheckResponse) String() string
• type HealthCheckResponse_ServingStatus
  • func (HealthCheckResponse_ServingStatus) Descriptor() protoreflect.EnumDescriptor
  • func (x HealthCheckResponse_ServingStatus) Enum() *HealthCheckResponse_ServingStatus
  • func (HealthCheckResponse_ServingStatus) EnumDescriptor() ([]byte, []int)
  • func (x HealthCheckResponse_ServingStatus) Number() protoreflect.EnumNumber
  • func (x HealthCheckResponse_ServingStatus) String() string
  • func (HealthCheckResponse_ServingStatus) Type() protoreflect.EnumType
• type HealthClient
  • func NewHealthClient(cc grpc.ClientConnInterface) HealthClient
• type HealthServer
• type Health_WatchClient
• type Health_WatchServer
• type UnimplementedHealthServer
  • func (UnimplementedHealthServer) Check(context.Context, *HealthCheckRequest) (*HealthCheckResponse, error)
  • func (UnimplementedHealthServer) Watch(*HealthCheckRequest, Health_WatchServer) error
• type UnsafeHealthServer

Variables

var (
	HealthCheckResponse_ServingStatus_name = map[int32]string{
		0: "UNKNOWN",
		1: "SERVING",
		2: "NOT_SERVING",
		3: "SERVICE_UNKNOWN",
	}
	HealthCheckResponse_ServingStatus_value = map[string]int32{
		"UNKNOWN":         0,
		"SERVING":         1,
		"NOT_SERVING":     2,
		"SERVICE_UNKNOWN": 3,
	}
)

Enum value maps for HealthCheckResponse_ServingStatus.

var File_pkg_health_proto_proto protoreflect.FileDescriptor

var Health_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "grpc.health.v1.Health",
	HandlerType: (*HealthServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Check",
			Handler:    _Health_Check_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "Watch",
			Handler:       _Health_Watch_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "pkg/health/proto.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 RegisterHealthServer

func RegisterHealthServer(s grpc.ServiceRegistrar, srv HealthServer)

Types

type HealthCheckRequest

type HealthCheckRequest struct {
	Service string `protobuf:"bytes,1,opt,name=service,proto3" json:"service,omitempty"`
	// contains filtered or unexported fields
}

func (*HealthCheckRequest) Descriptor

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

Deprecated: Use HealthCheckRequest.ProtoReflect.Descriptor instead.

func (*HealthCheckRequest) GetService

func (x *HealthCheckRequest) GetService() string

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 HealthCheckResponse

type HealthCheckResponse struct {
	Status HealthCheckResponse_ServingStatus `protobuf:"varint,1,opt,name=status,proto3,enum=grpc.health.v1.HealthCheckResponse_ServingStatus" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*HealthCheckResponse) Descriptor

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

Deprecated: Use HealthCheckResponse.ProtoReflect.Descriptor instead.

func (*HealthCheckResponse) GetStatus

func (x *HealthCheckResponse) GetStatus() HealthCheckResponse_ServingStatus

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 HealthCheckResponse_ServingStatus

type HealthCheckResponse_ServingStatus int32

const (
	HealthCheckResponse_UNKNOWN         HealthCheckResponse_ServingStatus = 0
	HealthCheckResponse_SERVING         HealthCheckResponse_ServingStatus = 1
	HealthCheckResponse_NOT_SERVING     HealthCheckResponse_ServingStatus = 2
	HealthCheckResponse_SERVICE_UNKNOWN HealthCheckResponse_ServingStatus = 3 // Used only by the Watch method.
)

func (HealthCheckResponse_ServingStatus) Descriptor

func (HealthCheckResponse_ServingStatus) Descriptor() protoreflect.EnumDescriptor

func (HealthCheckResponse_ServingStatus) Enum

func (x HealthCheckResponse_ServingStatus) Enum() *HealthCheckResponse_ServingStatus

func (HealthCheckResponse_ServingStatus) EnumDescriptor

func (HealthCheckResponse_ServingStatus) EnumDescriptor() ([]byte, []int)

Deprecated: Use HealthCheckResponse_ServingStatus.Descriptor instead.

func (HealthCheckResponse_ServingStatus) Number

func (x HealthCheckResponse_ServingStatus) Number() protoreflect.EnumNumber

func (HealthCheckResponse_ServingStatus) String

func (x HealthCheckResponse_ServingStatus) String() string

func (HealthCheckResponse_ServingStatus) Type

func (HealthCheckResponse_ServingStatus) Type() protoreflect.EnumType

type HealthClient

type HealthClient interface {
	Check(ctx context.Context, in *HealthCheckRequest, opts ...grpc.CallOption) (*HealthCheckResponse, error)
	Watch(ctx context.Context, in *HealthCheckRequest, opts ...grpc.CallOption) (Health_WatchClient, 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)
	Watch(*HealthCheckRequest, Health_WatchServer) error
	// contains filtered or unexported methods
}

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

type Health_WatchClient

type Health_WatchClient interface {
	Recv() (*HealthCheckResponse, error)
	grpc.ClientStream
}

type Health_WatchServer

type Health_WatchServer interface {
	Send(*HealthCheckResponse) error
	grpc.ServerStream
}

type UnimplementedHealthServer

type UnimplementedHealthServer struct {
}

UnimplementedHealthServer must be embedded to have forward compatible implementations.

func (UnimplementedHealthServer) Check

func (UnimplementedHealthServer) Check(context.Context, *HealthCheckRequest) (*HealthCheckResponse, error)

func (UnimplementedHealthServer) Watch

func (UnimplementedHealthServer) Watch(*HealthCheckRequest, Health_WatchServer) 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.