cliv1connect

Documentation

Index

• Constants
• func NewBuildServiceHandler(svc BuildServiceHandler, opts ...connect_go.HandlerOption) (string, http.Handler)
• type BuildServiceClient
  • func NewBuildServiceClient(httpClient connect_go.HTTPClient, baseURL string, ...) BuildServiceClient
• type BuildServiceHandler
• type UnimplementedBuildServiceHandler
  • func (UnimplementedBuildServiceHandler) CreateBuild(context.Context, *connect_go.Request[v1.CreateBuildRequest]) (*connect_go.Response[v1.CreateBuildResponse], error)
  • func (UnimplementedBuildServiceHandler) FinishBuild(context.Context, *connect_go.Request[v1.FinishBuildRequest]) (*connect_go.Response[v1.FinishBuildResponse], error)
  • func (UnimplementedBuildServiceHandler) GetBuildKitConnection(context.Context, *connect_go.Request[v1.GetBuildKitConnectionRequest]) (*connect_go.Response[v1.GetBuildKitConnectionResponse], error)
  • func (UnimplementedBuildServiceHandler) ListBuilds(context.Context, *connect_go.Request[v1.ListBuildsRequest]) (*connect_go.Response[v1.ListBuildsResponse], error)
  • func (UnimplementedBuildServiceHandler) ReportBuildContext(context.Context, *connect_go.Request[v1.ReportBuildContextRequest]) (*connect_go.Response[v1.ReportBuildContextResponse], error)
  • func (UnimplementedBuildServiceHandler) ReportBuildHealth(context.Context, *connect_go.Request[v1.ReportBuildHealthRequest]) (*connect_go.Response[v1.ReportBuildHealthResponse], error)
  • func (UnimplementedBuildServiceHandler) ReportTimings(context.Context, *connect_go.Request[v1.ReportTimingsRequest]) (*connect_go.Response[v1.ReportTimingsResponse], error)

Constants

const (
	// BuildServiceCreateBuildProcedure is the fully-qualified name of the BuildService's CreateBuild
	// RPC.
	BuildServiceCreateBuildProcedure = "/depot.cli.v1.BuildService/CreateBuild"
	// BuildServiceFinishBuildProcedure is the fully-qualified name of the BuildService's FinishBuild
	// RPC.
	BuildServiceFinishBuildProcedure = "/depot.cli.v1.BuildService/FinishBuild"
	// BuildServiceGetBuildKitConnectionProcedure is the fully-qualified name of the BuildService's
	// GetBuildKitConnection RPC.
	BuildServiceGetBuildKitConnectionProcedure = "/depot.cli.v1.BuildService/GetBuildKitConnection"
	// BuildServiceReportBuildHealthProcedure is the fully-qualified name of the BuildService's
	// ReportBuildHealth RPC.
	BuildServiceReportBuildHealthProcedure = "/depot.cli.v1.BuildService/ReportBuildHealth"
	// BuildServiceReportTimingsProcedure is the fully-qualified name of the BuildService's
	// ReportTimings RPC.
	BuildServiceReportTimingsProcedure = "/depot.cli.v1.BuildService/ReportTimings"
	// BuildServiceReportBuildContextProcedure is the fully-qualified name of the BuildService's
	// ReportBuildContext RPC.
	BuildServiceReportBuildContextProcedure = "/depot.cli.v1.BuildService/ReportBuildContext"
	// BuildServiceListBuildsProcedure is the fully-qualified name of the BuildService's ListBuilds RPC.
	BuildServiceListBuildsProcedure = "/depot.cli.v1.BuildService/ListBuilds"
)

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 (
	// BuildServiceName is the fully-qualified name of the BuildService service.
	BuildServiceName = "depot.cli.v1.BuildService"
)

Functions

func NewBuildServiceHandler

func NewBuildServiceHandler(svc BuildServiceHandler, opts ...connect_go.HandlerOption) (string, http.Handler)

NewBuildServiceHandler 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 BuildServiceClient

