Documentation
¶
Index ¶
- Constants
- func NewCompactionPlannerHandler(svc CompactionPlannerHandler, opts ...connect.HandlerOption) (string, http.Handler)
- func RegisterCompactionPlannerHandler(mux *mux.Router, svc CompactionPlannerHandler, opts ...connect.HandlerOption)
- type CompactionPlannerClient
- type CompactionPlannerHandler
- type UnimplementedCompactionPlannerHandler
- func (UnimplementedCompactionPlannerHandler) GetCompactionJobs(context.Context, *connect.Request[v1.GetCompactionRequest]) (*connect.Response[v1.GetCompactionResponse], error)
- func (UnimplementedCompactionPlannerHandler) PollCompactionJobs(context.Context, *connect.Request[v1.PollCompactionJobsRequest]) (*connect.Response[v1.PollCompactionJobsResponse], error)
Constants ¶
const ( // CompactionPlannerPollCompactionJobsProcedure is the fully-qualified name of the // CompactionPlanner's PollCompactionJobs RPC. CompactionPlannerPollCompactionJobsProcedure = "/compactor.v1.CompactionPlanner/PollCompactionJobs" // CompactionPlannerGetCompactionJobsProcedure is the fully-qualified name of the // CompactionPlanner's GetCompactionJobs RPC. CompactionPlannerGetCompactionJobsProcedure = "/compactor.v1.CompactionPlanner/GetCompactionJobs" )
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 (
// CompactionPlannerName is the fully-qualified name of the CompactionPlanner service.
CompactionPlannerName = "compactor.v1.CompactionPlanner"
)
Variables ¶
This section is empty.
Functions ¶
func NewCompactionPlannerHandler ¶
func NewCompactionPlannerHandler(svc CompactionPlannerHandler, opts ...connect.HandlerOption) (string, http.Handler)
NewCompactionPlannerHandler 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.
func RegisterCompactionPlannerHandler ¶
func RegisterCompactionPlannerHandler(mux *mux.Router, svc CompactionPlannerHandler, opts ...connect.HandlerOption)
RegisterCompactionPlannerHandler register an HTTP handler to a mux.Router from the service implementation.
Types ¶
type CompactionPlannerClient ¶
type CompactionPlannerClient interface {
// Used to both retrieve jobs and update the jobs status at the same time.
PollCompactionJobs(context.Context, *connect.Request[v1.PollCompactionJobsRequest]) (*connect.Response[v1.PollCompactionJobsResponse], error)
// Used for admin purposes only.
GetCompactionJobs(context.Context, *connect.Request[v1.GetCompactionRequest]) (*connect.Response[v1.GetCompactionResponse], error)
}
CompactionPlannerClient is a client for the compactor.v1.CompactionPlanner service.
func NewCompactionPlannerClient ¶
func NewCompactionPlannerClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) CompactionPlannerClient
NewCompactionPlannerClient constructs a client for the compactor.v1.CompactionPlanner 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 CompactionPlannerHandler ¶
type CompactionPlannerHandler interface {
// Used to both retrieve jobs and update the jobs status at the same time.
PollCompactionJobs(context.Context, *connect.Request[v1.PollCompactionJobsRequest]) (*connect.Response[v1.PollCompactionJobsResponse], error)
// Used for admin purposes only.
GetCompactionJobs(context.Context, *connect.Request[v1.GetCompactionRequest]) (*connect.Response[v1.GetCompactionResponse], error)
}
CompactionPlannerHandler is an implementation of the compactor.v1.CompactionPlanner service.
type UnimplementedCompactionPlannerHandler ¶
type UnimplementedCompactionPlannerHandler struct{}
UnimplementedCompactionPlannerHandler returns CodeUnimplemented from all methods.
func (UnimplementedCompactionPlannerHandler) GetCompactionJobs ¶
func (UnimplementedCompactionPlannerHandler) GetCompactionJobs(context.Context, *connect.Request[v1.GetCompactionRequest]) (*connect.Response[v1.GetCompactionResponse], error)
func (UnimplementedCompactionPlannerHandler) PollCompactionJobs ¶
func (UnimplementedCompactionPlannerHandler) PollCompactionJobs(context.Context, *connect.Request[v1.PollCompactionJobsRequest]) (*connect.Response[v1.PollCompactionJobsResponse], error)
Source Files