usagev1alpha1connect

Documentation

Index

• Constants
• func NewUsageServiceHandler(svc UsageServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
• type UnimplementedUsageServiceHandler
  • func (UnimplementedUsageServiceHandler) ReportUsage(context.Context, *connect.Request[v1alpha1.ReportUsageRequest]) (*connect.Response[v1alpha1.ReportUsageResponse], error)
• type UsageServiceClient
  • func NewUsageServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) UsageServiceClient
• type UsageServiceHandler

Constants

const (
	// UsageServiceName is the fully-qualified name of the UsageService service.
	UsageServiceName = "commonfate.factory.usage.v1alpha1.UsageService"
)

const (
	// UsageServiceReportUsageProcedure is the fully-qualified name of the UsageService's ReportUsage
	// RPC.
	UsageServiceReportUsageProcedure = "/commonfate.factory.usage.v1alpha1.UsageService/ReportUsage"
)

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.

Functions

func NewUsageServiceHandler

func NewUsageServiceHandler(svc UsageServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewUsageServiceHandler 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 UnimplementedUsageServiceHandler

type UnimplementedUsageServiceHandler struct{}

UnimplementedUsageServiceHandler returns CodeUnimplemented from all methods.

func (UnimplementedUsageServiceHandler) ReportUsage

func (UnimplementedUsageServiceHandler) ReportUsage(context.Context, *connect.Request[v1alpha1.ReportUsageRequest]) (*connect.Response[v1alpha1.ReportUsageResponse], error)

type UsageServiceClient

type UsageServiceClient interface {
	// Report usage of the Common Fate deployment.
	ReportUsage(context.Context, *connect.Request[v1alpha1.ReportUsageRequest]) (*connect.Response[v1alpha1.ReportUsageResponse], error)
}

UsageServiceClient is a client for the commonfate.factory.usage.v1alpha1.UsageService service.

func NewUsageServiceClient

func NewUsageServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) UsageServiceClient

NewUsageServiceClient constructs a client for the commonfate.factory.usage.v1alpha1.UsageService 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 UsageServiceHandler

type UsageServiceHandler interface {
	// Report usage of the Common Fate deployment.
	ReportUsage(context.Context, *connect.Request[v1alpha1.ReportUsageRequest]) (*connect.Response[v1alpha1.ReportUsageResponse], error)
}

UsageServiceHandler is an implementation of the commonfate.factory.usage.v1alpha1.UsageService service.