status

Documentation

Overview

Package status is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Package status is a generated protocol buffer package.

It is generated from these files:

status.proto

It has these top-level messages:

StatusRequest
StatusResponse
Version

Package status is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

• func ExportStatusServiceCorsPatterns() []runtime.Pattern
• func RegisterStatusServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
• func RegisterStatusServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client StatusServiceClient) error
• func RegisterStatusServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
• func RegisterStatusServiceServer(s *grpc.Server, srv StatusServiceServer)
• type StatusRequest
  • func (*StatusRequest) Descriptor() ([]byte, []int)
  • func (m *StatusRequest) IsRequest()
  • func (*StatusRequest) ProtoMessage()
  • func (m *StatusRequest) Reset()
  • func (m *StatusRequest) String() string
  • func (m *StatusRequest) Valid() (*gojsonschema.Result, error)
• type StatusResponse
  • func (*StatusResponse) Descriptor() ([]byte, []int)
  • func (m *StatusResponse) GetVersion() *Version
  • func (*StatusResponse) ProtoMessage()
  • func (m *StatusResponse) Reset()
  • func (m *StatusResponse) String() string
• type StatusServiceClient
  • func NewStatusServiceClient(cc *grpc.ClientConn) StatusServiceClient
• type StatusServiceServer
• type Version
  • func (*Version) Descriptor() ([]byte, []int)
  • func (m *Version) GetArch() string
  • func (m *Version) GetBuildHost() string
  • func (m *Version) GetBuildHostArch() string
  • func (m *Version) GetBuildHostOs() string
  • func (m *Version) GetBuildTimestamp() string
  • func (m *Version) GetCommitHash() string
  • func (m *Version) GetCommitTimestamp() string
  • func (m *Version) GetGitBranch() string
  • func (m *Version) GetGitTag() string
  • func (m *Version) GetName() string
  • func (m *Version) GetOs() string
  • func (m *Version) GetVersion() string
  • func (m *Version) GetVersionStrategy() string
  • func (*Version) ProtoMessage()
  • func (m *Version) Reset()
  • func (m *Version) String() string

Functions

func ExportStatusServiceCorsPatterns

func ExportStatusServiceCorsPatterns() []runtime.Pattern

ExportStatusServiceCorsPatterns returns an array of grpc gatway mux patterns for StatusService service to enable CORS.

func RegisterStatusServiceHandler

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

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

func RegisterStatusServiceHandlerClient

func RegisterStatusServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client StatusServiceClient) error

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

func RegisterStatusServiceHandlerFromEndpoint

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

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

func RegisterStatusServiceServer

func RegisterStatusServiceServer(s *grpc.Server, srv StatusServiceServer)

Types

type StatusRequest

type StatusRequest struct {
}

func (*StatusRequest) Descriptor

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

func (*StatusRequest) IsRequest

func (m *StatusRequest) IsRequest()

func (*StatusRequest) ProtoMessage

func (*StatusRequest) ProtoMessage()

func (*StatusRequest) Reset

func (m *StatusRequest) Reset()

func (*StatusRequest) String

func (m *StatusRequest) String() string

func (*StatusRequest) Valid

func (m *StatusRequest) Valid() (*gojsonschema.Result, error)

type StatusResponse

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

func (*StatusResponse) Descriptor

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

func (*StatusResponse) GetVersion

func (m *StatusResponse) GetVersion() *Version

func (*StatusResponse) ProtoMessage

func (*StatusResponse) ProtoMessage()

func (*StatusResponse) Reset

func (m *StatusResponse) Reset()

func (*StatusResponse) String

func (m *StatusResponse) String() string

type StatusServiceClient

type StatusServiceClient interface {
	Status(ctx context.Context, in *StatusRequest, opts ...grpc.CallOption) (*StatusResponse, error)
}

func NewStatusServiceClient

func NewStatusServiceClient(cc *grpc.ClientConn) StatusServiceClient

type StatusServiceServer

type StatusServiceServer interface {
	Status(context.Context, *StatusRequest) (*StatusResponse, error)
}

type Version

type Version struct {
	Name            string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	Version         string `protobuf:"bytes,2,opt,name=version" json:"version,omitempty"`
	VersionStrategy string `protobuf:"bytes,3,opt,name=version_strategy,json=versionStrategy" json:"version_strategy,omitempty"`
	Os              string `protobuf:"bytes,4,opt,name=os" json:"os,omitempty"`
	Arch            string `protobuf:"bytes,5,opt,name=arch" json:"arch,omitempty"`
	CommitHash      string `protobuf:"bytes,6,opt,name=commit_hash,json=commitHash" json:"commit_hash,omitempty"`
	GitBranch       string `protobuf:"bytes,7,opt,name=git_branch,json=gitBranch" json:"git_branch,omitempty"`
	GitTag          string `protobuf:"bytes,8,opt,name=git_tag,json=gitTag" json:"git_tag,omitempty"`
	CommitTimestamp string `protobuf:"bytes,9,opt,name=commit_timestamp,json=commitTimestamp" json:"commit_timestamp,omitempty"`
	BuildTimestamp  string `protobuf:"bytes,10,opt,name=build_timestamp,json=buildTimestamp" json:"build_timestamp,omitempty"`
	BuildHost       string `protobuf:"bytes,11,opt,name=build_host,json=buildHost" json:"build_host,omitempty"`
	BuildHostOs     string `protobuf:"bytes,12,opt,name=build_host_os,json=buildHostOs" json:"build_host_os,omitempty"`
	BuildHostArch   string `protobuf:"bytes,13,opt,name=build_host_arch,json=buildHostArch" json:"build_host_arch,omitempty"`
}

func (*Version) Descriptor

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

func (*Version) GetArch

func (m *Version) GetArch() string

func (*Version) GetBuildHost

func (m *Version) GetBuildHost() string

func (*Version) GetBuildHostArch

func (m *Version) GetBuildHostArch() string

func (*Version) GetBuildHostOs

func (m *Version) GetBuildHostOs() string

func (*Version) GetBuildTimestamp

func (m *Version) GetBuildTimestamp() string

func (*Version) GetCommitHash

func (m *Version) GetCommitHash() string

func (*Version) GetCommitTimestamp

func (m *Version) GetCommitTimestamp() string

func (*Version) GetGitBranch

func (m *Version) GetGitBranch() string

func (*Version) GetGitTag

func (m *Version) GetGitTag() string

func (*Version) GetName

func (m *Version) GetName() string

func (*Version) GetOs

func (m *Version) GetOs() string

func (*Version) GetVersion

func (m *Version) GetVersion() string

func (*Version) GetVersionStrategy

func (m *Version) GetVersionStrategy() string

func (*Version) ProtoMessage

func (*Version) ProtoMessage()

func (*Version) Reset

func (m *Version) Reset()

func (*Version) String

func (m *Version) String() string