health

Documentation

Overview

Package health is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Package health is a generated protocol buffer package.

It is generated from these files:

health.proto

It has these top-level messages:

StatusResponse
URLBase
NetConfig
Metadata

Package health is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

• func ExportHealthCorsPatterns() []runtime.Pattern
• func RegisterHealthHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
• func RegisterHealthHandlerClient(ctx context.Context, mux *runtime.ServeMux, client HealthClient) error
• func RegisterHealthHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
• func RegisterHealthServer(s *grpc.Server, srv HealthServer)
• type HealthClient
  • func NewHealthClient(cc *grpc.ClientConn) HealthClient
• type HealthServer
• type Metadata
  • func (*Metadata) Descriptor() ([]byte, []int)
  • func (m *Metadata) GetEnv() string
  • func (m *Metadata) GetNetConfig() *NetConfig
  • func (m *Metadata) GetTeamId() string
  • func (*Metadata) ProtoMessage()
  • func (m *Metadata) Reset()
  • func (m *Metadata) String() string
• type NetConfig
  • func (*NetConfig) Descriptor() ([]byte, []int)
  • func (m *NetConfig) GetClusterUrls() *URLBase
  • func (m *NetConfig) GetFileUrls() *URLBase
  • func (m *NetConfig) GetInClusterUrls() *URLBase
  • func (m *NetConfig) GetPublicUrls() *URLBase
  • func (m *NetConfig) GetTeamAddr() string
  • func (m *NetConfig) GetTeamUrls() *URLBase
  • func (m *NetConfig) GetURLShortenerUrls() *URLBase
  • func (*NetConfig) ProtoMessage()
  • func (m *NetConfig) Reset()
  • func (m *NetConfig) String() string
• type StatusResponse
  • func (*StatusResponse) Descriptor() ([]byte, []int)
  • func (m *StatusResponse) GetMetadata() *Metadata
  • func (m *StatusResponse) GetVersion() *appscode_version.Version
  • func (*StatusResponse) ProtoMessage()
  • func (m *StatusResponse) Reset()
  • func (m *StatusResponse) String() string
• type URLBase
  • func (*URLBase) Descriptor() ([]byte, []int)
  • func (m *URLBase) GetBaseAddr() string
  • func (m *URLBase) GetScheme() string
  • func (*URLBase) ProtoMessage()
  • func (m *URLBase) Reset()
  • func (m *URLBase) String() string

Functions

func ExportHealthCorsPatterns

func ExportHealthCorsPatterns() []runtime.Pattern

ExportHealthCorsPatterns returns an array of grpc gatway mux patterns for Health service to enable CORS.

func RegisterHealthHandler

func RegisterHealthHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterHealthHandler registers the http handlers for service Health to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterHealthHandlerClient

func RegisterHealthHandlerClient(ctx context.Context, mux *runtime.ServeMux, client HealthClient) error

RegisterHealthHandler registers the http handlers for service Health to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "HealthClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "HealthClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "HealthClient" to call the correct interceptors.

func RegisterHealthHandlerFromEndpoint

func RegisterHealthHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterHealthHandlerFromEndpoint is same as RegisterHealthHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterHealthServer

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

Types

type HealthClient

type HealthClient interface {
	Status(ctx context.Context, in *appscode_dtypes.VoidRequest, opts ...grpc.CallOption) (*StatusResponse, error)
}

func NewHealthClient

func NewHealthClient(cc *grpc.ClientConn) HealthClient

type HealthServer

type HealthServer interface {
	Status(context.Context, *appscode_dtypes.VoidRequest) (*StatusResponse, error)
}

type Metadata

type Metadata struct {
	Env       string     `protobuf:"bytes,1,opt,name=env" json:"env,omitempty"`
	TeamId    string     `protobuf:"bytes,2,opt,name=team_id,json=teamId" json:"team_id,omitempty"`
	NetConfig *NetConfig `protobuf:"bytes,3,opt,name=net_config,json=netConfig" json:"net_config,omitempty"`
}

func (*Metadata) Descriptor

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

func (*Metadata) GetEnv

