health

package
v1.2.6 Latest Latest
Warning

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

 Go to latest Published: Oct 18, 2024 License: Apache-2.0 Imports: 8 Imported by: 2

Documentation

Index

Constants

View Source 
const (
	HealthService_Check_FullMethodName    = "/health.v1.HealthService/Check"
	HealthService_CheckAll_FullMethodName = "/health.v1.HealthService/CheckAll"
)

Variables

View Source 
var (
	CheckResponse_ServingStatus_name = map[int32]string{
		0: "SERVING_STATUS_UNSPECIFIED",
		1: "SERVING_STATUS_UNKNOWN",
		2: "SERVING_STATUS_SERVING",
		3: "SERVING_STATUS_NOT_SERVING",
		4: "SERVING_STATUS_SERVICE_UNKNOWN",
		5: "SERVING_STATUS_INTERNAL_ERROR",
	}
	CheckResponse_ServingStatus_value = map[string]int32{
		"SERVING_STATUS_UNSPECIFIED":     0,
		"SERVING_STATUS_UNKNOWN":         1,
		"SERVING_STATUS_SERVING":         2,
		"SERVING_STATUS_NOT_SERVING":     3,
		"SERVING_STATUS_SERVICE_UNKNOWN": 4,
		"SERVING_STATUS_INTERNAL_ERROR":  5,
	}
)

Enum value maps for CheckResponse_ServingStatus.

View Source 
var File_health_v1_health_proto protoreflect.FileDescriptor
View Source 
var HealthService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "health.v1.HealthService",
	HandlerType: (*HealthServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Check",
			Handler:    _HealthService_Check_Handler,
		},
		{
			MethodName: "CheckAll",
			Handler:    _HealthService_CheckAll_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "health/v1/health.proto",
}

HealthService_ServiceDesc is the grpc.ServiceDesc for HealthService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterHealthServiceServer 

func RegisterHealthServiceServer(s grpc.ServiceRegistrar, srv HealthServiceServer)

Types

type CheckAllRequest 

type CheckAllRequest struct {
	Offset int32 `protobuf:"varint,1,opt,name=offset,proto3" json:"offset,omitempty"`
	// contains filtered or unexported fields
}

func (*CheckAllRequest) Descriptor deprecated 

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

Deprecated: Use CheckAllRequest.ProtoReflect.Descriptor instead.

func (*CheckAllRequest) GetOffset 

func (x *CheckAllRequest) GetOffset() int32

func (*CheckAllRequest) ProtoMessage 

func (*CheckAllRequest) ProtoMessage()

func (*CheckAllRequest) ProtoReflect 

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

func (*CheckAllRequest) Reset 

func (x *CheckAllRequest) Reset()

func (*CheckAllRequest) String 

func (x *CheckAllRequest) String() string

type CheckAllResponse 

type CheckAllResponse struct {
	Results []*CheckResponse `protobuf:"bytes,1,rep,name=results,proto3" json:"results,omitempty"`
	// contains filtered or unexported fields
}

func (*CheckAllResponse) Descriptor deprecated 

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

Deprecated: Use CheckAllResponse.ProtoReflect.Descriptor instead.

func (*CheckAllResponse) GetResults 

func (x *CheckAllResponse) GetResults() []*CheckResponse

func (*CheckAllResponse) ProtoMessage 

func (*CheckAllResponse) ProtoMessage()

func (*CheckAllResponse) ProtoReflect 

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

func (*CheckAllResponse) Reset 

func (x *CheckAllResponse) Reset()

func (*CheckAllResponse) String 

func (x *CheckAllResponse) String() string

type CheckRequest 

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

func (*CheckRequest) Descriptor deprecated 

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

Deprecated: Use CheckRequest.ProtoReflect.Descriptor instead.

func (*CheckRequest) GetService 

func (x *CheckRequest) GetService() string

func (*CheckRequest) ProtoMessage 

func (*CheckRequest) ProtoMessage()

func (*CheckRequest) ProtoReflect 

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

func (*CheckRequest) Reset 

func (x *CheckRequest) Reset()

func (*CheckRequest) String 

func (x *CheckRequest) String() string

