pb

package
v0.8.0 Latest Latest
Warning

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

 Go to latest Published: Aug 27, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package pb provides protoc generated types and methods for Health service with Alive, Ready and Version methods.

Index

Constants

This section is empty.

Variables

View Source 
var File_health_proto protoreflect.FileDescriptor

Functions

func RegisterHealthServer 

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

Types

type AliveRequest 

type AliveRequest struct {
	// contains filtered or unexported fields
}

func (*AliveRequest) Descriptor deprecated 

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

Deprecated: Use AliveRequest.ProtoReflect.Descriptor instead.

func (*AliveRequest) ProtoMessage 

func (*AliveRequest) ProtoMessage()

func (*AliveRequest) ProtoReflect 

func (x *AliveRequest) ProtoReflect() protoreflect.Message

func (*AliveRequest) Reset 

func (x *AliveRequest) Reset()

func (*AliveRequest) String 

func (x *AliveRequest) String() string

type AliveResponse 

type AliveResponse struct {
	// contains filtered or unexported fields
}

func (*AliveResponse) Descriptor deprecated 

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

Deprecated: Use AliveResponse.ProtoReflect.Descriptor instead.

func (*AliveResponse) ProtoMessage 

func (*AliveResponse) ProtoMessage()

func (*AliveResponse) ProtoReflect 

func (x *AliveResponse) ProtoReflect() protoreflect.Message

func (*AliveResponse) Reset 

func (x *AliveResponse) Reset()

func (*AliveResponse) String 

func (x *AliveResponse) String() string

type HealthClient 

type HealthClient interface {
	// Alive returns an empty response. If the caller receives the response
	// without error, it means that the application is alive.
	Alive(ctx context.Context, in *AliveRequest, opts ...grpc.CallOption) (*AliveResponse, error)
	// Ready returns a response with a bool value indicating whether
	// the application is ready to receive traffic. An application may
	// become ready or not ready any number of times.
	Ready(ctx context.Context, in *ReadyRequest, opts ...grpc.CallOption) (*ReadyResponse, error)
	// Version returns information to identify the running version of the
	// application.
	Version(ctx context.Context, in *VersionRequest, opts ...grpc.CallOption) (*VersionResponse, error)
}

HealthClient is the client API for Health service.

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

func NewHealthClient 

func NewHealthClient(cc grpc.ClientConnInterface) HealthClient

type HealthServer 

type HealthServer interface {
	// Alive returns an empty response. If the caller receives the response
	// without error, it means that the application is alive.
	Alive(context.Context, *AliveRequest) (*AliveResponse, error)
	// Ready returns a response with a bool value indicating whether
	// the application is ready to receive traffic. An application may
	// become ready or not ready any number of times.
	Ready(context.Context, *ReadyRequest) (*ReadyResponse, error)
	// Version returns information to identify the running version of the
	// application.
	Version(context.Context, *VersionRequest) (*VersionResponse, error)
}

HealthServer is the server API for Health service.

type ReadyRequest 

type ReadyRequest struct {
	// contains filtered or unexported fields
}

func (*ReadyRequest) Descriptor deprecated 

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

Deprecated: Use ReadyRequest.ProtoReflect.Descriptor instead.

func (*ReadyRequest) ProtoMessage 

func (*ReadyRequest) ProtoMessage()

func (*ReadyRequest) ProtoReflect 

func (x *ReadyRequest) ProtoReflect() protoreflect.Message

func (*ReadyRequest) Reset 

func (x *ReadyRequest) Reset()

func (*ReadyRequest) String 

func (x *ReadyRequest) String() string

type ReadyResponse 

type ReadyResponse struct {
	Ready bool `protobuf:"varint,1,opt,name=ready,proto3" json:"ready,omitempty"`
	// contains filtered or unexported fields
}

func (*ReadyResponse) Descriptor deprecated 

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

Deprecated: Use ReadyResponse.ProtoReflect.Descriptor instead.

func (*ReadyResponse) GetReady 

func (x *ReadyResponse) GetReady() bool

func (*ReadyResponse) ProtoMessage 

