Documentation
¶
Index ¶
- Constants
- func NewStatusServiceHandler(svc StatusServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
- func RegisterStatusServiceHandler(mux *mux.Router, svc StatusServiceHandler, opts ...connect.HandlerOption)
- type StatusServiceClient
- type StatusServiceHandler
- type UnimplementedStatusServiceHandler
- func (UnimplementedStatusServiceHandler) GetBuildInfo(context.Context, *connect.Request[v1.GetBuildInfoRequest]) (*connect.Response[v1.GetBuildInfoResponse], error)
- func (UnimplementedStatusServiceHandler) GetConfig(context.Context, *connect.Request[v1.GetConfigRequest]) (*connect.Response[httpbody.HttpBody], error)
- func (UnimplementedStatusServiceHandler) GetDefaultConfig(context.Context, *connect.Request[v1.GetConfigRequest]) (*connect.Response[httpbody.HttpBody], error)
- func (UnimplementedStatusServiceHandler) GetDiffConfig(context.Context, *connect.Request[v1.GetConfigRequest]) (*connect.Response[httpbody.HttpBody], error)
Constants ¶
const ( // StatusServiceGetBuildInfoProcedure is the fully-qualified name of the StatusService's // GetBuildInfo RPC. StatusServiceGetBuildInfoProcedure = "/status.v1.StatusService/GetBuildInfo" // StatusServiceGetConfigProcedure is the fully-qualified name of the StatusService's GetConfig RPC. StatusServiceGetConfigProcedure = "/status.v1.StatusService/GetConfig" // StatusServiceGetDiffConfigProcedure is the fully-qualified name of the StatusService's // GetDiffConfig RPC. StatusServiceGetDiffConfigProcedure = "/status.v1.StatusService/GetDiffConfig" // StatusServiceGetDefaultConfigProcedure is the fully-qualified name of the StatusService's // GetDefaultConfig RPC. StatusServiceGetDefaultConfigProcedure = "/status.v1.StatusService/GetDefaultConfig" )
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 (
// StatusServiceName is the fully-qualified name of the StatusService service.
StatusServiceName = "status.v1.StatusService"
)
Variables ¶
This section is empty.
Functions ¶
func NewStatusServiceHandler ¶
func NewStatusServiceHandler(svc StatusServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
NewStatusServiceHandler 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 RegisterStatusServiceHandler ¶
func RegisterStatusServiceHandler(mux *mux.Router, svc StatusServiceHandler, opts ...connect.HandlerOption)
RegisterStatusServiceHandler register an HTTP handler to a mux.Router from the service implementation.
Types ¶
type StatusServiceClient ¶
type StatusServiceClient interface {
// Retrieve build information about the binary
GetBuildInfo(context.Context, *connect.Request[v1.GetBuildInfoRequest]) (*connect.Response[v1.GetBuildInfoResponse], error)
// Retrieve the running config
GetConfig(context.Context, *connect.Request[v1.GetConfigRequest]) (*connect.Response[httpbody.HttpBody], error)
// Retrieve the diff config to the defaults
GetDiffConfig(context.Context, *connect.Request[v1.GetConfigRequest]) (*connect.Response[httpbody.HttpBody], error)
GetDefaultConfig(context.Context, *connect.Request[v1.GetConfigRequest]) (*connect.Response[httpbody.HttpBody], error)
}
StatusServiceClient is a client for the status.v1.StatusService service.
func NewStatusServiceClient ¶
func NewStatusServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) StatusServiceClient
NewStatusServiceClient constructs a client for the status.v1.StatusService 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 StatusServiceHandler ¶
type StatusServiceHandler interface {
// Retrieve build information about the binary
GetBuildInfo(context.Context, *connect.Request[v1.GetBuildInfoRequest]) (*connect.Response[v1.GetBuildInfoResponse], error)
// Retrieve the running config
GetConfig(context.Context, *connect.Request[v1.GetConfigRequest]) (*connect.Response[httpbody.HttpBody], error)
// Retrieve the diff config to the defaults
GetDiffConfig(context.Context, *connect.Request[v1.GetConfigRequest]) (*connect.Response[httpbody.HttpBody], error)
GetDefaultConfig(context.Context, *connect.Request[v1.GetConfigRequest]) (*connect.Response[httpbody.HttpBody], error)
}
StatusServiceHandler is an implementation of the status.v1.StatusService service.
type UnimplementedStatusServiceHandler ¶
type UnimplementedStatusServiceHandler struct{}
UnimplementedStatusServiceHandler returns CodeUnimplemented from all methods.
func (UnimplementedStatusServiceHandler) GetBuildInfo ¶
func (UnimplementedStatusServiceHandler) GetBuildInfo(context.Context, *connect.Request[v1.GetBuildInfoRequest]) (*connect.Response[v1.GetBuildInfoResponse], error)
Source Files