health

package
v1.5.0 Latest Latest
Warning

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

Go to latest
Published: Aug 1, 2025 License: AGPL-3.0 Imports: 8 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

View Source
var DoguHealth_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "health.DoguHealth",
	HandlerType: (*DoguHealthServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetByName",
			Handler:    _DoguHealth_GetByName_Handler,
		},
		{
			MethodName: "GetByNames",
			Handler:    _DoguHealth_GetByNames_Handler,
		},
		{
			MethodName: "GetAll",
			Handler:    _DoguHealth_GetAll_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "health.proto",
}

DoguHealth_ServiceDesc is the grpc.ServiceDesc for DoguHealth service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source
var File_health_proto protoreflect.FileDescriptor

Functions

func RegisterDoguHealthServer

func RegisterDoguHealthServer(s grpc.ServiceRegistrar, srv DoguHealthServer)

Types

type DoguHealthAllRequest

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

DoguHealthListRequest contains the data which are used to retrieve health information about all dogus.

func (*DoguHealthAllRequest) Descriptor deprecated

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

Deprecated: Use DoguHealthAllRequest.ProtoReflect.Descriptor instead.

func (*DoguHealthAllRequest) ProtoMessage

func (*DoguHealthAllRequest) ProtoMessage()

func (*DoguHealthAllRequest) ProtoReflect

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

func (*DoguHealthAllRequest) Reset

func (x *DoguHealthAllRequest) Reset()

func (*DoguHealthAllRequest) String

func (x *DoguHealthAllRequest) String() string

type DoguHealthCheck

type DoguHealthCheck struct {

	// type specifies the check type.
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// success indicates if the check was successful.
	Success bool `protobuf:"varint,2,opt,name=success,proto3" json:"success,omitempty"`
	// message contains the error message if the check failed.
	Message string `protobuf:"bytes,3,opt,name=message,proto3" json:"message,omitempty"`
	// critical indicates that the dogu is out of order due to a failed check.
	Critical bool `protobuf:"varint,4,opt,name=critical,proto3" json:"critical,omitempty"`
	// contains filtered or unexported fields
}

func (*DoguHealthCheck) Descriptor deprecated

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

Deprecated: Use DoguHealthCheck.ProtoReflect.Descriptor instead.

func (*DoguHealthCheck) GetCritical

func (x *DoguHealthCheck) GetCritical() bool

func (*DoguHealthCheck) GetMessage

func (x *DoguHealthCheck) GetMessage() string

func (*DoguHealthCheck) GetSuccess

func (x *DoguHealthCheck) GetSuccess() bool

func (*DoguHealthCheck) GetType

func (x *DoguHealthCheck) GetType() string

func (*DoguHealthCheck) ProtoMessage

func (*DoguHealthCheck) ProtoMessage()

func (*DoguHealthCheck) ProtoReflect

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

func (*DoguHealthCheck) Reset

func (x *DoguHealthCheck) Reset()

func (*DoguHealthCheck) String

func (x *DoguHealthCheck) String() string

type DoguHealthClient

type DoguHealthClient interface {
	GetByName(ctx context.Context, in *DoguHealthRequest, opts ...grpc.CallOption) (*DoguHealthResponse, error)
	GetByNames(ctx context.Context, in *DoguHealthListRequest, opts ...grpc.CallOption) (*DoguHealthMapResponse, error)
	GetAll(ctx context.Context, in *DoguHealthAllRequest, opts ...grpc.CallOption) (*DoguHealthMapResponse, error)
}

DoguHealthClient is the client API for DoguHealth 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 NewDoguHealthClient

func NewDoguHealthClient(cc grpc.ClientConnInterface) DoguHealthClient

type DoguHealthListRequest

type DoguHealthListRequest struct {

	// protolint:disable:next REPEATED_FIELD_NAMES_PLURALIZED
	Dogus []string `protobuf:"bytes,1,rep,name=dogus,proto3" json:"dogus,omitempty"`
	// contains filtered or unexported fields
}

DoguHealthListRequest contains the data which are used to retrieve health information about specific dogus.

func (*DoguHealthListRequest) Descriptor deprecated

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

Deprecated: Use DoguHealthListRequest.ProtoReflect.Descriptor instead.

func (*DoguHealthListRequest) GetDogus

func (x *DoguHealthListRequest) GetDogus() []string

func (*DoguHealthListRequest) ProtoMessage

func (*DoguHealthListRequest) ProtoMessage()

func (*DoguHealthListRequest) ProtoReflect

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

func (*DoguHealthListRequest) Reset

func (x *DoguHealthListRequest) Reset()

func (*DoguHealthListRequest) String

func (x *DoguHealthListRequest) String() string

type DoguHealthMapResponse

type DoguHealthMapResponse struct {

	// all_healthy indicates if all installed dogus have passed the available checks successfully.
	AllHealthy bool `protobuf:"varint,1,opt,name=all_healthy,json=allHealthy,proto3" json:"all_healthy,omitempty"`
	// data provides access to the health check results of all installed dogus
	// it can be accessed via the dogu name as key
	Results map[string]*DoguHealthResponse `` /* 155-byte string literal not displayed */
	// contains filtered or unexported fields
}