type BuildServiceClient interface {
	CreateBuild(context.Context, *connect_go.Request[v1.CreateBuildRequest]) (*connect_go.Response[v1.CreateBuildResponse], error)
	FinishBuild(context.Context, *connect_go.Request[v1.FinishBuildRequest]) (*connect_go.Response[v1.FinishBuildResponse], error)
	GetBuildKitConnection(context.Context, *connect_go.Request[v1.GetBuildKitConnectionRequest]) (*connect_go.Response[v1.GetBuildKitConnectionResponse], error)
	ReportBuildHealth(context.Context, *connect_go.Request[v1.ReportBuildHealthRequest]) (*connect_go.Response[v1.ReportBuildHealthResponse], error)
	ReportTimings(context.Context, *connect_go.Request[v1.ReportTimingsRequest]) (*connect_go.Response[v1.ReportTimingsResponse], error)
	ReportBuildContext(context.Context, *connect_go.Request[v1.ReportBuildContextRequest]) (*connect_go.Response[v1.ReportBuildContextResponse], error)
	ListBuilds(context.Context, *connect_go.Request[v1.ListBuildsRequest]) (*connect_go.Response[v1.ListBuildsResponse], error)
}

BuildServiceClient is a client for the depot.cli.v1.BuildService service.

func NewBuildServiceClient

func NewBuildServiceClient(httpClient connect_go.HTTPClient, baseURL string, opts ...connect_go.ClientOption) BuildServiceClient

NewBuildServiceClient constructs a client for the depot.cli.v1.BuildService 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 BuildServiceHandler

type BuildServiceHandler interface {
	CreateBuild(context.Context, *connect_go.Request[v1.CreateBuildRequest]) (*connect_go.Response[v1.CreateBuildResponse], error)
	FinishBuild(context.Context, *connect_go.Request[v1.FinishBuildRequest]) (*connect_go.Response[v1.FinishBuildResponse], error)
	GetBuildKitConnection(context.Context, *connect_go.Request[v1.GetBuildKitConnectionRequest]) (*connect_go.Response[v1.GetBuildKitConnectionResponse], error)
	ReportBuildHealth(context.Context, *connect_go.Request[v1.ReportBuildHealthRequest]) (*connect_go.Response[v1.ReportBuildHealthResponse], error)
	ReportTimings(context.Context, *connect_go.Request[v1.ReportTimingsRequest]) (*connect_go.Response[v1.ReportTimingsResponse], error)
	ReportBuildContext(context.Context, *connect_go.Request[v1.ReportBuildContextRequest]) (*connect_go.Response[v1.ReportBuildContextResponse], error)
	ListBuilds(context.Context, *connect_go.Request[v1.ListBuildsRequest]) (*connect_go.Response[v1.ListBuildsResponse], error)
}

BuildServiceHandler is an implementation of the depot.cli.v1.BuildService service.

type UnimplementedBuildServiceHandler

type UnimplementedBuildServiceHandler struct{}

UnimplementedBuildServiceHandler returns CodeUnimplemented from all methods.

func (UnimplementedBuildServiceHandler) CreateBuild

func (UnimplementedBuildServiceHandler) CreateBuild(context.Context, *connect_go.Request[v1.CreateBuildRequest]) (*connect_go.Response[v1.CreateBuildResponse], error)

func (UnimplementedBuildServiceHandler) FinishBuild

func (UnimplementedBuildServiceHandler) FinishBuild(context.Context, *connect_go.Request[v1.FinishBuildRequest]) (*connect_go.Response[v1.FinishBuildResponse], error)

func (UnimplementedBuildServiceHandler) GetBuildKitConnection

func (UnimplementedBuildServiceHandler) GetBuildKitConnection(context.Context, *connect_go.Request[v1.GetBuildKitConnectionRequest]) (*connect_go.Response[v1.GetBuildKitConnectionResponse], error)

func (UnimplementedBuildServiceHandler) ListBuilds

func (UnimplementedBuildServiceHandler) ListBuilds(context.Context, *connect_go.Request[v1.ListBuildsRequest]) (*connect_go.Response[v1.ListBuildsResponse], error)

func (UnimplementedBuildServiceHandler) ReportBuildContext

func (UnimplementedBuildServiceHandler) ReportBuildContext(context.Context, *connect_go.Request[v1.ReportBuildContextRequest]) (*connect_go.Response[v1.ReportBuildContextResponse], error)

func (UnimplementedBuildServiceHandler) ReportBuildHealth

func (UnimplementedBuildServiceHandler) ReportBuildHealth(context.Context, *connect_go.Request[v1.ReportBuildHealthRequest]) (*connect_go.Response[v1.ReportBuildHealthResponse], error)

func (UnimplementedBuildServiceHandler) ReportTimings

func (UnimplementedBuildServiceHandler) ReportTimings(context.Context, *connect_go.Request[v1.ReportTimingsRequest]) (*connect_go.Response[v1.ReportTimingsResponse], error)