Documentation
¶
Index ¶
- Constants
- Variables
- func RegisterHealthServiceServer(s grpc.ServiceRegistrar, srv HealthServiceServer)
- type HealthCheckRequest
- type HealthCheckResponse
- func (*HealthCheckResponse) Descriptor() ([]byte, []int)deprecated
- func (x *HealthCheckResponse) GetMessage() string
- func (x *HealthCheckResponse) GetStatus() HealthCheckResponse_ServingStatus
- func (x *HealthCheckResponse) GetVersion() string
- 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)deprecated
- func (x HealthCheckResponse_ServingStatus) Number() protoreflect.EnumNumber
- func (x HealthCheckResponse_ServingStatus) String() string
- func (HealthCheckResponse_ServingStatus) Type() protoreflect.EnumType
- type HealthServiceClient
- type HealthServiceServer
- type UnimplementedHealthServiceServer
- type UnsafeHealthServiceServer
Constants ¶
const (
HealthService_Check_FullMethodName = "/cloudstack.core.v1.HealthService/Check"
)
Variables ¶
var ( HealthCheckResponse_ServingStatus_name = map[int32]string{ 0: "SERVING_STATUS_UNSPECIFIED", 1: "SERVING_STATUS_SERVING", 2: "SERVING_STATUS_NOT_SERVING", 3: "SERVING_STATUS_UNKNOWN", } HealthCheckResponse_ServingStatus_value = map[string]int32{ "SERVING_STATUS_UNSPECIFIED": 0, "SERVING_STATUS_SERVING": 1, "SERVING_STATUS_NOT_SERVING": 2, "SERVING_STATUS_UNKNOWN": 3, } )
Enum value maps for HealthCheckResponse_ServingStatus.
var File_cloudstack_common_core_v1_health_proto protoreflect.FileDescriptor
var HealthService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "cloudstack.core.v1.HealthService", HandlerType: (*HealthServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "Check", Handler: _HealthService_Check_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "cloudstack/common/core/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 HealthCheckRequest ¶
type HealthCheckRequest struct {
// contains filtered or unexported fields
}
HealthCheckRequest is the request message for the health check
func (*HealthCheckRequest) Descriptor
deprecated
func (*HealthCheckRequest) Descriptor() ([]byte, []int)
Deprecated: Use HealthCheckRequest.ProtoReflect.Descriptor instead.
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 is the current health status of the service Status HealthCheckResponse_ServingStatus `protobuf:"varint,1,opt,name=status,proto3,enum=cloudstack.core.v1.HealthCheckResponse_ServingStatus" json:"status,omitempty"` // Version is the current version of the service Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"` // Message provides additional information about the service status Message string `protobuf:"bytes,3,opt,name=message,proto3" json:"message,omitempty"` // contains filtered or unexported fields }
HealthCheckResponse is the response message for the health check
func (*HealthCheckResponse) Descriptor
deprecated
func (*HealthCheckResponse) Descriptor() ([]byte, []int)
Deprecated: Use HealthCheckResponse.ProtoReflect.Descriptor instead.
func (*HealthCheckResponse) GetMessage ¶
func (x *HealthCheckResponse) GetMessage() string
func (*HealthCheckResponse) GetStatus ¶
func (x *HealthCheckResponse) GetStatus() HealthCheckResponse_ServingStatus
func (*HealthCheckResponse) GetVersion ¶
func (x *HealthCheckResponse) GetVersion() string
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
Status of the service
const ( HealthCheckResponse_SERVING_STATUS_UNSPECIFIED HealthCheckResponse_ServingStatus = 0 HealthCheckResponse_SERVING_STATUS_SERVING HealthCheckResponse_ServingStatus = 1 HealthCheckResponse_SERVING_STATUS_NOT_SERVING HealthCheckResponse_ServingStatus = 2 HealthCheckResponse_SERVING_STATUS_UNKNOWN HealthCheckResponse_ServingStatus = 3 )
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
deprecated
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 HealthServiceClient ¶
type HealthServiceClient interface { // Check returns the current health status of the service Check(ctx context.Context, in *HealthCheckRequest, opts ...grpc.CallOption) (*HealthCheckResponse, 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.
HealthService provides health check functionality
func NewHealthServiceClient ¶
func NewHealthServiceClient(cc grpc.ClientConnInterface) HealthServiceClient
type HealthServiceServer ¶
type HealthServiceServer interface { // Check returns the current health status of the service Check(context.Context, *HealthCheckRequest) (*HealthCheckResponse, error) // contains filtered or unexported methods }
HealthServiceServer is the server API for HealthService service. All implementations must embed UnimplementedHealthServiceServer for forward compatibility.
HealthService provides health check functionality
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, *HealthCheckRequest) (*HealthCheckResponse, 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.