healthcheckv1

package
v0.0.0-...-89c8abe Latest Latest
Warning

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

 Go to latest Published: Apr 17, 2024 License: Apache-2.0 Imports: 29 Imported by: 0

Documentation

Overview

Package healthcheckv1 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source 
const (
	HealthcheckAPI_Healthcheck_FullMethodName = "/clutch.healthcheck.v1.HealthcheckAPI/Healthcheck"
)

Variables

View Source 
var File_healthcheck_v1_healthcheck_proto protoreflect.FileDescriptor
View Source 
var HealthcheckAPI_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "clutch.healthcheck.v1.HealthcheckAPI",
	HandlerType: (*HealthcheckAPIServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Healthcheck",
			Handler:    _HealthcheckAPI_Healthcheck_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "healthcheck/v1/healthcheck.proto",
}

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

Functions

func RegisterHealthcheckAPIHandler 

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

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

func RegisterHealthcheckAPIHandlerClient 

func RegisterHealthcheckAPIHandlerClient(ctx context.Context, mux *runtime.ServeMux, client HealthcheckAPIClient) error

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

func RegisterHealthcheckAPIHandlerFromEndpoint 

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

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

func RegisterHealthcheckAPIHandlerServer 

func RegisterHealthcheckAPIHandlerServer(ctx context.Context, mux *runtime.ServeMux, server HealthcheckAPIServer) error

RegisterHealthcheckAPIHandlerServer registers the http handlers for service HealthcheckAPI to "mux". UnaryRPC :call HealthcheckAPIServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterHealthcheckAPIHandlerFromEndpoint instead.

func RegisterHealthcheckAPIServer 

func RegisterHealthcheckAPIServer(s grpc.ServiceRegistrar, srv HealthcheckAPIServer)

Types

type HealthcheckAPIClient 

type HealthcheckAPIClient interface {
	Healthcheck(ctx context.Context, in *HealthcheckRequest, opts ...grpc.CallOption) (*HealthcheckResponse, error)
}

HealthcheckAPIClient is the client API for HealthcheckAPI 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 NewHealthcheckAPIClient 

func NewHealthcheckAPIClient(cc grpc.ClientConnInterface) HealthcheckAPIClient

type HealthcheckAPIServer 

type HealthcheckAPIServer interface {
	Healthcheck(context.Context, *HealthcheckRequest) (*HealthcheckResponse, error)
}

HealthcheckAPIServer is the server API for HealthcheckAPI service. All implementations should embed UnimplementedHealthcheckAPIServer for forward compatibility

type HealthcheckRequest 

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

func (*HealthcheckRequest) Descriptor deprecated 

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

Deprecated: Use HealthcheckRequest.ProtoReflect.Descriptor instead.

func (*HealthcheckRequest) ProtoMessage 

func (*HealthcheckRequest) ProtoMessage()

func (*HealthcheckRequest) ProtoReflect 

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

func (*HealthcheckRequest) Reset 

func (x *HealthcheckRequest) Reset()

func (*HealthcheckRequest) String 

func (x *HealthcheckRequest) String() string

func (*HealthcheckRequest) Validate 

func (m *HealthcheckRequest) Validate() error

Validate checks the field values on HealthcheckRequest with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*HealthcheckRequest) ValidateAll 

func (m *HealthcheckRequest) ValidateAll() error

ValidateAll checks the field values on HealthcheckRequest with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in HealthcheckRequestMultiError, or nil if none found.

type HealthcheckRequestMultiError 

type HealthcheckRequestMultiError []error

HealthcheckRequestMultiError is an error wrapping multiple validation errors returned by HealthcheckRequest.ValidateAll() if the designated constraints aren't met.

func (HealthcheckRequestMultiError) AllErrors 

func (m HealthcheckRequestMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (HealthcheckRequestMultiError) Error 

func (m HealthcheckRequestMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type HealthcheckRequestValidationError 

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

HealthcheckRequestValidationError is the validation error returned by HealthcheckRequest.Validate if the designated constraints aren't met.

func (HealthcheckRequestValidationError) Cause 

func (e HealthcheckRequestValidationError) Cause() error

Cause function returns cause value.

func (HealthcheckRequestValidationError) Error 

func (e HealthcheckRequestValidationError) Error() string

Error satisfies the builtin error interface

func (HealthcheckRequestValidationError) ErrorName 

func (e HealthcheckRequestValidationError) ErrorName() string

ErrorName returns error name.

func (HealthcheckRequestValidationError) Field 

func (e HealthcheckRequestValidationError) Field() string

Field function returns field value.

func (HealthcheckRequestValidationError) Key 

func (e HealthcheckRequestValidationError) Key() bool

Key function returns key value.

func (HealthcheckRequestValidationError) Reason 

func (e HealthcheckRequestValidationError) Reason() string

Reason function returns reason value.

type HealthcheckResponse 

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

func (*HealthcheckResponse) Descriptor deprecated 

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

Deprecated: Use HealthcheckResponse.ProtoReflect.Descriptor instead.

func (*HealthcheckResponse) ProtoMessage 

func (*HealthcheckResponse) ProtoMessage()

func (*HealthcheckResponse) ProtoReflect 

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

func (*HealthcheckResponse) Reset 

func (x *HealthcheckResponse) Reset()

func (*HealthcheckResponse) String 

func (x *HealthcheckResponse) String() string

func (*HealthcheckResponse) Validate 

func (m *HealthcheckResponse) Validate() error

Validate checks the field values on HealthcheckResponse with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*HealthcheckResponse) ValidateAll 

func (m *HealthcheckResponse) ValidateAll() error

ValidateAll checks the field values on HealthcheckResponse with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in HealthcheckResponseMultiError, or nil if none found.

type HealthcheckResponseMultiError 

type HealthcheckResponseMultiError []error

HealthcheckResponseMultiError is an error wrapping multiple validation errors returned by HealthcheckResponse.ValidateAll() if the designated constraints aren't met.

func (HealthcheckResponseMultiError) AllErrors 

func (m HealthcheckResponseMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (HealthcheckResponseMultiError) Error 

func (m HealthcheckResponseMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type HealthcheckResponseValidationError 

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

HealthcheckResponseValidationError is the validation error returned by HealthcheckResponse.Validate if the designated constraints aren't met.

func (HealthcheckResponseValidationError) Cause 

func (e HealthcheckResponseValidationError) Cause() error

Cause function returns cause value.

func (HealthcheckResponseValidationError) Error 

func (e HealthcheckResponseValidationError) Error() string

Error satisfies the builtin error interface

func (HealthcheckResponseValidationError) ErrorName 

func (e HealthcheckResponseValidationError) ErrorName() string

ErrorName returns error name.

func (HealthcheckResponseValidationError) Field 

func (e HealthcheckResponseValidationError) Field() string

Field function returns field value.

func (HealthcheckResponseValidationError) Key 

func (e HealthcheckResponseValidationError) Key() bool

Key function returns key value.

func (HealthcheckResponseValidationError) Reason 

func (e HealthcheckResponseValidationError) Reason() string

Reason function returns reason value.

type UnimplementedHealthcheckAPIServer 

type UnimplementedHealthcheckAPIServer struct {
}

UnimplementedHealthcheckAPIServer should be embedded to have forward compatible implementations.

func (UnimplementedHealthcheckAPIServer) Healthcheck 

func (UnimplementedHealthcheckAPIServer) Healthcheck(context.Context, *HealthcheckRequest) (*HealthcheckResponse, error)

type UnsafeHealthcheckAPIServer 

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

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

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.