diagnosticv1alpha1connect

Documentation

Index

• Constants
• func NewDiagnosticServiceHandler(svc DiagnosticServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
• type DiagnosticServiceClient
  • func NewDiagnosticServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) DiagnosticServiceClient
• type DiagnosticServiceHandler
• type UnimplementedDiagnosticServiceHandler
  • func (UnimplementedDiagnosticServiceHandler) GetOAuthTokenMetadata(context.Context, *connect.Request[v1alpha1.GetOAuthTokenMetadataRequest]) (*connect.Response[v1alpha1.GetOAuthTokenMetadataResponse], error)
  • func (UnimplementedDiagnosticServiceHandler) ListBackgroundJobKindSummary(context.Context, ...) (*connect.Response[v1alpha1.ListBackgroundJobKindSummaryResponse], error)
  • func (UnimplementedDiagnosticServiceHandler) ListBackgroundJobs(context.Context, *connect.Request[v1alpha1.ListBackgroundJobsRequest]) (*connect.Response[v1alpha1.ListBackgroundJobsResponse], error)

Constants

const (
	// DiagnosticServiceGetOAuthTokenMetadataProcedure is the fully-qualified name of the
	// DiagnosticService's GetOAuthTokenMetadata RPC.
	DiagnosticServiceGetOAuthTokenMetadataProcedure = "/commonfate.control.diagnostic.v1alpha1.DiagnosticService/GetOAuthTokenMetadata"
	// DiagnosticServiceListBackgroundJobsProcedure is the fully-qualified name of the
	// DiagnosticService's ListBackgroundJobs RPC.
	DiagnosticServiceListBackgroundJobsProcedure = "/commonfate.control.diagnostic.v1alpha1.DiagnosticService/ListBackgroundJobs"
	// DiagnosticServiceListBackgroundJobKindSummaryProcedure is the fully-qualified name of the
	// DiagnosticService's ListBackgroundJobKindSummary RPC.
	DiagnosticServiceListBackgroundJobKindSummaryProcedure = "/commonfate.control.diagnostic.v1alpha1.DiagnosticService/ListBackgroundJobKindSummary"
)

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

Functions

func NewDiagnosticServiceHandler

func NewDiagnosticServiceHandler(svc DiagnosticServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewDiagnosticServiceHandler 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 DiagnosticServiceClient

type DiagnosticServiceClient interface {
	// Retrieves metadata about the current OAuth2.0 tokens stored by Common Fate.
	GetOAuthTokenMetadata(context.Context, *connect.Request[v1alpha1.GetOAuthTokenMetadataRequest]) (*connect.Response[v1alpha1.GetOAuthTokenMetadataResponse], error)
	ListBackgroundJobs(context.Context, *connect.Request[v1alpha1.ListBackgroundJobsRequest]) (*connect.Response[v1alpha1.ListBackgroundJobsResponse], error)
	ListBackgroundJobKindSummary(context.Context, *connect.Request[v1alpha1.ListBackgroundJobKindSummaryRequest]) (*connect.Response[v1alpha1.ListBackgroundJobKindSummaryResponse], error)
}

DiagnosticServiceClient is a client for the commonfate.control.diagnostic.v1alpha1.DiagnosticService service.

func NewDiagnosticServiceClient

func NewDiagnosticServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) DiagnosticServiceClient

NewDiagnosticServiceClient constructs a client for the commonfate.control.diagnostic.v1alpha1.DiagnosticService 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 DiagnosticServiceHandler

type DiagnosticServiceHandler interface {
	// Retrieves metadata about the current OAuth2.0 tokens stored by Common Fate.
	GetOAuthTokenMetadata(context.Context, *connect.Request[v1alpha1.GetOAuthTokenMetadataRequest]) (*connect.Response[v1alpha1.GetOAuthTokenMetadataResponse], error)
	ListBackgroundJobs(context.Context, *connect.Request[v1alpha1.ListBackgroundJobsRequest]) (*connect.Response[v1alpha1.ListBackgroundJobsResponse], error)
	ListBackgroundJobKindSummary(context.Context, *connect.Request[v1alpha1.ListBackgroundJobKindSummaryRequest]) (*connect.Response[v1alpha1.ListBackgroundJobKindSummaryResponse], error)
}

DiagnosticServiceHandler is an implementation of the commonfate.control.diagnostic.v1alpha1.DiagnosticService service.

type UnimplementedDiagnosticServiceHandler

type UnimplementedDiagnosticServiceHandler struct{}

UnimplementedDiagnosticServiceHandler returns CodeUnimplemented from all methods.

func (UnimplementedDiagnosticServiceHandler) GetOAuthTokenMetadata

func (UnimplementedDiagnosticServiceHandler) GetOAuthTokenMetadata(context.Context, *connect.Request[v1alpha1.GetOAuthTokenMetadataRequest]) (*connect.Response[v1alpha1.GetOAuthTokenMetadataResponse], error)

func (UnimplementedDiagnosticServiceHandler) ListBackgroundJobKindSummary

func (UnimplementedDiagnosticServiceHandler) ListBackgroundJobKindSummary(context.Context, *connect.Request[v1alpha1.ListBackgroundJobKindSummaryRequest]) (*connect.Response[v1alpha1.ListBackgroundJobKindSummaryResponse], error)

func (UnimplementedDiagnosticServiceHandler) ListBackgroundJobs

func (UnimplementedDiagnosticServiceHandler) ListBackgroundJobs(context.Context, *connect.Request[v1alpha1.ListBackgroundJobsRequest]) (*connect.Response[v1alpha1.ListBackgroundJobsResponse], error)