func (*ReadyResponse) ProtoMessage()

func (*ReadyResponse) ProtoReflect 

func (x *ReadyResponse) ProtoReflect() protoreflect.Message

func (*ReadyResponse) Reset 

func (x *ReadyResponse) Reset()

func (*ReadyResponse) String 

func (x *ReadyResponse) String() string

type UnimplementedHealthServer 

type UnimplementedHealthServer struct {
}

UnimplementedHealthServer can be embedded to have forward compatible implementations.

func (*UnimplementedHealthServer) Alive 

func (*UnimplementedHealthServer) Alive(context.Context, *AliveRequest) (*AliveResponse, error)

func (*UnimplementedHealthServer) Ready 

func (*UnimplementedHealthServer) Ready(context.Context, *ReadyRequest) (*ReadyResponse, error)

func (*UnimplementedHealthServer) Version 

func (*UnimplementedHealthServer) Version(context.Context, *VersionRequest) (*VersionResponse, error)

type VersionRequest 

type VersionRequest struct {
	// contains filtered or unexported fields
}

func (*VersionRequest) Descriptor deprecated 

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

Deprecated: Use VersionRequest.ProtoReflect.Descriptor instead.

func (*VersionRequest) ProtoMessage 

func (*VersionRequest) ProtoMessage()

func (*VersionRequest) ProtoReflect 

func (x *VersionRequest) ProtoReflect() protoreflect.Message

func (*VersionRequest) Reset 

func (x *VersionRequest) Reset()

func (*VersionRequest) String 

func (x *VersionRequest) String() string

type VersionResponse 

type VersionResponse struct {

	// Canonical repository source code URL, e.g. https://github.com/anz-bank/pkg
	RepoUrl string `protobuf:"bytes,1,opt,name=repo_url,json=repoUrl,proto3" json:"repo_url,omitempty"`
	// Full git commit hash, e.g. 1ee4e1f233caea38d6e331299f57dd86efb47361
	CommitHash string `protobuf:"bytes,2,opt,name=commit_hash,json=commitHash,proto3" json:"commit_hash,omitempty"`
	// CI run URL, e.g. https://github.com/anz-bank/pkg/actions/runs/84341844
	BuildLogUrl string `protobuf:"bytes,3,opt,name=build_log_url,json=buildLogUrl,proto3" json:"build_log_url,omitempty"`
	// Canonical container tag, e.g. gcr.io/google-containers/hugo
	ContainerTag string `protobuf:"bytes,4,opt,name=container_tag,json=containerTag,proto3" json:"container_tag,omitempty"`
	// Semantic versioning compliant version
	Semver string `protobuf:"bytes,5,opt,name=semver,proto3" json:"semver,omitempty"`
	// Additional code scan links, e.g. { "example-code-scan": "https://scanner.example.com/324234asd" }
	ScannerUrls map[string]string `` /* 182-byte string literal not displayed */
	// contains filtered or unexported fields
}

VersionResponse provides version information specified at compile time.

func (*VersionResponse) Descriptor deprecated 

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

Deprecated: Use VersionResponse.ProtoReflect.Descriptor instead.

func (*VersionResponse) GetBuildLogUrl 

func (x *VersionResponse) GetBuildLogUrl() string

func (*VersionResponse) GetCommitHash 

func (x *VersionResponse) GetCommitHash() string

func (*VersionResponse) GetContainerTag 

func (x *VersionResponse) GetContainerTag() string

func (*VersionResponse) GetRepoUrl 

func (x *VersionResponse) GetRepoUrl() string

func (*VersionResponse) GetScannerUrls 

func (x *VersionResponse) GetScannerUrls() map[string]string

func (*VersionResponse) GetSemver 

func (x *VersionResponse) GetSemver() string

func (*VersionResponse) ProtoMessage 

func (*VersionResponse) ProtoMessage()

func (*VersionResponse) ProtoReflect 

func (x *VersionResponse) ProtoReflect() protoreflect.Message

func (*VersionResponse) Reset 

func (x *VersionResponse) Reset()

func (*VersionResponse) String 

func (x *VersionResponse) String() string

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.