grpc_health_v1

package
v1.32.0-dev Latest Latest
Warning

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

 Go to latest Published: Jul 23, 2020 License: Apache-2.0 Imports: 7 Imported by: 4,052

Documentation

Index

Constants

This section is empty.

Variables

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

Functions

func RegisterHealthServer 

func RegisterHealthServer(s *grpc.Server, srv HealthServer)

Types

type HealthCheckRequest 

type HealthCheckRequest struct {
	Service              string   `protobuf:"bytes,1,opt,name=service,proto3" json:"service,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*HealthCheckRequest) Descriptor 

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

func (*HealthCheckRequest) GetService added in v1.6.0 

func (m *HealthCheckRequest) GetService() string

func (*HealthCheckRequest) ProtoMessage 

func (*HealthCheckRequest) ProtoMessage()

func (*HealthCheckRequest) Reset 

func (m *HealthCheckRequest) Reset()

func (*HealthCheckRequest) String 

func (m *HealthCheckRequest) String() string

func (*HealthCheckRequest) XXX_DiscardUnknown added in v1.12.0 

func (m *HealthCheckRequest) XXX_DiscardUnknown()

func (*HealthCheckRequest) XXX_Marshal added in v1.12.0 

func (m *HealthCheckRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*HealthCheckRequest) XXX_Merge added in v1.12.0 

func (m *HealthCheckRequest) XXX_Merge(src proto.Message)

func (*HealthCheckRequest) XXX_Size added in v1.12.0 

func (m *HealthCheckRequest) XXX_Size() int

func (*HealthCheckRequest) XXX_Unmarshal added in v1.12.0 

func (m *HealthCheckRequest) XXX_Unmarshal(b []byte) error

type HealthCheckResponse 

type HealthCheckResponse struct {
	Status               HealthCheckResponse_ServingStatus `protobuf:"varint,1,opt,name=status,proto3,enum=grpc.health.v1.HealthCheckResponse_ServingStatus" json:"status,omitempty"`
	XXX_NoUnkeyedLiteral struct{}                          `json:"-"`
	XXX_unrecognized     []byte                            `json:"-"`
	XXX_sizecache        int32                             `json:"-"`
}

func (*HealthCheckResponse) Descriptor 

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

func (*HealthCheckResponse) GetStatus added in v1.6.0 

func (m *HealthCheckResponse) GetStatus() HealthCheckResponse_ServingStatus

func (*HealthCheckResponse) ProtoMessage 

func (*HealthCheckResponse) ProtoMessage()

func (*HealthCheckResponse) Reset 

func (m *HealthCheckResponse) Reset()

func (*HealthCheckResponse) String 

func (m *HealthCheckResponse) String() string

func (*HealthCheckResponse) XXX_DiscardUnknown added in v1.12.0 

func (m *HealthCheckResponse) XXX_DiscardUnknown()

func (*HealthCheckResponse) XXX_Marshal added in v1.12.0 

func (m *HealthCheckResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*HealthCheckResponse) XXX_Merge added in v1.12.0 

func (m *HealthCheckResponse) XXX_Merge(src proto.Message)

func (*HealthCheckResponse) XXX_Size added in v1.12.0 

func (m *HealthCheckResponse) XXX_Size() int

func (*HealthCheckResponse) XXX_Unmarshal added in v1.12.0 

func (m *HealthCheckResponse) XXX_Unmarshal(b []byte) error

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
)

func (HealthCheckResponse_ServingStatus) EnumDescriptor 

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

func (HealthCheckResponse_ServingStatus) String 

func (x HealthCheckResponse_ServingStatus) String() string

type HealthClient 

type HealthClient interface {
	// If the requested service is unknown, the call will fail with status
	// NOT_FOUND.
	Check(ctx context.Context, in *HealthCheckRequest, opts ...grpc.CallOption) (*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.
	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 {
	// If the requested service is unknown, the call will fail with status
	// NOT_FOUND.
	Check(context.Context, *HealthCheckRequest) (*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.
	Watch(*HealthCheckRequest, Health_WatchServer) error
}

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

type Health_WatchClient added in v1.15.0 

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

type Health_WatchServer added in v1.15.0 

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

type UnimplementedHealthServer added in v1.24.0 

type UnimplementedHealthServer struct {
}

UnimplementedHealthServer should be embedded to have forward compatible implementations.

func (*UnimplementedHealthServer) Check added in v1.24.0 

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

func (*UnimplementedHealthServer) Watch added in v1.24.0 

func (*UnimplementedHealthServer) Watch(*HealthCheckRequest, Health_WatchServer) error

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.