DoguHealthListResponse contains health information about the all installed dogus and the status of the services answer.

func (*DoguHealthMapResponse) Descriptor deprecated

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

Deprecated: Use DoguHealthMapResponse.ProtoReflect.Descriptor instead.

func (*DoguHealthMapResponse) GetAllHealthy

func (x *DoguHealthMapResponse) GetAllHealthy() bool

func (*DoguHealthMapResponse) GetResults

func (x *DoguHealthMapResponse) GetResults() map[string]*DoguHealthResponse

func (*DoguHealthMapResponse) ProtoMessage

func (*DoguHealthMapResponse) ProtoMessage()

func (*DoguHealthMapResponse) ProtoReflect

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

func (*DoguHealthMapResponse) Reset

func (x *DoguHealthMapResponse) Reset()

func (*DoguHealthMapResponse) String

func (x *DoguHealthMapResponse) String() string

type DoguHealthRequest

type DoguHealthRequest struct {

	// dogu_name contains the name of the dogu for which the health checks should be executed.
	DoguName string `protobuf:"bytes,1,opt,name=dogu_name,json=doguName,proto3" json:"dogu_name,omitempty"`
	// contains filtered or unexported fields
}

DoguHealthRequest contains the name of dogu whose health check information should be retrieved.

func (*DoguHealthRequest) Descriptor deprecated

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

Deprecated: Use DoguHealthRequest.ProtoReflect.Descriptor instead.

func (*DoguHealthRequest) GetDoguName

func (x *DoguHealthRequest) GetDoguName() string

func (*DoguHealthRequest) ProtoMessage

func (*DoguHealthRequest) ProtoMessage()

func (*DoguHealthRequest) ProtoReflect

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

func (*DoguHealthRequest) Reset

func (x *DoguHealthRequest) Reset()

func (*DoguHealthRequest) String

func (x *DoguHealthRequest) String() string

type DoguHealthResponse

type DoguHealthResponse struct {

	// full_name contains the name of the dogu whose health information was retrieved including the namespace.
	FullName string `protobuf:"bytes,1,opt,name=full_name,json=fullName,proto3" json:"full_name,omitempty"`
	// short_name contains the dogu name without namespace.
	ShortName string `protobuf:"bytes,2,opt,name=short_name,json=shortName,proto3" json:"short_name,omitempty"`
	// display_name contains the name which will be displayed in the UI.
	DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// healthy indicates if all health checks passed successfully.
	Healthy bool `protobuf:"varint,4,opt,name=healthy,proto3" json:"healthy,omitempty"`
	// data provides access to the health check results of the requested dogu.
	Results []*DoguHealthCheck `protobuf:"bytes,5,rep,name=results,proto3" json:"results,omitempty"`
	// contains filtered or unexported fields
}

DoguHealthResponse contains health information about a specific dogu and the status of the services answer.

func (*DoguHealthResponse) Descriptor deprecated

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

Deprecated: Use DoguHealthResponse.ProtoReflect.Descriptor instead.

func (*DoguHealthResponse) GetDisplayName

func (x *DoguHealthResponse) GetDisplayName() string

func (*DoguHealthResponse) GetFullName

func (x *DoguHealthResponse) GetFullName() string

func (*DoguHealthResponse) GetHealthy

func (x *DoguHealthResponse) GetHealthy() bool

func (*DoguHealthResponse) GetResults

func (x *DoguHealthResponse) GetResults() []*DoguHealthCheck

func (*DoguHealthResponse) GetShortName

func (x *DoguHealthResponse) GetShortName() string

func (*DoguHealthResponse) ProtoMessage

func (*DoguHealthResponse) ProtoMessage()

func (*DoguHealthResponse) ProtoReflect

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

func (*DoguHealthResponse) Reset

func (x *DoguHealthResponse) Reset()

func (*DoguHealthResponse) String

func (x *DoguHealthResponse) String() string

type DoguHealthServer

type DoguHealthServer interface {
	GetByName(context.Context, *DoguHealthRequest) (*DoguHealthResponse, error)
	GetByNames(context.Context, *DoguHealthListRequest) (*DoguHealthMapResponse, error)
	GetAll(context.Context, *DoguHealthAllRequest) (*DoguHealthMapResponse, error)
	// contains filtered or unexported methods
}

DoguHealthServer is the server API for DoguHealth service. All implementations must embed UnimplementedDoguHealthServer for forward compatibility

type UnimplementedDoguHealthServer

type UnimplementedDoguHealthServer struct {
}

UnimplementedDoguHealthServer must be embedded to have forward compatible implementations.

func (UnimplementedDoguHealthServer) GetAll

func (UnimplementedDoguHealthServer) GetByName

func (UnimplementedDoguHealthServer) GetByNames

type UnsafeDoguHealthServer

type UnsafeDoguHealthServer interface {
	// contains filtered or unexported methods
}

UnsafeDoguHealthServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to DoguHealthServer will result in compilation errors.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL