supportv1alpha1connect

package
v1.42.1 Latest Latest
Warning

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

Go to latest
Published: Jul 4, 2024 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// SupportServiceContactProcedure is the fully-qualified name of the SupportService's Contact RPC.
	SupportServiceContactProcedure = "/commonfate.control.support.v1alpha1.SupportService/Contact"
	// SupportServiceCreateAttachmentProcedure is the fully-qualified name of the SupportService's
	// CreateAttachment RPC.
	SupportServiceCreateAttachmentProcedure = "/commonfate.control.support.v1alpha1.SupportService/CreateAttachment"
)

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 (
	// SupportServiceName is the fully-qualified name of the SupportService service.
	SupportServiceName = "commonfate.control.support.v1alpha1.SupportService"
)

Variables

This section is empty.

Functions

func NewSupportServiceHandler

func NewSupportServiceHandler(svc SupportServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewSupportServiceHandler 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 SupportServiceClient

type SupportServiceClient interface {
	// Contact Common Fate support.
	Contact(context.Context, *connect.Request[v1alpha1.ContactRequest]) (*connect.Response[v1alpha1.ContactResponse], error)
	// Create an attachment to add to a support ticket.
	CreateAttachment(context.Context, *connect.Request[v1alpha1.CreateAttachmentRequest]) (*connect.Response[v1alpha1.CreateAttachmentResponse], error)
}

SupportServiceClient is a client for the commonfate.control.support.v1alpha1.SupportService service.

func NewSupportServiceClient

func NewSupportServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) SupportServiceClient

NewSupportServiceClient constructs a client for the commonfate.control.support.v1alpha1.SupportService 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 SupportServiceHandler

type SupportServiceHandler interface {
	// Contact Common Fate support.
	Contact(context.Context, *connect.Request[v1alpha1.ContactRequest]) (*connect.Response[v1alpha1.ContactResponse], error)
	// Create an attachment to add to a support ticket.
	CreateAttachment(context.Context, *connect.Request[v1alpha1.CreateAttachmentRequest]) (*connect.Response[v1alpha1.CreateAttachmentResponse], error)
}

SupportServiceHandler is an implementation of the commonfate.control.support.v1alpha1.SupportService service.

type UnimplementedSupportServiceHandler

type UnimplementedSupportServiceHandler struct{}

UnimplementedSupportServiceHandler returns CodeUnimplemented from all methods.

Jump to

Keyboard shortcuts

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