Documentation
¶
Index ¶
- Constants
- func NewLogsHandler(svc LogsHandler, opts ...connect.HandlerOption) (string, http.Handler)
- func NewPlansHandler(svc PlansHandler, opts ...connect.HandlerOption) (string, http.Handler)
- type LogsClient
- type LogsHandler
- type PlansClient
- type PlansHandler
- type UnimplementedLogsHandler
- type UnimplementedPlansHandler
Constants ¶
const ( // LogsStreamLogsProcedure is the fully-qualified name of the Logs's StreamLogs RPC. LogsStreamLogsProcedure = "/agent.v1.Logs/StreamLogs" // LogsUploadLogsProcedure is the fully-qualified name of the Logs's UploadLogs RPC. LogsUploadLogsProcedure = "/agent.v1.Logs/UploadLogs" )
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 (
// LogsName is the fully-qualified name of the Logs service.
LogsName = "agent.v1.Logs"
)
const (
// PlansName is the fully-qualified name of the Plans service.
PlansName = "agent.v1.Plans"
)
const (
// PlansUploadPlanProcedure is the fully-qualified name of the Plans's UploadPlan RPC.
PlansUploadPlanProcedure = "/agent.v1.Plans/UploadPlan"
)
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 NewLogsHandler ¶
func NewLogsHandler(svc LogsHandler, opts ...connect.HandlerOption) (string, http.Handler)
NewLogsHandler 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 NewPlansHandler ¶
func NewPlansHandler(svc PlansHandler, opts ...connect.HandlerOption) (string, http.Handler)
NewPlansHandler 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 LogsClient ¶
type LogsClient interface {
StreamLogs(context.Context, *connect.Request[v1.StreamLogsRequest]) (*connect.Response[v1.StreamLogsResponse], error)
UploadLogs(context.Context, *connect.Request[v1.UploadLogsRequest]) (*connect.Response[v1.UploadLogsResponse], error)
}
LogsClient is a client for the agent.v1.Logs service.
func NewLogsClient ¶
func NewLogsClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) LogsClient
NewLogsClient constructs a client for the agent.v1.Logs 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 LogsHandler ¶
type LogsHandler interface {
StreamLogs(context.Context, *connect.Request[v1.StreamLogsRequest]) (*connect.Response[v1.StreamLogsResponse], error)
UploadLogs(context.Context, *connect.Request[v1.UploadLogsRequest]) (*connect.Response[v1.UploadLogsResponse], error)
}
LogsHandler is an implementation of the agent.v1.Logs service.
type PlansClient ¶
type PlansClient interface {
UploadPlan(context.Context, *connect.Request[v1.UploadPlanRequest]) (*connect.Response[v1.UploadPlanResponse], error)
}
PlansClient is a client for the agent.v1.Plans service.
func NewPlansClient ¶
func NewPlansClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) PlansClient
NewPlansClient constructs a client for the agent.v1.Plans 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 PlansHandler ¶
type PlansHandler interface {
UploadPlan(context.Context, *connect.Request[v1.UploadPlanRequest]) (*connect.Response[v1.UploadPlanResponse], error)
}
PlansHandler is an implementation of the agent.v1.Plans service.
type UnimplementedLogsHandler ¶
type UnimplementedLogsHandler struct{}
UnimplementedLogsHandler returns CodeUnimplemented from all methods.
func (UnimplementedLogsHandler) StreamLogs ¶
func (UnimplementedLogsHandler) StreamLogs(context.Context, *connect.Request[v1.StreamLogsRequest]) (*connect.Response[v1.StreamLogsResponse], error)
func (UnimplementedLogsHandler) UploadLogs ¶
func (UnimplementedLogsHandler) UploadLogs(context.Context, *connect.Request[v1.UploadLogsRequest]) (*connect.Response[v1.UploadLogsResponse], error)
type UnimplementedPlansHandler ¶
type UnimplementedPlansHandler struct{}
UnimplementedPlansHandler returns CodeUnimplemented from all methods.
func (UnimplementedPlansHandler) UploadPlan ¶
func (UnimplementedPlansHandler) UploadPlan(context.Context, *connect.Request[v1.UploadPlanRequest]) (*connect.Response[v1.UploadPlanResponse], error)
Source Files