apiv1connect

package
v0.1.6 Latest Latest
Warning

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

Go to latest
Published: Sep 21, 2023 License: Apache-2.0 Imports: 6 Imported by: 1

Documentation

Index

Constants

View Source
const (
	// VersionServiceName is the fully-qualified name of the VersionService service.
	VersionServiceName = "api.v1.VersionService"
)
View Source
const (
	// VersionServiceOperatorProcedure is the fully-qualified name of the VersionService's Operator RPC.
	VersionServiceOperatorProcedure = "/api.v1.VersionService/Operator"
)

These constants are the fully-qualified names of the RPCs defined in this package. They're exposed at runtime as Spec.Procedure and as the final two segments of the HTTP route.

Note that these are different from the fully-qualified method names used by google.golang.org/protobuf/reflect/protoreflect. To convert from these constants to reflection-formatted method names, remove the leading slash and convert the remaining slash to a period.

Variables

This section is empty.

Functions

func NewVersionServiceHandler

func NewVersionServiceHandler(svc VersionServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewVersionServiceHandler builds an HTTP handler from the service implementation. It returns the path on which to mount the handler and the handler itself.

By default, handlers support the Connect, gRPC, and gRPC-Web protocols with the binary Protobuf and JSON codecs. They also support gzip compression.

Types

type UnimplementedVersionServiceHandler

type UnimplementedVersionServiceHandler struct{}

UnimplementedVersionServiceHandler returns CodeUnimplemented from all methods.

type VersionServiceClient

type VersionServiceClient interface {
	// Used by the Koor operator to get the latest version of each depencency product based on the current product versions.
	Operator(context.Context, *connect.Request[v1.OperatorRequest]) (*connect.Response[v1.OperatorResponse], error)
}

VersionServiceClient is a client for the api.v1.VersionService service.

func NewVersionServiceClient

func NewVersionServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) VersionServiceClient

NewVersionServiceClient constructs a client for the api.v1.VersionService service. By default, it uses the Connect protocol with the binary Protobuf Codec, asks for gzipped responses, and sends uncompressed requests. To use the gRPC or gRPC-Web protocols, supply the connect.WithGRPC() or connect.WithGRPCWeb() options.

The URL supplied here should be the base URL for the Connect or gRPC server (for example, http://api.acme.com or https://acme.com/grpc).

type VersionServiceHandler

type VersionServiceHandler interface {
	// Used by the Koor operator to get the latest version of each depencency product based on the current product versions.
	Operator(context.Context, *connect.Request[v1.OperatorRequest]) (*connect.Response[v1.OperatorResponse], error)
}

VersionServiceHandler is an implementation of the api.v1.VersionService service.

Jump to

Keyboard shortcuts

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