commonv1connect

Documentation

Index

• Constants
• func NewStatusServiceHandler(svc StatusServiceHandler, opts ...connect_go.HandlerOption) (string, http.Handler)
• func RegisterStatusServiceHandler(mux *mux.Router, svc StatusServiceHandler, opts ...connect_go.HandlerOption)
• type StatusServiceClient
  • func NewStatusServiceClient(httpClient connect_go.HTTPClient, baseURL string, ...) StatusServiceClient
• type StatusServiceHandler
• type UnimplementedStatusServiceHandler
  • func (UnimplementedStatusServiceHandler) GetBuildInfo(context.Context, *connect_go.Request[v1.GetBuildInfoRequest]) (*connect_go.Response[v1.GetBuildInfoResponse], error)
  • func (UnimplementedStatusServiceHandler) GetConfig(context.Context, *connect_go.Request[v1.GetConfigRequest]) (*connect_go.Response[httpbody.HttpBody], error)
  • func (UnimplementedStatusServiceHandler) GetDefaultConfig(context.Context, *connect_go.Request[v1.GetConfigRequest]) (*connect_go.Response[httpbody.HttpBody], error)
  • func (UnimplementedStatusServiceHandler) GetDiffConfig(context.Context, *connect_go.Request[v1.GetConfigRequest]) (*connect_go.Response[httpbody.HttpBody], error)

Constants

const (
	// StatusServiceName is the fully-qualified name of the StatusService service.
	StatusServiceName = "common.v1.StatusService"
)

Functions

func NewStatusServiceHandler

func NewStatusServiceHandler(svc StatusServiceHandler, opts ...connect_go.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_go.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_go.Request[v1.GetBuildInfoRequest]) (*connect_go.Response[v1.GetBuildInfoResponse], error)
	// Retrieve the running config
	GetConfig(context.Context, *connect_go.Request[v1.GetConfigRequest]) (*connect_go.Response[httpbody.HttpBody], error)
	// Retrieve the diff config to the defaults
	GetDiffConfig(context.Context, *connect_go.Request[v1.GetConfigRequest]) (*connect_go.Response[httpbody.HttpBody], error)
	GetDefaultConfig(context.Context, *connect_go.Request[v1.GetConfigRequest]) (*connect_go.Response[httpbody.HttpBody], error)
}

StatusServiceClient is a client for the common.v1.StatusService service.

func NewStatusServiceClient

func NewStatusServiceClient(httpClient connect_go.HTTPClient, baseURL string, opts ...connect_go.ClientOption) StatusServiceClient

NewStatusServiceClient constructs a client for the common.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_go.Request[v1.GetBuildInfoRequest]) (*connect_go.Response[v1.GetBuildInfoResponse], error)
	// Retrieve the running config
	GetConfig(context.Context, *connect_go.Request[v1.GetConfigRequest]) (*connect_go.Response[httpbody.HttpBody], error)
	// Retrieve the diff config to the defaults
	GetDiffConfig(context.Context, *connect_go.Request[v1.GetConfigRequest]) (*connect_go.Response[httpbody.HttpBody], error)
	GetDefaultConfig(context.Context, *connect_go.Request[v1.GetConfigRequest]) (*connect_go.Response[httpbody.HttpBody], error)
}

StatusServiceHandler is an implementation of the common.v1.StatusService service.

type UnimplementedStatusServiceHandler

type UnimplementedStatusServiceHandler struct{}

UnimplementedStatusServiceHandler returns CodeUnimplemented from all methods.

func (UnimplementedStatusServiceHandler) GetBuildInfo

func (UnimplementedStatusServiceHandler) GetBuildInfo(context.Context, *connect_go.Request[v1.GetBuildInfoRequest]) (*connect_go.Response[v1.GetBuildInfoResponse], error)

func (UnimplementedStatusServiceHandler) GetConfig

func (UnimplementedStatusServiceHandler) GetConfig(context.Context, *connect_go.Request[v1.GetConfigRequest]) (*connect_go.Response[httpbody.HttpBody], error)

func (UnimplementedStatusServiceHandler) GetDefaultConfig

func (UnimplementedStatusServiceHandler) GetDefaultConfig(context.Context, *connect_go.Request[v1.GetConfigRequest]) (*connect_go.Response[httpbody.HttpBody], error)

func (UnimplementedStatusServiceHandler) GetDiffConfig

func (UnimplementedStatusServiceHandler) GetDiffConfig(context.Context, *connect_go.Request[v1.GetConfigRequest]) (*connect_go.Response[httpbody.HttpBody], error)