func (m *Metadata) GetEnv() string

func (*Metadata) GetNetConfig

func (m *Metadata) GetNetConfig() *NetConfig

func (*Metadata) GetTeamId

func (m *Metadata) GetTeamId() string

func (*Metadata) ProtoMessage

func (*Metadata) ProtoMessage()

func (*Metadata) Reset

func (m *Metadata) Reset()

func (*Metadata) String

func (m *Metadata) String() string

type NetConfig

type NetConfig struct {
	TeamAddr         string   `protobuf:"bytes,1,opt,name=team_addr,json=teamAddr" json:"team_addr,omitempty"`
	PublicUrls       *URLBase `protobuf:"bytes,2,opt,name=public_urls,json=publicUrls" json:"public_urls,omitempty"`
	TeamUrls         *URLBase `protobuf:"bytes,3,opt,name=team_urls,json=teamUrls" json:"team_urls,omitempty"`
	ClusterUrls      *URLBase `protobuf:"bytes,4,opt,name=cluster_urls,json=clusterUrls" json:"cluster_urls,omitempty"`
	InClusterUrls    *URLBase `protobuf:"bytes,5,opt,name=in_cluster_urls,json=inClusterUrls" json:"in_cluster_urls,omitempty"`
	URLShortenerUrls *URLBase `protobuf:"bytes,6,opt,name=URL_shortener_urls,json=URLShortenerUrls" json:"URL_shortener_urls,omitempty"`
	FileUrls         *URLBase `protobuf:"bytes,7,opt,name=file_urls,json=fileUrls" json:"file_urls,omitempty"`
}

func (*NetConfig) Descriptor

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

func (*NetConfig) GetClusterUrls

func (m *NetConfig) GetClusterUrls() *URLBase

func (*NetConfig) GetFileUrls

func (m *NetConfig) GetFileUrls() *URLBase

func (*NetConfig) GetInClusterUrls

func (m *NetConfig) GetInClusterUrls() *URLBase

func (*NetConfig) GetPublicUrls

func (m *NetConfig) GetPublicUrls() *URLBase

func (*NetConfig) GetTeamAddr

func (m *NetConfig) GetTeamAddr() string

func (*NetConfig) GetTeamUrls

func (m *NetConfig) GetTeamUrls() *URLBase

func (*NetConfig) GetURLShortenerUrls

func (m *NetConfig) GetURLShortenerUrls() *URLBase

func (*NetConfig) ProtoMessage

func (*NetConfig) ProtoMessage()

func (*NetConfig) Reset

func (m *NetConfig) Reset()

func (*NetConfig) String

func (m *NetConfig) String() string

type StatusResponse

type StatusResponse struct {
	Version  *appscode_version.Version `protobuf:"bytes,1,opt,name=version" json:"version,omitempty"`
	Metadata *Metadata                 `protobuf:"bytes,2,opt,name=metadata" json:"metadata,omitempty"`
}

func (*StatusResponse) Descriptor

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

func (*StatusResponse) GetMetadata

func (m *StatusResponse) GetMetadata() *Metadata

func (*StatusResponse) GetVersion

func (m *StatusResponse) GetVersion() *appscode_version.Version

func (*StatusResponse) ProtoMessage

func (*StatusResponse) ProtoMessage()

func (*StatusResponse) Reset

func (m *StatusResponse) Reset()

func (*StatusResponse) String

func (m *StatusResponse) String() string

type URLBase

type URLBase struct {
	Scheme   string `protobuf:"bytes,1,opt,name=scheme" json:"scheme,omitempty"`
	BaseAddr string `protobuf:"bytes,2,opt,name=base_addr,json=baseAddr" json:"base_addr,omitempty"`
}

func (*URLBase) Descriptor

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

func (*URLBase) GetBaseAddr

func (m *URLBase) GetBaseAddr() string

func (*URLBase) GetScheme

func (m *URLBase) GetScheme() string

func (*URLBase) ProtoMessage

func (*URLBase) ProtoMessage()

func (*URLBase) Reset

func (m *URLBase) Reset()

func (*URLBase) String

func (m *URLBase) String() string