grpc_health_v1

Documentation

Index

• Variables
• func RegisterHeartbeatServer(s *grpc.Server, srv HeartbeatServer)
• type Empty
  • func (*Empty) Descriptor() ([]byte, []int)
  • func (*Empty) ProtoMessage()
  • func (m *Empty) Reset()
  • func (m *Empty) String() string
  • func (m *Empty) XXX_DiscardUnknown()
  • func (m *Empty) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (dst *Empty) XXX_Merge(src proto.Message)
  • func (m *Empty) XXX_Size() int
  • func (m *Empty) XXX_Unmarshal(b []byte) error
• type HeartbeatClient
  • func NewHeartbeatClient(cc *grpc.ClientConn) HeartbeatClient
• type HeartbeatMsg
  • func (*HeartbeatMsg) Descriptor() ([]byte, []int)
  • func (m *HeartbeatMsg) GetServiceID() string
  • func (m *HeartbeatMsg) GetStatus() HeartbeatMsg_ServingStatus
  • func (*HeartbeatMsg) ProtoMessage()
  • func (m *HeartbeatMsg) Reset()
  • func (m *HeartbeatMsg) String() string
  • func (m *HeartbeatMsg) XXX_DiscardUnknown()
  • func (m *HeartbeatMsg) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (dst *HeartbeatMsg) XXX_Merge(src proto.Message)
  • func (m *HeartbeatMsg) XXX_Size() int
  • func (m *HeartbeatMsg) XXX_Unmarshal(b []byte) error
• type HeartbeatMsg_ServingStatus
  • func (HeartbeatMsg_ServingStatus) EnumDescriptor() ([]byte, []int)
  • func (x HeartbeatMsg_ServingStatus) String() string
• type HeartbeatServer

Variables

var HeartbeatMsg_ServingStatus_name = map[int32]string{
	0: "UNKNOWN",
	1: "SERVING",
	2: "NOT_SERVING",
}

var HeartbeatMsg_ServingStatus_value = map[string]int32{
	"UNKNOWN":     0,
	"SERVING":     1,
	"NOT_SERVING": 2,
}

Functions

func RegisterHeartbeatServer

func RegisterHeartbeatServer(s *grpc.Server, srv HeartbeatServer)

Types

type Empty

type Empty struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs.

func (*Empty) Descriptor

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

func (*Empty) ProtoMessage

func (*Empty) ProtoMessage()

func (*Empty) Reset

func (m *Empty) Reset()

func (*Empty) String

func (m *Empty) String() string

func (*Empty) XXX_DiscardUnknown

func (m *Empty) XXX_DiscardUnknown()

func (*Empty) XXX_Marshal

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

func (*Empty) XXX_Merge

func (dst *Empty) XXX_Merge(src proto.Message)

func (*Empty) XXX_Size

func (m *Empty) XXX_Size() int

func (*Empty) XXX_Unmarshal

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

type HeartbeatClient

type HeartbeatClient interface {
	Check(ctx context.Context, in *Empty, opts ...grpc.CallOption) (*HeartbeatMsg, error)
}

HeartbeatClient is the client API for Heartbeat service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewHeartbeatClient

func NewHeartbeatClient(cc *grpc.ClientConn) HeartbeatClient

type HeartbeatMsg

type HeartbeatMsg struct {
	ServiceID            string                     `protobuf:"bytes,1,opt,name=serviceID,proto3" json:"serviceID,omitempty"`
	Status               HeartbeatMsg_ServingStatus `protobuf:"varint,2,opt,name=status,proto3,enum=grpc.health.v1.HeartbeatMsg_ServingStatus" json:"status,omitempty"`
	XXX_NoUnkeyedLiteral struct{}                   `json:"-"`
	XXX_unrecognized     []byte                     `json:"-"`
	XXX_sizecache        int32                      `json:"-"`
}

proto spec for the heartbeat

func (*HeartbeatMsg) Descriptor

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

func (*HeartbeatMsg) GetServiceID

func (m *HeartbeatMsg) GetServiceID() string

func (*HeartbeatMsg) GetStatus

func (m *HeartbeatMsg) GetStatus() HeartbeatMsg_ServingStatus

func (*HeartbeatMsg) ProtoMessage

func (*HeartbeatMsg) ProtoMessage()

func (*HeartbeatMsg) Reset

func (m *HeartbeatMsg) Reset()

func (*HeartbeatMsg) String

func (m *HeartbeatMsg) String() string

func (*HeartbeatMsg) XXX_DiscardUnknown

func (m *HeartbeatMsg) XXX_DiscardUnknown()

func (*HeartbeatMsg) XXX_Marshal

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

func (*HeartbeatMsg) XXX_Merge

func (dst *HeartbeatMsg) XXX_Merge(src proto.Message)

func (*HeartbeatMsg) XXX_Size

func (m *HeartbeatMsg) XXX_Size() int

func (*HeartbeatMsg) XXX_Unmarshal

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

type HeartbeatMsg_ServingStatus

type HeartbeatMsg_ServingStatus int32

const (
	HeartbeatMsg_UNKNOWN     HeartbeatMsg_ServingStatus = 0
	HeartbeatMsg_SERVING     HeartbeatMsg_ServingStatus = 1
	HeartbeatMsg_NOT_SERVING HeartbeatMsg_ServingStatus = 2
)

func (HeartbeatMsg_ServingStatus) EnumDescriptor

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

func (HeartbeatMsg_ServingStatus) String

func (x HeartbeatMsg_ServingStatus) String() string

type HeartbeatServer

type HeartbeatServer interface {
	Check(context.Context, *Empty) (*HeartbeatMsg, error)
}

HeartbeatServer is the server API for Heartbeat service.