apiv1connect

Documentation

Index

• Constants
• func NewCitizenServiceHandler(svc CitizenServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
• type CitizenServiceClient
  • func NewCitizenServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) CitizenServiceClient
• type CitizenServiceHandler
• type UnimplementedCitizenServiceHandler
  • func (UnimplementedCitizenServiceHandler) FindCitizenByDocId(context.Context, *connect.Request[v1.FindCitizenByDocIdRequest]) (*connect.Response[v1.FindCitizenByDocIdResponse], error)

Constants

const (
	// CitizenServiceFindCitizenByDocIdProcedure is the fully-qualified name of the CitizenService's
	// FindCitizenByDocId RPC.
	CitizenServiceFindCitizenByDocIdProcedure = "/shipment.api.v1.CitizenService/FindCitizenByDocId"
)

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 (
	// CitizenServiceName is the fully-qualified name of the CitizenService service.
	CitizenServiceName = "shipment.api.v1.CitizenService"
)

Functions

func NewCitizenServiceHandler

func NewCitizenServiceHandler(svc CitizenServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewCitizenServiceHandler 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 CitizenServiceClient

type CitizenServiceClient interface {
	FindCitizenByDocId(context.Context, *connect.Request[v1.FindCitizenByDocIdRequest]) (*connect.Response[v1.FindCitizenByDocIdResponse], error)
}

CitizenServiceClient is a client for the shipment.api.v1.CitizenService service.

func NewCitizenServiceClient

func NewCitizenServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) CitizenServiceClient

NewCitizenServiceClient constructs a client for the shipment.api.v1.CitizenService 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 CitizenServiceHandler

type CitizenServiceHandler interface {
	FindCitizenByDocId(context.Context, *connect.Request[v1.FindCitizenByDocIdRequest]) (*connect.Response[v1.FindCitizenByDocIdResponse], error)
}

CitizenServiceHandler is an implementation of the shipment.api.v1.CitizenService service.

type UnimplementedCitizenServiceHandler

type UnimplementedCitizenServiceHandler struct{}

UnimplementedCitizenServiceHandler returns CodeUnimplemented from all methods.

func (UnimplementedCitizenServiceHandler) FindCitizenByDocId

func (UnimplementedCitizenServiceHandler) FindCitizenByDocId(context.Context, *connect.Request[v1.FindCitizenByDocIdRequest]) (*connect.Response[v1.FindCitizenByDocIdResponse], error)