idpconnect

package
v1.8.29 Latest Latest
Warning

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

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

Documentation

Index

Constants

View Source
const (
	// IdpServiceCreateClientProcedure is the fully-qualified name of the IdpService's CreateClient RPC.
	IdpServiceCreateClientProcedure = "/api.v1alpha1.org.idp.IdpService/CreateClient"
	// IdpServiceUpdateClientProcedure is the fully-qualified name of the IdpService's UpdateClient RPC.
	IdpServiceUpdateClientProcedure = "/api.v1alpha1.org.idp.IdpService/UpdateClient"
	// IdpServiceDeleteClientProcedure is the fully-qualified name of the IdpService's DeleteClient RPC.
	IdpServiceDeleteClientProcedure = "/api.v1alpha1.org.idp.IdpService/DeleteClient"
	// IdpServiceListClientsProcedure is the fully-qualified name of the IdpService's ListClients RPC.
	IdpServiceListClientsProcedure = "/api.v1alpha1.org.idp.IdpService/ListClients"
)

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 (
	// IdpServiceName is the fully-qualified name of the IdpService service.
	IdpServiceName = "api.v1alpha1.org.idp.IdpService"
)

Variables

This section is empty.

Functions

func NewIdpServiceHandler

func NewIdpServiceHandler(svc IdpServiceHandler, opts ...connect_go.HandlerOption) (string, http.Handler)

NewIdpServiceHandler 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 IdpServiceClient

type IdpServiceClient interface {
	// CreateClient creates a client.
	CreateClient(context.Context, *connect_go.Request[idp.CreateClientRequest]) (*connect_go.Response[idp.CreateClientResponse], error)
	// UpdateClient updates an existing client
	UpdateClient(context.Context, *connect_go.Request[idp.UpdateClientRequest]) (*connect_go.Response[idp.UpdateClientResponse], error)
	// DeleteClient deletes the provided client.
	DeleteClient(context.Context, *connect_go.Request[idp.DeleteClientRequest]) (*connect_go.Response[idp.DeleteClientResponse], error)
	// ListClients returns all clients.
	ListClients(context.Context, *connect_go.Request[idp.ListClientsRequest]) (*connect_go.Response[idp.ListClientsResponse], error)
}

IdpServiceClient is a client for the api.v1alpha1.org.idp.IdpService service.

func NewIdpServiceClient

func NewIdpServiceClient(httpClient connect_go.HTTPClient, baseURL string, opts ...connect_go.ClientOption) IdpServiceClient

NewIdpServiceClient constructs a client for the api.v1alpha1.org.idp.IdpService 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 IdpServiceHandler

type IdpServiceHandler interface {
	// CreateClient creates a client.
	CreateClient(context.Context, *connect_go.Request[idp.CreateClientRequest]) (*connect_go.Response[idp.CreateClientResponse], error)
	// UpdateClient updates an existing client
	UpdateClient(context.Context, *connect_go.Request[idp.UpdateClientRequest]) (*connect_go.Response[idp.UpdateClientResponse], error)
	// DeleteClient deletes the provided client.
	DeleteClient(context.Context, *connect_go.Request[idp.DeleteClientRequest]) (*connect_go.Response[idp.DeleteClientResponse], error)
	// ListClients returns all clients.
	ListClients(context.Context, *connect_go.Request[idp.ListClientsRequest]) (*connect_go.Response[idp.ListClientsResponse], error)
}

IdpServiceHandler is an implementation of the api.v1alpha1.org.idp.IdpService service.

type UnimplementedIdpServiceHandler

type UnimplementedIdpServiceHandler struct{}

UnimplementedIdpServiceHandler returns CodeUnimplemented from all methods.

Jump to

Keyboard shortcuts

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