timelinev1connect

Documentation

Index

• Constants
• func NewTimelineServiceHandler(svc TimelineServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
• type TimelineServiceClient
  • func NewTimelineServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) TimelineServiceClient
• type TimelineServiceHandler
• type UnimplementedTimelineServiceHandler
  • func (UnimplementedTimelineServiceHandler) CreateEvent(context.Context, *connect.Request[v11.CreateEventRequest]) (*connect.Response[v11.CreateEventResponse], error)
  • func (UnimplementedTimelineServiceHandler) DeleteOldEvents(context.Context, *connect.Request[v11.DeleteOldEventsRequest]) (*connect.Response[v11.DeleteOldEventsResponse], error)
  • func (UnimplementedTimelineServiceHandler) GetTimeline(context.Context, *connect.Request[v11.GetTimelineRequest]) (*connect.Response[v11.GetTimelineResponse], error)
  • func (UnimplementedTimelineServiceHandler) Ping(context.Context, *connect.Request[v1.PingRequest]) (*connect.Response[v1.PingResponse], error)
  • func (UnimplementedTimelineServiceHandler) StreamTimeline(context.Context, *connect.Request[v11.StreamTimelineRequest], ...) error

Constants

const (
	// TimelineServicePingProcedure is the fully-qualified name of the TimelineService's Ping RPC.
	TimelineServicePingProcedure = "/xyz.block.ftl.timeline.v1.TimelineService/Ping"
	// TimelineServiceGetTimelineProcedure is the fully-qualified name of the TimelineService's
	// GetTimeline RPC.
	TimelineServiceGetTimelineProcedure = "/xyz.block.ftl.timeline.v1.TimelineService/GetTimeline"
	// TimelineServiceStreamTimelineProcedure is the fully-qualified name of the TimelineService's
	// StreamTimeline RPC.
	TimelineServiceStreamTimelineProcedure = "/xyz.block.ftl.timeline.v1.TimelineService/StreamTimeline"
	// TimelineServiceCreateEventProcedure is the fully-qualified name of the TimelineService's
	// CreateEvent RPC.
	TimelineServiceCreateEventProcedure = "/xyz.block.ftl.timeline.v1.TimelineService/CreateEvent"
	// TimelineServiceDeleteOldEventsProcedure is the fully-qualified name of the TimelineService's
	// DeleteOldEvents RPC.
	TimelineServiceDeleteOldEventsProcedure = "/xyz.block.ftl.timeline.v1.TimelineService/DeleteOldEvents"
)

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 (
	// TimelineServiceName is the fully-qualified name of the TimelineService service.
	TimelineServiceName = "xyz.block.ftl.timeline.v1.TimelineService"
)

Functions

func NewTimelineServiceHandler

func NewTimelineServiceHandler(svc TimelineServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewTimelineServiceHandler 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 TimelineServiceClient

type TimelineServiceClient interface {
	// Ping service for readiness
	Ping(context.Context, *connect.Request[v1.PingRequest]) (*connect.Response[v1.PingResponse], error)
	// Get timeline events with filters
	GetTimeline(context.Context, *connect.Request[v11.GetTimelineRequest]) (*connect.Response[v11.GetTimelineResponse], error)
	// Stream timeline events with filters
	StreamTimeline(context.Context, *connect.Request[v11.StreamTimelineRequest]) (*connect.ServerStreamForClient[v11.StreamTimelineResponse], error)
	CreateEvent(context.Context, *connect.Request[v11.CreateEventRequest]) (*connect.Response[v11.CreateEventResponse], error)
	// Delete old events of a specific type
	DeleteOldEvents(context.Context, *connect.Request[v11.DeleteOldEventsRequest]) (*connect.Response[v11.DeleteOldEventsResponse], error)
}

TimelineServiceClient is a client for the xyz.block.ftl.timeline.v1.TimelineService service.

func NewTimelineServiceClient

func NewTimelineServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) TimelineServiceClient

NewTimelineServiceClient constructs a client for the xyz.block.ftl.timeline.v1.TimelineService 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 TimelineServiceHandler

type TimelineServiceHandler interface {
	// Ping service for readiness
	Ping(context.Context, *connect.Request[v1.PingRequest]) (*connect.Response[v1.PingResponse], error)
	// Get timeline events with filters
	GetTimeline(context.Context, *connect.Request[v11.GetTimelineRequest]) (*connect.Response[v11.GetTimelineResponse], error)
	// Stream timeline events with filters
	StreamTimeline(context.Context, *connect.Request[v11.StreamTimelineRequest], *connect.ServerStream[v11.StreamTimelineResponse]) error
	CreateEvent(context.Context, *connect.Request[v11.CreateEventRequest]) (*connect.Response[v11.CreateEventResponse], error)
	// Delete old events of a specific type
	DeleteOldEvents(context.Context, *connect.Request[v11.DeleteOldEventsRequest]) (*connect.Response[v11.DeleteOldEventsResponse], error)
}

TimelineServiceHandler is an implementation of the xyz.block.ftl.timeline.v1.TimelineService service.

type UnimplementedTimelineServiceHandler

type UnimplementedTimelineServiceHandler struct{}

UnimplementedTimelineServiceHandler returns CodeUnimplemented from all methods.

func (UnimplementedTimelineServiceHandler) CreateEvent

func (UnimplementedTimelineServiceHandler) CreateEvent(context.Context, *connect.Request[v11.CreateEventRequest]) (*connect.Response[v11.CreateEventResponse], error)

func (UnimplementedTimelineServiceHandler) DeleteOldEvents

func (UnimplementedTimelineServiceHandler) DeleteOldEvents(context.Context, *connect.Request[v11.DeleteOldEventsRequest]) (*connect.Response[v11.DeleteOldEventsResponse], error)

func (UnimplementedTimelineServiceHandler) GetTimeline

func (UnimplementedTimelineServiceHandler) GetTimeline(context.Context, *connect.Request[v11.GetTimelineRequest]) (*connect.Response[v11.GetTimelineResponse], error)

func (UnimplementedTimelineServiceHandler) Ping

func (UnimplementedTimelineServiceHandler) Ping(context.Context, *connect.Request[v1.PingRequest]) (*connect.Response[v1.PingResponse], error)

func (UnimplementedTimelineServiceHandler) StreamTimeline

func (UnimplementedTimelineServiceHandler) StreamTimeline(context.Context, *connect.Request[v11.StreamTimelineRequest], *connect.ServerStream[v11.StreamTimelineResponse]) error