pbsinksvcconnect

Documentation

Index

• Constants
• func NewProviderHandler(svc ProviderHandler, opts ...connect.HandlerOption) (string, http.Handler)
• type ProviderClient
  • func NewProviderClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) ProviderClient
• type ProviderHandler
• type UnimplementedProviderHandler
  • func (UnimplementedProviderHandler) Deploy(context.Context, *connect.Request[v1.DeployRequest]) (*connect.Response[v1.DeployResponse], error)
  • func (UnimplementedProviderHandler) Info(context.Context, *connect.Request[v1.InfoRequest]) (*connect.Response[v1.InfoResponse], error)
  • func (UnimplementedProviderHandler) List(context.Context, *connect.Request[v1.ListRequest]) (*connect.Response[v1.ListResponse], error)
  • func (UnimplementedProviderHandler) Pause(context.Context, *connect.Request[v1.PauseRequest]) (*connect.Response[v1.PauseResponse], error)
  • func (UnimplementedProviderHandler) Remove(context.Context, *connect.Request[v1.RemoveRequest]) (*connect.Response[v1.RemoveResponse], error)
  • func (UnimplementedProviderHandler) Resume(context.Context, *connect.Request[v1.ResumeRequest]) (*connect.Response[v1.ResumeResponse], error)
  • func (UnimplementedProviderHandler) Stop(context.Context, *connect.Request[v1.StopRequest]) (*connect.Response[v1.StopResponse], error)
  • func (UnimplementedProviderHandler) Update(context.Context, *connect.Request[v1.UpdateRequest]) (*connect.Response[v1.UpdateResponse], error)

Constants

const (
	// ProviderDeployProcedure is the fully-qualified name of the Provider's Deploy RPC.
	ProviderDeployProcedure = "/sf.substreams.sink.service.v1.Provider/Deploy"
	// ProviderUpdateProcedure is the fully-qualified name of the Provider's Update RPC.
	ProviderUpdateProcedure = "/sf.substreams.sink.service.v1.Provider/Update"
	// ProviderInfoProcedure is the fully-qualified name of the Provider's Info RPC.
	ProviderInfoProcedure = "/sf.substreams.sink.service.v1.Provider/Info"
	// ProviderListProcedure is the fully-qualified name of the Provider's List RPC.
	ProviderListProcedure = "/sf.substreams.sink.service.v1.Provider/List"
	// ProviderPauseProcedure is the fully-qualified name of the Provider's Pause RPC.
	ProviderPauseProcedure = "/sf.substreams.sink.service.v1.Provider/Pause"
	// ProviderStopProcedure is the fully-qualified name of the Provider's Stop RPC.
	ProviderStopProcedure = "/sf.substreams.sink.service.v1.Provider/Stop"
	// ProviderResumeProcedure is the fully-qualified name of the Provider's Resume RPC.
	ProviderResumeProcedure = "/sf.substreams.sink.service.v1.Provider/Resume"
	// ProviderRemoveProcedure is the fully-qualified name of the Provider's Remove RPC.
	ProviderRemoveProcedure = "/sf.substreams.sink.service.v1.Provider/Remove"
)

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 (
	// ProviderName is the fully-qualified name of the Provider service.
	ProviderName = "sf.substreams.sink.service.v1.Provider"
)

Functions

func NewProviderHandler

func NewProviderHandler(svc ProviderHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewProviderHandler 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 ProviderClient

type ProviderClient interface {
	Deploy(context.Context, *connect.Request[v1.DeployRequest]) (*connect.Response[v1.DeployResponse], error)
	Update(context.Context, *connect.Request[v1.UpdateRequest]) (*connect.Response[v1.UpdateResponse], error)
	Info(context.Context, *connect.Request[v1.InfoRequest]) (*connect.Response[v1.InfoResponse], error)
	List(context.Context, *connect.Request[v1.ListRequest]) (*connect.Response[v1.ListResponse], error)
	Pause(context.Context, *connect.Request[v1.PauseRequest]) (*connect.Response[v1.PauseResponse], error)
	Stop(context.Context, *connect.Request[v1.StopRequest]) (*connect.Response[v1.StopResponse], error)
	Resume(context.Context, *connect.Request[v1.ResumeRequest]) (*connect.Response[v1.ResumeResponse], error)
	Remove(context.Context, *connect.Request[v1.RemoveRequest]) (*connect.Response[v1.RemoveResponse], error)
}

ProviderClient is a client for the sf.substreams.sink.service.v1.Provider service.

func NewProviderClient

func NewProviderClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) ProviderClient

NewProviderClient constructs a client for the sf.substreams.sink.service.v1.Provider 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 ProviderHandler

type ProviderHandler interface {
	Deploy(context.Context, *connect.Request[v1.DeployRequest]) (*connect.Response[v1.DeployResponse], error)
	Update(context.Context, *connect.Request[v1.UpdateRequest]) (*connect.Response[v1.UpdateResponse], error)
	Info(context.Context, *connect.Request[v1.InfoRequest]) (*connect.Response[v1.InfoResponse], error)
	List(context.Context, *connect.Request[v1.ListRequest]) (*connect.Response[v1.ListResponse], error)
	Pause(context.Context, *connect.Request[v1.PauseRequest]) (*connect.Response[v1.PauseResponse], error)
	Stop(context.Context, *connect.Request[v1.StopRequest]) (*connect.Response[v1.StopResponse], error)
	Resume(context.Context, *connect.Request[v1.ResumeRequest]) (*connect.Response[v1.ResumeResponse], error)
	Remove(context.Context, *connect.Request[v1.RemoveRequest]) (*connect.Response[v1.RemoveResponse], error)
}

ProviderHandler is an implementation of the sf.substreams.sink.service.v1.Provider service.

type UnimplementedProviderHandler

type UnimplementedProviderHandler struct{}

UnimplementedProviderHandler returns CodeUnimplemented from all methods.

func (UnimplementedProviderHandler) Deploy

func (UnimplementedProviderHandler) Deploy(context.Context, *connect.Request[v1.DeployRequest]) (*connect.Response[v1.DeployResponse], error)

func (UnimplementedProviderHandler) Info

func (UnimplementedProviderHandler) Info(context.Context, *connect.Request[v1.InfoRequest]) (*connect.Response[v1.InfoResponse], error)

func (UnimplementedProviderHandler) List

func (UnimplementedProviderHandler) List(context.Context, *connect.Request[v1.ListRequest]) (*connect.Response[v1.ListResponse], error)

func (UnimplementedProviderHandler) Pause

func (UnimplementedProviderHandler) Pause(context.Context, *connect.Request[v1.PauseRequest]) (*connect.Response[v1.PauseResponse], error)

func (UnimplementedProviderHandler) Remove

func (UnimplementedProviderHandler) Remove(context.Context, *connect.Request[v1.RemoveRequest]) (*connect.Response[v1.RemoveResponse], error)

func (UnimplementedProviderHandler) Resume

func (UnimplementedProviderHandler) Resume(context.Context, *connect.Request[v1.ResumeRequest]) (*connect.Response[v1.ResumeResponse], error)

func (UnimplementedProviderHandler) Stop

func (UnimplementedProviderHandler) Stop(context.Context, *connect.Request[v1.StopRequest]) (*connect.Response[v1.StopResponse], error)

func (UnimplementedProviderHandler) Update

func (UnimplementedProviderHandler) Update(context.Context, *connect.Request[v1.UpdateRequest]) (*connect.Response[v1.UpdateResponse], error)