apiv1connect

package
v1.7.0 Latest Latest
Warning

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

Go to latest
Published: Feb 29, 2024 License: MPL-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// LogsStreamLogsProcedure is the fully-qualified name of the Logs's StreamLogs RPC.
	LogsStreamLogsProcedure = "/api.v1.Logs/StreamLogs"
	// LogsUploadLogsProcedure is the fully-qualified name of the Logs's UploadLogs RPC.
	LogsUploadLogsProcedure = "/api.v1.Logs/UploadLogs"
)

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 (
	// RunsListProcedure is the fully-qualified name of the Runs's List RPC.
	RunsListProcedure = "/api.v1.Runs/List"
	// RunsWatchProcedure is the fully-qualified name of the Runs's Watch RPC.
	RunsWatchProcedure = "/api.v1.Runs/Watch"
	// RunsUpdateProcedure is the fully-qualified name of the Runs's Update RPC.
	RunsUpdateProcedure = "/api.v1.Runs/Update"
	// RunsGetProcedure is the fully-qualified name of the Runs's Get RPC.
	RunsGetProcedure = "/api.v1.Runs/Get"
)

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 (
	// WorkspacesGetWorkspaceProcedure is the fully-qualified name of the Workspaces's GetWorkspace RPC.
	WorkspacesGetWorkspaceProcedure = "/api.v1.Workspaces/GetWorkspace"
	// WorkspacesGetVcsConnectionProcedure is the fully-qualified name of the Workspaces's
	// GetVcsConnection RPC.
	WorkspacesGetVcsConnectionProcedure = "/api.v1.Workspaces/GetVcsConnection"
	// WorkspacesGetVariablesProcedure is the fully-qualified name of the Workspaces's GetVariables RPC.
	WorkspacesGetVariablesProcedure = "/api.v1.Workspaces/GetVariables"
)

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 (
	// AuthGenerateRunnerTokenProcedure is the fully-qualified name of the Auth's GenerateRunnerToken
	// RPC.
	AuthGenerateRunnerTokenProcedure = "/api.v1.Auth/GenerateRunnerToken"
)

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 (
	// AuthName is the fully-qualified name of the Auth service.
	AuthName = "api.v1.Auth"
)
View Source
const (
	// LogsName is the fully-qualified name of the Logs service.
	LogsName = "api.v1.Logs"
)
View Source
const (
	// PlansName is the fully-qualified name of the Plans service.
	PlansName = "api.v1.Plans"
)
View Source
const (
	// PlansUploadPlanProcedure is the fully-qualified name of the Plans's UploadPlan RPC.
	PlansUploadPlanProcedure = "/api.v1.Plans/UploadPlan"
)

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 (
	// RunsName is the fully-qualified name of the Runs service.
	RunsName = "api.v1.Runs"
)
View Source
const (
	// WorkspacesName is the fully-qualified name of the Workspaces service.
	WorkspacesName = "api.v1.Workspaces"
)

Variables

This section is empty.

Functions

func NewAuthHandler

func NewAuthHandler(svc AuthHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewAuthHandler 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.

func NewLogsHandler

func NewLogsHandler(svc LogsHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewLogsHandler 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.

func NewPlansHandler

func NewPlansHandler(svc PlansHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewPlansHandler 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.

func NewRunsHandler

func NewRunsHandler(svc RunsHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewRunsHandler 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.

func NewWorkspacesHandler

func NewWorkspacesHandler(svc WorkspacesHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewWorkspacesHandler 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 AuthClient

type AuthClient interface {
	GenerateRunnerToken(context.Context, *connect.Request[v1.GenerateRunnerTokenRequest]) (*connect.Response[v1.GenerateRunnerTokenResponse], error)
}

AuthClient is a client for the api.v1.Auth service.

func NewAuthClient

func NewAuthClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) AuthClient

NewAuthClient constructs a client for the api.v1.Auth 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 AuthHandler

type AuthHandler interface {
	GenerateRunnerToken(context.Context, *connect.Request[v1.GenerateRunnerTokenRequest]) (*connect.Response[v1.GenerateRunnerTokenResponse], error)
}

AuthHandler is an implementation of the api.v1.Auth service.

type LogsClient

LogsClient is a client for the api.v1.Logs service.

func NewLogsClient

func NewLogsClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) LogsClient

NewLogsClient constructs a client for the api.v1.Logs 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 LogsHandler

LogsHandler is an implementation of the api.v1.Logs service.

type PlansClient

type PlansClient interface {
	UploadPlan(context.Context, *connect.Request[v1.UploadPlanRequest]) (*connect.Response[v1.UploadPlanResponse], error)
}

PlansClient is a client for the api.v1.Plans service.

func NewPlansClient

func NewPlansClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) PlansClient

NewPlansClient constructs a client for the api.v1.Plans 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 PlansHandler

type PlansHandler interface {
	UploadPlan(context.Context, *connect.Request[v1.UploadPlanRequest]) (*connect.Response[v1.UploadPlanResponse], error)
}

PlansHandler is an implementation of the api.v1.Plans service.

type RunsClient

RunsClient is a client for the api.v1.Runs service.

func NewRunsClient

func NewRunsClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) RunsClient

NewRunsClient constructs a client for the api.v1.Runs 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 UnimplementedAuthHandler

type UnimplementedAuthHandler struct{}

UnimplementedAuthHandler returns CodeUnimplemented from all methods.

type UnimplementedLogsHandler

type UnimplementedLogsHandler struct{}

UnimplementedLogsHandler returns CodeUnimplemented from all methods.

type UnimplementedPlansHandler

type UnimplementedPlansHandler struct{}

UnimplementedPlansHandler returns CodeUnimplemented from all methods.

type UnimplementedRunsHandler

type UnimplementedRunsHandler struct{}

UnimplementedRunsHandler returns CodeUnimplemented from all methods.

func (UnimplementedRunsHandler) Get

func (UnimplementedRunsHandler) Update

type UnimplementedWorkspacesHandler

type UnimplementedWorkspacesHandler struct{}

UnimplementedWorkspacesHandler returns CodeUnimplemented from all methods.

type WorkspacesClient

WorkspacesClient is a client for the api.v1.Workspaces service.

func NewWorkspacesClient

func NewWorkspacesClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) WorkspacesClient

NewWorkspacesClient constructs a client for the api.v1.Workspaces 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 WorkspacesHandler

WorkspacesHandler is an implementation of the api.v1.Workspaces service.

Jump to

Keyboard shortcuts

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