apiv1connect

Documentation

Index

• Constants
• func NewApiServiceHandler(svc ApiServiceHandler, opts ...connect_go.HandlerOption) (string, http.Handler)
• type ApiServiceClient
  • func NewApiServiceClient(httpClient connect_go.HTTPClient, baseURL string, ...) ApiServiceClient
• type ApiServiceHandler
• type UnimplementedApiServiceHandler
  • func (UnimplementedApiServiceHandler) ListNodes(context.Context, *connect_go.Request[v1.ListNodesRequest]) (*connect_go.Response[v1.ListNodesResponse], error)
  • func (UnimplementedApiServiceHandler) ListSamples(context.Context, *connect_go.Request[v1.ListSampleRequest]) (*connect_go.Response[v1.ListSampleResponse], error)

Constants

const (
	// ApiServiceName is the fully-qualified name of the ApiService service.
	ApiServiceName = "api.v1.ApiService"
)

Functions

func NewApiServiceHandler

func NewApiServiceHandler(svc ApiServiceHandler, opts ...connect_go.HandlerOption) (string, http.Handler)

NewApiServiceHandler 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 ApiServiceClient

type ApiServiceClient interface {
	ListSamples(context.Context, *connect_go.Request[v1.ListSampleRequest]) (*connect_go.Response[v1.ListSampleResponse], error)
	ListNodes(context.Context, *connect_go.Request[v1.ListNodesRequest]) (*connect_go.Response[v1.ListNodesResponse], error)
}

ApiServiceClient is a client for the api.v1.ApiService service.

func NewApiServiceClient

func NewApiServiceClient(httpClient connect_go.HTTPClient, baseURL string, opts ...connect_go.ClientOption) ApiServiceClient

NewApiServiceClient constructs a client for the api.v1.ApiService 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 ApiServiceHandler

type ApiServiceHandler interface {
	ListSamples(context.Context, *connect_go.Request[v1.ListSampleRequest]) (*connect_go.Response[v1.ListSampleResponse], error)
	ListNodes(context.Context, *connect_go.Request[v1.ListNodesRequest]) (*connect_go.Response[v1.ListNodesResponse], error)
}

ApiServiceHandler is an implementation of the api.v1.ApiService service.

type UnimplementedApiServiceHandler

type UnimplementedApiServiceHandler struct{}

UnimplementedApiServiceHandler returns CodeUnimplemented from all methods.

func (UnimplementedApiServiceHandler) ListNodes

func (UnimplementedApiServiceHandler) ListNodes(context.Context, *connect_go.Request[v1.ListNodesRequest]) (*connect_go.Response[v1.ListNodesResponse], error)

func (UnimplementedApiServiceHandler) ListSamples

func (UnimplementedApiServiceHandler) ListSamples(context.Context, *connect_go.Request[v1.ListSampleRequest]) (*connect_go.Response[v1.ListSampleResponse], error)