userconnect

package
v0.86.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 2, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// UserServiceCreateUserProcedure is the fully-qualified name of the UserService's CreateUser RPC.
	UserServiceCreateUserProcedure = "/holos.user.v1alpha1.UserService/CreateUser"
	// UserServiceGetUserProcedure is the fully-qualified name of the UserService's GetUser RPC.
	UserServiceGetUserProcedure = "/holos.user.v1alpha1.UserService/GetUser"
	// UserServiceRegisterUserProcedure is the fully-qualified name of the UserService's RegisterUser
	// RPC.
	UserServiceRegisterUserProcedure = "/holos.user.v1alpha1.UserService/RegisterUser"
)

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.

View Source
const (
	// UserServiceName is the fully-qualified name of the UserService service.
	UserServiceName = "holos.user.v1alpha1.UserService"
)

Variables

This section is empty.

Functions

func NewUserServiceHandler

func NewUserServiceHandler(svc UserServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewUserServiceHandler 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 UnimplementedUserServiceHandler

type UnimplementedUserServiceHandler struct{}

UnimplementedUserServiceHandler returns CodeUnimplemented from all methods.

type UserServiceClient

type UserServiceClient interface {
	// Create a new user from authenticated claims or the provided User resource.
	CreateUser(context.Context, *connect.Request[v1alpha1.CreateUserRequest]) (*connect.Response[v1alpha1.CreateUserResponse], error)
	// Get an existing user by id, email, or subject.
	GetUser(context.Context, *connect.Request[v1alpha1.GetUserRequest]) (*connect.Response[v1alpha1.GetUserResponse], error)
	// Register an user and initialize an organization, bare platform, and reference platform.
	RegisterUser(context.Context, *connect.Request[v1alpha1.RegisterUserRequest]) (*connect.Response[v1alpha1.RegisterUserResponse], error)
}

UserServiceClient is a client for the holos.user.v1alpha1.UserService service.

func NewUserServiceClient

func NewUserServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) UserServiceClient

NewUserServiceClient constructs a client for the holos.user.v1alpha1.UserService 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 UserServiceHandler

type UserServiceHandler interface {
	// Create a new user from authenticated claims or the provided User resource.
	CreateUser(context.Context, *connect.Request[v1alpha1.CreateUserRequest]) (*connect.Response[v1alpha1.CreateUserResponse], error)
	// Get an existing user by id, email, or subject.
	GetUser(context.Context, *connect.Request[v1alpha1.GetUserRequest]) (*connect.Response[v1alpha1.GetUserResponse], error)
	// Register an user and initialize an organization, bare platform, and reference platform.
	RegisterUser(context.Context, *connect.Request[v1alpha1.RegisterUserRequest]) (*connect.Response[v1alpha1.RegisterUserResponse], error)
}

UserServiceHandler is an implementation of the holos.user.v1alpha1.UserService service.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL