Documentation
¶
Overview ¶
Package maping.v1 is the mAPI-ng ingest wire contract.
This schema is a PUBLIC, STABLE contract: the client library is open source (MIT, ADR-0004), so third parties may build against it. Evolve it backward-compatibly only — `buf breaking` is enforced in CI from commit 1. The DDSketch bucket layout (gamma/offset) is frozen and versioned by sketch_format_version; see ADR-0001 and ADR-0003.
Index ¶
Constants ¶
const ( // IngestServiceRegisterProcedure is the fully-qualified name of the IngestService's Register RPC. IngestServiceRegisterProcedure = "/maping.v1.IngestService/Register" // IngestServiceUploadProcedure is the fully-qualified name of the IngestService's Upload RPC. IngestServiceUploadProcedure = "/maping.v1.IngestService/Upload" )
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.
const (
// IngestServiceName is the fully-qualified name of the IngestService service.
IngestServiceName = "maping.v1.IngestService"
)
Variables ¶
This section is empty.
Functions ¶
func NewIngestServiceHandler ¶
func NewIngestServiceHandler(svc IngestServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
NewIngestServiceHandler 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 IngestServiceClient ¶
type IngestServiceClient interface {
Register(context.Context, *connect.Request[v1.Handshake]) (*connect.Response[v1.RegisterResponse], error)
Upload(context.Context, *connect.Request[v1.UploadRequest]) (*connect.Response[v1.UploadResponse], error)
}
IngestServiceClient is a client for the maping.v1.IngestService service.
func NewIngestServiceClient ¶
func NewIngestServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) IngestServiceClient
NewIngestServiceClient constructs a client for the maping.v1.IngestService 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 IngestServiceHandler ¶
type IngestServiceHandler interface {
Register(context.Context, *connect.Request[v1.Handshake]) (*connect.Response[v1.RegisterResponse], error)
Upload(context.Context, *connect.Request[v1.UploadRequest]) (*connect.Response[v1.UploadResponse], error)
}
IngestServiceHandler is an implementation of the maping.v1.IngestService service.
type UnimplementedIngestServiceHandler ¶
type UnimplementedIngestServiceHandler struct{}
UnimplementedIngestServiceHandler returns CodeUnimplemented from all methods.
func (UnimplementedIngestServiceHandler) Upload ¶
func (UnimplementedIngestServiceHandler) Upload(context.Context, *connect.Request[v1.UploadRequest]) (*connect.Response[v1.UploadResponse], error)
Source Files