kargov1alpha1connect

Documentation

Index

• Constants
• func NewKargoServiceHandler(svc KargoServiceHandler, opts ...connect_go.HandlerOption) (string, http.Handler)
• type KargoServiceClient
  • func NewKargoServiceClient(httpClient connect_go.HTTPClient, baseURL string, ...) KargoServiceClient
• type KargoServiceHandler
• type UnimplementedKargoServiceHandler
  • func (UnimplementedKargoServiceHandler) GetEnvironment(context.Context, *connect_go.Request[v1alpha1.GetEnvironmentRequest]) (*connect_go.Response[v1alpha1.GetEnvironmentResponse], error)
  • func (UnimplementedKargoServiceHandler) ListEnvironments(context.Context, *connect_go.Request[v1alpha1.ListEnvironmentsRequest]) (*connect_go.Response[v1alpha1.ListEnvironmentsResponse], error)

Constants

const (
	// KargoServiceListEnvironmentsProcedure is the fully-qualified name of the KargoService's
	// ListEnvironments RPC.
	KargoServiceListEnvironmentsProcedure = "/akuity.io.kargo.v1alpha1.KargoService/ListEnvironments"
	// KargoServiceGetEnvironmentProcedure is the fully-qualified name of the KargoService's
	// GetEnvironment RPC.
	KargoServiceGetEnvironmentProcedure = "/akuity.io.kargo.v1alpha1.KargoService/GetEnvironment"
)

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 (
	// KargoServiceName is the fully-qualified name of the KargoService service.
	KargoServiceName = "akuity.io.kargo.v1alpha1.KargoService"
)

Functions

func NewKargoServiceHandler

func NewKargoServiceHandler(svc KargoServiceHandler, opts ...connect_go.HandlerOption) (string, http.Handler)

NewKargoServiceHandler 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 KargoServiceClient

type KargoServiceClient interface {
	ListEnvironments(context.Context, *connect_go.Request[v1alpha1.ListEnvironmentsRequest]) (*connect_go.Response[v1alpha1.ListEnvironmentsResponse], error)
	GetEnvironment(context.Context, *connect_go.Request[v1alpha1.GetEnvironmentRequest]) (*connect_go.Response[v1alpha1.GetEnvironmentResponse], error)
}

KargoServiceClient is a client for the akuity.io.kargo.v1alpha1.KargoService service.

func NewKargoServiceClient

func NewKargoServiceClient(httpClient connect_go.HTTPClient, baseURL string, opts ...connect_go.ClientOption) KargoServiceClient

NewKargoServiceClient constructs a client for the akuity.io.kargo.v1alpha1.KargoService 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 KargoServiceHandler

type KargoServiceHandler interface {
	ListEnvironments(context.Context, *connect_go.Request[v1alpha1.ListEnvironmentsRequest]) (*connect_go.Response[v1alpha1.ListEnvironmentsResponse], error)
	GetEnvironment(context.Context, *connect_go.Request[v1alpha1.GetEnvironmentRequest]) (*connect_go.Response[v1alpha1.GetEnvironmentResponse], error)
}

KargoServiceHandler is an implementation of the akuity.io.kargo.v1alpha1.KargoService service.

type UnimplementedKargoServiceHandler

type UnimplementedKargoServiceHandler struct{}

UnimplementedKargoServiceHandler returns CodeUnimplemented from all methods.

func (UnimplementedKargoServiceHandler) GetEnvironment

func (UnimplementedKargoServiceHandler) GetEnvironment(context.Context, *connect_go.Request[v1alpha1.GetEnvironmentRequest]) (*connect_go.Response[v1alpha1.GetEnvironmentResponse], error)

func (UnimplementedKargoServiceHandler) ListEnvironments

func (UnimplementedKargoServiceHandler) ListEnvironments(context.Context, *connect_go.Request[v1alpha1.ListEnvironmentsRequest]) (*connect_go.Response[v1alpha1.ListEnvironmentsResponse], error)