type CheckResponse 

type CheckResponse struct {
	Name   string                      `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Status CheckResponse_ServingStatus `protobuf:"varint,2,opt,name=status,proto3,enum=health.v1.CheckResponse_ServingStatus" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*CheckResponse) Descriptor deprecated 

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

Deprecated: Use CheckResponse.ProtoReflect.Descriptor instead.

func (*CheckResponse) GetName 

func (x *CheckResponse) GetName() string

func (*CheckResponse) GetStatus 

func (x *CheckResponse) GetStatus() CheckResponse_ServingStatus

func (*CheckResponse) ProtoMessage 

func (*CheckResponse) ProtoMessage()

func (*CheckResponse) ProtoReflect 

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

func (*CheckResponse) Reset 

func (x *CheckResponse) Reset()

func (*CheckResponse) String 

func (x *CheckResponse) String() string

type CheckResponse_ServingStatus 

type CheckResponse_ServingStatus int32
const (
	CheckResponse_SERVING_STATUS_UNSPECIFIED     CheckResponse_ServingStatus = 0
	CheckResponse_SERVING_STATUS_UNKNOWN         CheckResponse_ServingStatus = 1
	CheckResponse_SERVING_STATUS_SERVING         CheckResponse_ServingStatus = 2
	CheckResponse_SERVING_STATUS_NOT_SERVING     CheckResponse_ServingStatus = 3
	CheckResponse_SERVING_STATUS_SERVICE_UNKNOWN CheckResponse_ServingStatus = 4
	CheckResponse_SERVING_STATUS_INTERNAL_ERROR  CheckResponse_ServingStatus = 5
)

func (CheckResponse_ServingStatus) Descriptor 

func (CheckResponse_ServingStatus) Descriptor() protoreflect.EnumDescriptor

func (CheckResponse_ServingStatus) Enum 

func (x CheckResponse_ServingStatus) Enum() *CheckResponse_ServingStatus

func (CheckResponse_ServingStatus) EnumDescriptor deprecated 

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

Deprecated: Use CheckResponse_ServingStatus.Descriptor instead.

func (CheckResponse_ServingStatus) Number 

func (x CheckResponse_ServingStatus) Number() protoreflect.EnumNumber

func (CheckResponse_ServingStatus) String 

func (x CheckResponse_ServingStatus) String() string

func (CheckResponse_ServingStatus) Type 

func (CheckResponse_ServingStatus) Type() protoreflect.EnumType

type HealthServiceClient 

type HealthServiceClient interface {
	// Check gets the health of the specified service.
	Check(ctx context.Context, in *CheckRequest, opts ...grpc.CallOption) (*CheckResponse, error)
	// CheckAll gets the health of all services.
	CheckAll(ctx context.Context, in *CheckAllRequest, opts ...grpc.CallOption) (*CheckAllResponse, error)
}

HealthServiceClient is the client API for HealthService 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 NewHealthServiceClient 

func NewHealthServiceClient(cc grpc.ClientConnInterface) HealthServiceClient

type HealthServiceServer 

type HealthServiceServer interface {
	// Check gets the health of the specified service.
	Check(context.Context, *CheckRequest) (*CheckResponse, error)
	// CheckAll gets the health of all services.
	CheckAll(context.Context, *CheckAllRequest) (*CheckAllResponse, error)
	// contains filtered or unexported methods
}

HealthServiceServer is the server API for HealthService service. All implementations must embed UnimplementedHealthServiceServer for forward compatibility.

type UnimplementedHealthServiceServer 

type UnimplementedHealthServiceServer struct{}

UnimplementedHealthServiceServer 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 (UnimplementedHealthServiceServer) Check 

func (UnimplementedHealthServiceServer) Check(context.Context, *CheckRequest) (*CheckResponse, error)

func (UnimplementedHealthServiceServer) CheckAll 

func (UnimplementedHealthServiceServer) CheckAll(context.Context, *CheckAllRequest) (*CheckAllResponse, error)

type UnsafeHealthServiceServer 

type UnsafeHealthServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeHealthServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to HealthServiceServer will result in compilation errors.

Source Files

View all Source files

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.