package grpc_health_v1

Import Path
	google.golang.org/grpc/health/grpc_health_v1 (on go.dev)

Dependency Relation
	imports 9 packages, and imported by one package

Involved Source Files

	    health.pb.go
	    health_grpc.pb.go
Package-Level Type Names (total 12, in which 11 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Health_WatchClient = (interface)
		This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

	 type Health_WatchServer = (interface)
		This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

	 type HealthCheckRequest (struct)

		Fields (total 4, in which 1 is exported)
			Service string
			/* 3 unexporteds ... *//* 3 unexporteds: */
			sizeCache protoimpl.SizeCache
			state protoimpl.MessageState
			unknownFields protoimpl.UnknownFields
		Methods (total 6, all are exported)
			(*HealthCheckRequest) Descriptor() ([]byte, []int)
				Deprecated: Use HealthCheckRequest.ProtoReflect.Descriptor instead.

			(*HealthCheckRequest) GetService() string
			(*HealthCheckRequest) ProtoMessage()
			(*HealthCheckRequest) ProtoReflect() protoreflect.Message
			(*HealthCheckRequest) Reset()
			(*HealthCheckRequest) String() string
		Implements (at least 7, in which 4 are exported)
			*HealthCheckRequest : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*HealthCheckRequest : google.golang.org/protobuf/runtime/protoiface.MessageV1
			*HealthCheckRequest : expvar.Var
			*HealthCheckRequest : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*HealthCheckRequest : google.golang.org/protobuf/internal/impl.messageV1
			*HealthCheckRequest : context.stringer
			*HealthCheckRequest : runtime.stringer
		As Inputs Of (at least 8, all are exported)
			func HealthClient.Check(ctx context.Context, in *HealthCheckRequest, opts ...grpc.CallOption) (*HealthCheckResponse, error)
			func HealthClient.Watch(ctx context.Context, in *HealthCheckRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[HealthCheckResponse], error)
			func HealthServer.Check(context.Context, *HealthCheckRequest) (*HealthCheckResponse, error)
			func HealthServer.Watch(*HealthCheckRequest, grpc.ServerStreamingServer[HealthCheckResponse]) error
			func UnimplementedHealthServer.Check(context.Context, *HealthCheckRequest) (*HealthCheckResponse, error)
			func UnimplementedHealthServer.Watch(*HealthCheckRequest, grpc.ServerStreamingServer[HealthCheckResponse]) error
			func google.golang.org/grpc/health.(*Server).Check(_ context.Context, in *HealthCheckRequest) (*HealthCheckResponse, error)
			func google.golang.org/grpc/health.(*Server).Watch(in *HealthCheckRequest, stream Health_WatchServer) error

	 type HealthCheckResponse (struct)

		Fields (total 4, in which 1 is exported)
			Status HealthCheckResponse_ServingStatus
			/* 3 unexporteds ... *//* 3 unexporteds: */
			sizeCache protoimpl.SizeCache
			state protoimpl.MessageState
			unknownFields protoimpl.UnknownFields
		Methods (total 6, all are exported)
			(*HealthCheckResponse) Descriptor() ([]byte, []int)
				Deprecated: Use HealthCheckResponse.ProtoReflect.Descriptor instead.

			(*HealthCheckResponse) GetStatus() HealthCheckResponse_ServingStatus
			(*HealthCheckResponse) ProtoMessage()
			(*HealthCheckResponse) ProtoReflect() protoreflect.Message
			(*HealthCheckResponse) Reset()
			(*HealthCheckResponse) String() string
		Implements (at least 7, in which 4 are exported)
			*HealthCheckResponse : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*HealthCheckResponse : google.golang.org/protobuf/runtime/protoiface.MessageV1
			*HealthCheckResponse : expvar.Var
			*HealthCheckResponse : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*HealthCheckResponse : google.golang.org/protobuf/internal/impl.messageV1
			*HealthCheckResponse : context.stringer
			*HealthCheckResponse : runtime.stringer
		As Outputs Of (at least 5, all are exported)
			func HealthClient.Check(ctx context.Context, in *HealthCheckRequest, opts ...grpc.CallOption) (*HealthCheckResponse, error)
			func (*HealthListResponse).GetStatuses() map[string]*HealthCheckResponse
			func HealthServer.Check(context.Context, *HealthCheckRequest) (*HealthCheckResponse, error)
			func UnimplementedHealthServer.Check(context.Context, *HealthCheckRequest) (*HealthCheckResponse, error)
			func google.golang.org/grpc/health.(*Server).Check(_ context.Context, in *HealthCheckRequest) (*HealthCheckResponse, error)

	 type HealthCheckResponse_ServingStatus int32 (basic type)

		Methods (total 6, all are exported)
			( HealthCheckResponse_ServingStatus) Descriptor() protoreflect.EnumDescriptor
			( HealthCheckResponse_ServingStatus) Enum() *HealthCheckResponse_ServingStatus
			( HealthCheckResponse_ServingStatus) EnumDescriptor() ([]byte, []int)
				Deprecated: Use HealthCheckResponse_ServingStatus.Descriptor instead.

			( HealthCheckResponse_ServingStatus) Number() protoreflect.EnumNumber
			( HealthCheckResponse_ServingStatus) String() string
			( HealthCheckResponse_ServingStatus) Type() protoreflect.EnumType
		Implements (at least 6, in which 3 are exported)
			 HealthCheckResponse_ServingStatus : google.golang.org/protobuf/reflect/protoreflect.Enum
			 HealthCheckResponse_ServingStatus : expvar.Var
			 HealthCheckResponse_ServingStatus : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			 HealthCheckResponse_ServingStatus : google.golang.org/protobuf/internal/impl.enumV1
			 HealthCheckResponse_ServingStatus : context.stringer
			 HealthCheckResponse_ServingStatus : runtime.stringer
		As Outputs Of (at least 2, both are exported)
			func (*HealthCheckResponse).GetStatus() HealthCheckResponse_ServingStatus
			func HealthCheckResponse_ServingStatus.Enum() *HealthCheckResponse_ServingStatus
		As Inputs Of (at least 2, in which 1 is exported)
			func google.golang.org/grpc/health.(*Server).SetServingStatus(service string, servingStatus HealthCheckResponse_ServingStatus)
			/* at least one unexported ... *//* at least one unexported: */
			func google.golang.org/grpc/health.(*Server).setServingStatusLocked(service string, servingStatus HealthCheckResponse_ServingStatus)
		As Types Of (total 4, all are exported)
			const HealthCheckResponse_NOT_SERVING
			const HealthCheckResponse_SERVICE_UNKNOWN
			const HealthCheckResponse_SERVING
			const HealthCheckResponse_UNKNOWN

	 type HealthClient (interface)
		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.
		
		Health is gRPC's mechanism for checking whether a server is able to handle
		RPCs. Its semantics are documented in
		https://github.com/grpc/grpc/blob/master/doc/health-checking.md.

		Methods (total 3, all are exported)
			( HealthClient) Check(ctx context.Context, in *HealthCheckRequest, opts ...grpc.CallOption) (*HealthCheckResponse, error)
				Check gets the health of the specified service. If the requested service
				is unknown, the call will fail with status NOT_FOUND. If the caller does
				not specify a service name, the server should respond with its overall
				health status.
				
				Clients should set a deadline when calling Check, and can declare the
				server unhealthy if they do not receive a timely response.

			( HealthClient) List(ctx context.Context, in *HealthListRequest, opts ...grpc.CallOption) (*HealthListResponse, error)
				List provides a non-atomic snapshot of the health of all the available
				services.
				
				The server may respond with a RESOURCE_EXHAUSTED error if too many services
				exist.
				
				Clients should set a deadline when calling List, and can declare the server
				unhealthy if they do not receive a timely response.
				
				Clients should keep in mind that the list of health services exposed by an
				application can change over the lifetime of the process.

			( HealthClient) Watch(ctx context.Context, in *HealthCheckRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[HealthCheckResponse], error)
				Performs a watch for the serving status of the requested service.
				The server will immediately send back a message indicating the current
				serving status.  It will then subsequently send a new message whenever
				the service's serving status changes.
				
				If the requested service is unknown when the call is received, the
				server will send a message setting the serving status to
				SERVICE_UNKNOWN but will *not* terminate the call.  If at some
				future point, the serving status of the service becomes known, the
				server will send a new message with the service's serving status.
				
				If the call terminates with status UNIMPLEMENTED, then clients
				should assume this method is not supported and should not retry the
				call.  If the call terminates with any other status (including OK),
				clients should retry the call with appropriate exponential backoff.

		Implemented By (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			*healthClient
		As Outputs Of (at least one exported)
			func NewHealthClient(cc grpc.ClientConnInterface) HealthClient

	 type HealthListRequest (struct)

		Fields (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			sizeCache protoimpl.SizeCache
			state protoimpl.MessageState
			unknownFields protoimpl.UnknownFields
		Methods (total 5, all are exported)
			(*HealthListRequest) Descriptor() ([]byte, []int)
				Deprecated: Use HealthListRequest.ProtoReflect.Descriptor instead.

			(*HealthListRequest) ProtoMessage()
			(*HealthListRequest) ProtoReflect() protoreflect.Message
			(*HealthListRequest) Reset()
			(*HealthListRequest) String() string
		Implements (at least 7, in which 4 are exported)
			*HealthListRequest : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*HealthListRequest : google.golang.org/protobuf/runtime/protoiface.MessageV1
			*HealthListRequest : expvar.Var
			*HealthListRequest : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*HealthListRequest : google.golang.org/protobuf/internal/impl.messageV1
			*HealthListRequest : context.stringer
			*HealthListRequest : runtime.stringer
		As Inputs Of (at least 4, all are exported)
			func HealthClient.List(ctx context.Context, in *HealthListRequest, opts ...grpc.CallOption) (*HealthListResponse, error)
			func HealthServer.List(context.Context, *HealthListRequest) (*HealthListResponse, error)
			func UnimplementedHealthServer.List(context.Context, *HealthListRequest) (*HealthListResponse, error)
			func google.golang.org/grpc/health.(*Server).List(_ context.Context, _ *HealthListRequest) (*HealthListResponse, error)

	 type HealthListResponse (struct)

		Fields (total 4, in which 1 is exported)
			Statuses map[string]*HealthCheckResponse
				statuses contains all the services and their respective status.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			sizeCache protoimpl.SizeCache
			state protoimpl.MessageState
			unknownFields protoimpl.UnknownFields
		Methods (total 6, all are exported)
			(*HealthListResponse) Descriptor() ([]byte, []int)
				Deprecated: Use HealthListResponse.ProtoReflect.Descriptor instead.

			(*HealthListResponse) GetStatuses() map[string]*HealthCheckResponse
			(*HealthListResponse) ProtoMessage()
			(*HealthListResponse) ProtoReflect() protoreflect.Message
			(*HealthListResponse) Reset()
			(*HealthListResponse) String() string
		Implements (at least 7, in which 4 are exported)
			*HealthListResponse : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*HealthListResponse : google.golang.org/protobuf/runtime/protoiface.MessageV1
			*HealthListResponse : expvar.Var
			*HealthListResponse : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*HealthListResponse : google.golang.org/protobuf/internal/impl.messageV1
			*HealthListResponse : context.stringer
			*HealthListResponse : runtime.stringer
		As Outputs Of (at least 4, all are exported)
			func HealthClient.List(ctx context.Context, in *HealthListRequest, opts ...grpc.CallOption) (*HealthListResponse, error)
			func HealthServer.List(context.Context, *HealthListRequest) (*HealthListResponse, error)
			func UnimplementedHealthServer.List(context.Context, *HealthListRequest) (*HealthListResponse, error)
			func google.golang.org/grpc/health.(*Server).List(_ context.Context, _ *HealthListRequest) (*HealthListResponse, error)

	 type HealthServer (interface)
		HealthServer is the server API for Health service.
		All implementations should embed UnimplementedHealthServer
		for forward compatibility.
		
		Health is gRPC's mechanism for checking whether a server is able to handle
		RPCs. Its semantics are documented in
		https://github.com/grpc/grpc/blob/master/doc/health-checking.md.

		Methods (total 3, all are exported)
			( HealthServer) Check(context.Context, *HealthCheckRequest) (*HealthCheckResponse, error)
				Check gets the health of the specified service. If the requested service
				is unknown, the call will fail with status NOT_FOUND. If the caller does
				not specify a service name, the server should respond with its overall
				health status.
				
				Clients should set a deadline when calling Check, and can declare the
				server unhealthy if they do not receive a timely response.

			( HealthServer) List(context.Context, *HealthListRequest) (*HealthListResponse, error)
				List provides a non-atomic snapshot of the health of all the available
				services.
				
				The server may respond with a RESOURCE_EXHAUSTED error if too many services
				exist.
				
				Clients should set a deadline when calling List, and can declare the server
				unhealthy if they do not receive a timely response.
				
				Clients should keep in mind that the list of health services exposed by an
				application can change over the lifetime of the process.

			( HealthServer) Watch(*HealthCheckRequest, grpc.ServerStreamingServer[HealthCheckResponse]) error
				Performs a watch for the serving status of the requested service.
				The server will immediately send back a message indicating the current
				serving status.  It will then subsequently send a new message whenever
				the service's serving status changes.
				
				If the requested service is unknown when the call is received, the
				server will send a message setting the serving status to
				SERVICE_UNKNOWN but will *not* terminate the call.  If at some
				future point, the serving status of the service becomes known, the
				server will send a new message with the service's serving status.
				
				If the call terminates with status UNIMPLEMENTED, then clients
				should assume this method is not supported and should not retry the
				call.  If the call terminates with any other status (including OK),
				clients should retry the call with appropriate exponential backoff.

		Implemented By (at least 2, both are exported)
			 UnimplementedHealthServer
			*google.golang.org/grpc/health.Server
		As Inputs Of (at least one exported)
			func RegisterHealthServer(s grpc.ServiceRegistrar, srv HealthServer)

	 type UnimplementedHealthServer (struct)
		UnimplementedHealthServer should 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.

		Methods (total 4, in which 3 are exported)
			( UnimplementedHealthServer) Check(context.Context, *HealthCheckRequest) (*HealthCheckResponse, error)
			( UnimplementedHealthServer) List(context.Context, *HealthListRequest) (*HealthListResponse, error)
			( UnimplementedHealthServer) Watch(*HealthCheckRequest, grpc.ServerStreamingServer[HealthCheckResponse]) error
			/* one unexported ... *//* one unexported: */
			( UnimplementedHealthServer) testEmbeddedByValue()
		Implements (at least one exported)
			 UnimplementedHealthServer : HealthServer

	 type UnsafeHealthServer (interface)
		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.

		Methods (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			( UnsafeHealthServer) mustEmbedUnimplementedHealthServer()

	/* one unexported ... *//* one unexported: */
	 type healthClient (struct)

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			cc grpc.ClientConnInterface
		Methods (total 3, all are exported)
			(*healthClient) Check(ctx context.Context, in *HealthCheckRequest, opts ...grpc.CallOption) (*HealthCheckResponse, error)
			(*healthClient) List(ctx context.Context, in *HealthListRequest, opts ...grpc.CallOption) (*HealthListResponse, error)
			(*healthClient) Watch(ctx context.Context, in *HealthCheckRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[HealthCheckResponse], error)
		Implements (at least one exported)
			*healthClient : HealthClient


Package-Level Functions (total 8, in which 2 are exported)

	 func NewHealthClient(cc grpc.ClientConnInterface) HealthClient
	 func RegisterHealthServer(s grpc.ServiceRegistrar, srv HealthServer)
	/* 6 unexporteds ... *//* 6 unexporteds: */
	 func _Health_Check_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error)
	 func _Health_List_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error)
	 func _Health_Watch_Handler(srv interface{}, stream grpc.ServerStream) error
	 func file_grpc_health_v1_health_proto_init()
	 func file_grpc_health_v1_health_proto_rawDescGZIP() []byte
	 func init()
Package-Level Variables (total 10, in which 4 are exported)

	  var File_grpc_health_v1_health_proto protoreflect.FileDescriptor
	  var Health_ServiceDesc grpc.ServiceDesc
		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)

	  var HealthCheckResponse_ServingStatus_name map[int32]string
		Enum value maps for HealthCheckResponse_ServingStatus.

	  var HealthCheckResponse_ServingStatus_value map[string]int32
		Enum value maps for HealthCheckResponse_ServingStatus.

	/* 6 unexporteds ... *//* 6 unexporteds: */
	  var file_grpc_health_v1_health_proto_depIdxs []int32
	  var file_grpc_health_v1_health_proto_enumTypes []impl.EnumInfo
	  var file_grpc_health_v1_health_proto_goTypes []interface{}
	  var file_grpc_health_v1_health_proto_msgTypes []impl.MessageInfo
	  var file_grpc_health_v1_health_proto_rawDescData []byte
	  var file_grpc_health_v1_health_proto_rawDescOnce sync.Once
Package-Level Constants (total 8, in which 7 are exported)

	const Health_Check_FullMethodName = "/grpc.health.v1.Health/Check"
	const Health_List_FullMethodName = "/grpc.health.v1.Health/List"
	const Health_Watch_FullMethodName = "/grpc.health.v1.Health/Watch"
	const HealthCheckResponse_NOT_SERVING HealthCheckResponse_ServingStatus = 2
	const HealthCheckResponse_SERVICE_UNKNOWN HealthCheckResponse_ServingStatus = 3 // Used only by the Watch method.
	const HealthCheckResponse_SERVING HealthCheckResponse_ServingStatus = 1
	const HealthCheckResponse_UNKNOWN HealthCheckResponse_ServingStatus = 0
	/* one unexported ... *//* one unexported: */
	const file_grpc_health_v1_health_proto_rawDesc = "\n\x1bgrpc/health/v1/health.proto\x12\x0egrpc.health.v1\".\n\x12Heal...

The pages are generated with Golds v0.7.6. (GOOS=linux GOARCH=amd64)