eventv2

package
v0.0.7 Latest Latest
Warning

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

 Go to latest Published: Dec 4, 2024 License: MIT Imports: 12 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	EventService_Stream_FullMethodName  = "/apis.event.v2.EventService/Stream"
	EventService_Publish_FullMethodName = "/apis.event.v2.EventService/Publish"
)
View Source 
const (
	WebhookService_ListWebhookSubscriptions_FullMethodName  = "/apis.event.v2.WebhookService/ListWebhookSubscriptions"
	WebhookService_CreateWebhookSubscription_FullMethodName = "/apis.event.v2.WebhookService/CreateWebhookSubscription"
	WebhookService_DeleteWebhookSubscription_FullMethodName = "/apis.event.v2.WebhookService/DeleteWebhookSubscription"
)
View Source 
const (
	HistoryService_GetEvents_FullMethodName = "/apis.event.v2.HistoryService/GetEvents"
)

Variables

View Source 
var (
	EventsStreamMessageType_name = map[int32]string{
		0: "EVENTS_STREAM_MESSAGE_TYPE_UNSPECIFIED",
		1: "EVENTS_STREAM_MESSAGE_TYPE_PING",
		2: "EVENTS_STREAM_MESSAGE_TYPE_ERROR",
		3: "EVENTS_STREAM_MESSAGE_TYPE_SUBSCRIBED",
		4: "EVENTS_STREAM_MESSAGE_TYPE_UNSUBSCRIBED",
		5: "EVENTS_STREAM_MESSAGE_TYPE_PUBLISHED",
	}
	EventsStreamMessageType_value = map[string]int32{
		"EVENTS_STREAM_MESSAGE_TYPE_UNSPECIFIED":  0,
		"EVENTS_STREAM_MESSAGE_TYPE_PING":         1,
		"EVENTS_STREAM_MESSAGE_TYPE_ERROR":        2,
		"EVENTS_STREAM_MESSAGE_TYPE_SUBSCRIBED":   3,
		"EVENTS_STREAM_MESSAGE_TYPE_UNSUBSCRIBED": 4,
		"EVENTS_STREAM_MESSAGE_TYPE_PUBLISHED":    5,
	}
)

Enum value maps for EventsStreamMessageType.

View Source 
var (
	GetEventsQuery_PaginationOrder_name = map[int32]string{
		0: "PAGINATION_ORDER_UNSPECIFIED",
		1: "PAGINATION_ORDER_CREATED_AT_DESC",
		2: "PAGINATION_ORDER_CREATED_AT_ASC",
	}
	GetEventsQuery_PaginationOrder_value = map[string]int32{
		"PAGINATION_ORDER_UNSPECIFIED":     0,
		"PAGINATION_ORDER_CREATED_AT_DESC": 1,
		"PAGINATION_ORDER_CREATED_AT_ASC":  2,
	}
)

Enum value maps for GetEventsQuery_PaginationOrder.

View Source 
var EventService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "apis.event.v2.EventService",
	HandlerType: (*EventServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Publish",
			Handler:    _EventService_Publish_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "Stream",
			Handler:       _EventService_Stream_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
	},
	Metadata: "apis/event/v2/api.proto",
}

EventService_ServiceDesc is the grpc.ServiceDesc for EventService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var File_apis_event_v2_api_proto protoreflect.FileDescriptor
View Source 
var HistoryService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "apis.event.v2.HistoryService",
	HandlerType: (*HistoryServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetEvents",
			Handler:    _HistoryService_GetEvents_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "apis/event/v2/api.proto",
}

HistoryService_ServiceDesc is the grpc.ServiceDesc for HistoryService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var WebhookService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "apis.event.v2.WebhookService",
	HandlerType: (*WebhookServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ListWebhookSubscriptions",
			Handler:    _WebhookService_ListWebhookSubscriptions_Handler,
		},
		{
			MethodName: "CreateWebhookSubscription",
			Handler:    _WebhookService_CreateWebhookSubscription_Handler,
		},
		{
			MethodName: "DeleteWebhookSubscription",
			Handler:    _WebhookService_DeleteWebhookSubscription_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "apis/event/v2/api.proto",
}

WebhookService_ServiceDesc is the grpc.ServiceDesc for WebhookService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterEventServiceServer 

func RegisterEventServiceServer(s grpc.ServiceRegistrar, srv EventServiceServer)

func RegisterHistoryServiceServer added in v0.0.2 

func RegisterHistoryServiceServer(s grpc.ServiceRegistrar, srv HistoryServiceServer)

func RegisterWebhookServiceServer added in v0.0.2 

func RegisterWebhookServiceServer(s grpc.ServiceRegistrar, srv WebhookServiceServer)

Types

type CreateWebhookSubscriptionRequest added in v0.0.2 

type CreateWebhookSubscriptionRequest struct {

	// Event's to subscribe to for custom events, this can be a wildcard `my_service:*`
	Events []string `protobuf:"bytes,1,rep,name=events,proto3" json:"events,omitempty"`
	// The target to subscribe to. If not defined, all events will be sent.
	Target *ServiceEventTarget `protobuf:"bytes,2,opt,name=target,proto3,oneof" json:"target,omitempty"`
	// The URL to send the event to.
	Url       string  `protobuf:"bytes,3,opt,name=url,proto3" json:"url,omitempty"`
	TimeoutMs *uint32 `protobuf:"varint,4,opt,name=timeout_ms,json=timeoutMs,proto3,oneof" json:"timeout_ms,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateWebhookSubscriptionRequest) Descriptor deprecated added in v0.0.2 

func (*CreateWebhookSubscriptionRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateWebhookSubscriptionRequest.ProtoReflect.Descriptor instead.

func (*CreateWebhookSubscriptionRequest) GetEvents added in v0.0.2 

func (x *CreateWebhookSubscriptionRequest) GetEvents() []string

func (*CreateWebhookSubscriptionRequest) GetTarget added in v0.0.2 

func (x *CreateWebhookSubscriptionRequest) GetTarget() *ServiceEventTarget

func (*CreateWebhookSubscriptionRequest) GetTimeoutMs added in v0.0.2 

func (x *CreateWebhookSubscriptionRequest) GetTimeoutMs() uint32

func (*CreateWebhookSubscriptionRequest) GetUrl added in v0.0.2 

func (x *CreateWebhookSubscriptionRequest) GetUrl() string

func (*CreateWebhookSubscriptionRequest) ProtoMessage added in v0.0.2 

func (*CreateWebhookSubscriptionRequest) ProtoMessage()

func (*CreateWebhookSubscriptionRequest) ProtoReflect added in v0.0.2 

func (x *CreateWebhookSubscriptionRequest) ProtoReflect() protoreflect.Message

func (*CreateWebhookSubscriptionRequest) Reset added in v0.0.2 

func (x *CreateWebhookSubscriptionRequest) Reset()

func (*CreateWebhookSubscriptionRequest) String added in v0.0.2 

func (x *CreateWebhookSubscriptionRequest) String() string

type CreateWebhookSubscriptionResponse added in v0.0.2 

type CreateWebhookSubscriptionResponse struct {
	Subscription *WebhookSubscription `protobuf:"bytes,1,opt,name=subscription,proto3" json:"subscription,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateWebhookSubscriptionResponse) Descriptor deprecated added in v0.0.2 

func (*CreateWebhookSubscriptionResponse) Descriptor() ([]byte, []int)

Deprecated: Use CreateWebhookSubscriptionResponse.ProtoReflect.Descriptor instead.

func (*CreateWebhookSubscriptionResponse) GetSubscription added in v0.0.2 

func (x *CreateWebhookSubscriptionResponse) GetSubscription() *WebhookSubscription

func (*CreateWebhookSubscriptionResponse) ProtoMessage added in v0.0.2 

func (*CreateWebhookSubscriptionResponse) ProtoMessage()

func (*CreateWebhookSubscriptionResponse) ProtoReflect added in v0.0.2 

func (x *CreateWebhookSubscriptionResponse) ProtoReflect() protoreflect.Message

func (*CreateWebhookSubscriptionResponse) Reset added in v0.0.2 

func (x *CreateWebhookSubscriptionResponse) Reset()

func (*CreateWebhookSubscriptionResponse) String added in v0.0.2 

func (x *CreateWebhookSubscriptionResponse) String() string

type DeleteWebhookSubscriptionRequest added in v0.0.2 

type DeleteWebhookSubscriptionRequest struct {

	// The webhook subscription identifier.
	WebhookId string `protobuf:"bytes,1,opt,name=webhook_id,json=webhookId,proto3" json:"webhook_id,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteWebhookSubscriptionRequest) Descriptor deprecated added in v0.0.2 

func (*DeleteWebhookSubscriptionRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteWebhookSubscriptionRequest.ProtoReflect.Descriptor instead.

func (*DeleteWebhookSubscriptionRequest) GetWebhookId added in v0.0.2 

func (x *DeleteWebhookSubscriptionRequest) GetWebhookId() string

func (*DeleteWebhookSubscriptionRequest) ProtoMessage added in v0.0.2 

func (*DeleteWebhookSubscriptionRequest) ProtoMessage()

func (*DeleteWebhookSubscriptionRequest) ProtoReflect added in v0.0.2 

func (x *DeleteWebhookSubscriptionRequest) ProtoReflect() protoreflect.Message

func (*DeleteWebhookSubscriptionRequest) Reset added in v0.0.2 

func (x *DeleteWebhookSubscriptionRequest) Reset()

func (*DeleteWebhookSubscriptionRequest) String added in v0.0.2 

func (x *DeleteWebhookSubscriptionRequest) String() string

type DeleteWebhookSubscriptionResponse added in v0.0.2 

type DeleteWebhookSubscriptionResponse struct {
	// contains filtered or unexported fields
}

func (*DeleteWebhookSubscriptionResponse) Descriptor deprecated added in v0.0.2 

func (*DeleteWebhookSubscriptionResponse) Descriptor() ([]byte, []int)

Deprecated: Use DeleteWebhookSubscriptionResponse.ProtoReflect.Descriptor instead.

func (*DeleteWebhookSubscriptionResponse) ProtoMessage added in v0.0.2 

func (*DeleteWebhookSubscriptionResponse) ProtoMessage()

func (*DeleteWebhookSubscriptionResponse) ProtoReflect added in v0.0.2 

func (x *DeleteWebhookSubscriptionResponse) ProtoReflect() protoreflect.Message

func (*DeleteWebhookSubscriptionResponse) Reset added in v0.0.2 

func (x *DeleteWebhookSubscriptionResponse) Reset()

func (*DeleteWebhookSubscriptionResponse) String added in v0.0.2 

func (x *DeleteWebhookSubscriptionResponse) String() string

type Event added in v0.0.2 

type Event struct {

	// Name of the event.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Value of the event.
	Payload *structpb.Struct `protobuf:"bytes,2,opt,name=payload,proto3" json:"payload,omitempty"`
	// Custom scoping parameters.
	Target *ServiceEventTarget `protobuf:"bytes,3,opt,name=target,proto3,oneof" json:"target,omitempty"`
	// Metadata associated with the publishing of the event
	RequestMetadata *structpb.Value `protobuf:"bytes,4,opt,name=request_metadata,json=requestMetadata,proto3,oneof" json:"request_metadata,omitempty"`
	// Internal ID of the event.
	Id string `protobuf:"bytes,5,opt,name=id,proto3" json:"id,omitempty"`
	// The time the event was first published.
	PublishedAt *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=published_at,json=publishedAt,proto3" json:"published_at,omitempty"`
	// contains filtered or unexported fields
}

A representation of an event

func (*Event) Descriptor deprecated added in v0.0.2 

func (*Event) Descriptor() ([]byte, []int)

Deprecated: Use Event.ProtoReflect.Descriptor instead.

func (*Event) GetId added in v0.0.2 

func (x *Event) GetId() string

func (*Event) GetName added in v0.0.2 

func (x *Event) GetName() string

func (*Event) GetPayload added in v0.0.2 

func (x *Event) GetPayload() *structpb.Struct

func (*Event) GetPublishedAt added in v0.0.2 

func (x *Event) GetPublishedAt() *timestamppb.Timestamp

func (*Event) GetRequestMetadata added in v0.0.2 

func (x *Event) GetRequestMetadata() *structpb.Value

func (*Event) GetTarget added in v0.0.2 

func (x *Event) GetTarget() *ServiceEventTarget

func (*Event) ProtoMessage added in v0.0.2 

func (*Event) ProtoMessage()

func (*Event) ProtoReflect added in v0.0.2 

func (x *Event) ProtoReflect() protoreflect.Message

func (*Event) Reset added in v0.0.2 

func (x *Event) Reset()

func (*Event) String added in v0.0.2 

func (x *Event) String() string

type EventServiceClient 

type EventServiceClient interface {
	// Stream Events
	// buf:lint:ignore RPC_REQUEST_STANDARD_NAME
	// buf:lint:ignore RPC_RESPONSE_STANDARD_NAME
	Stream(ctx context.Context, opts ...grpc.CallOption) (EventService_StreamClient, error)
	// Publish Event
	// buf:lint:ignore RPC_REQUEST_STANDARD_NAME
	// buf:lint:ignore RPC_RESPONSE_STANDARD_NAME
	Publish(ctx context.Context, in *PublishEventRequest, opts ...grpc.CallOption) (*PublishEventResponse, error)
}

EventServiceClient is the client API for EventService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewEventServiceClient 

func NewEventServiceClient(cc grpc.ClientConnInterface) EventServiceClient

type EventServiceServer 

type EventServiceServer interface {
	// Stream Events
	// buf:lint:ignore RPC_REQUEST_STANDARD_NAME
	// buf:lint:ignore RPC_RESPONSE_STANDARD_NAME
	Stream(EventService_StreamServer) error
	// Publish Event
	// buf:lint:ignore RPC_REQUEST_STANDARD_NAME
	// buf:lint:ignore RPC_RESPONSE_STANDARD_NAME
	Publish(context.Context, *PublishEventRequest) (*PublishEventResponse, error)
}

EventServiceServer is the server API for EventService service. All implementations should embed UnimplementedEventServiceServer for forward compatibility

type EventService_StreamClient 

type EventService_StreamClient interface {
	Send(*EventsStreamRequest) error
	Recv() (*EventsStreamResponse, error)
	grpc.ClientStream
}

type EventService_StreamServer 

type EventService_StreamServer interface {
	Send(*EventsStreamResponse) error
	Recv() (*EventsStreamRequest, error)
	grpc.ServerStream
}

type EventTarget 

type EventTarget struct {

	// Subscribe to events in a given collection.
	CollectionId *string `protobuf:"bytes,5,opt,name=collection_id,json=collectionId,proto3,oneof" json:"collection_id,omitempty"`
	// Subscribe to events in a given project.
	ProjectId *string `protobuf:"bytes,4,opt,name=project_id,json=projectId,proto3,oneof" json:"project_id,omitempty"`
	// Stream events to a specific layout.
	// Note: when specified, collection_id and project_id are implictly defined. If you choose
	// to define them, you they _must_ match the layout.
	LayoutId *string `protobuf:"bytes,1,opt,name=layout_id,json=layoutId,proto3,oneof" json:"layout_id,omitempty"`
	// contains filtered or unexported fields
}

Targetting for an event Event targetting allows you to listen or publish an event against a specific target. You can assume that: When subscribing, you will receive events for the chosen scope and any higher scope that isn't targetted. This means - An event published against a layoutId can be listened to by targetting the given layoutId, projectId or collectionId - An event published against a collectionId can be subscribed by scoping to any given projectId or layoutId under the collection.

func (*EventTarget) Descriptor deprecated 

func (*EventTarget) Descriptor() ([]byte, []int)

Deprecated: Use EventTarget.ProtoReflect.Descriptor instead.

func (*EventTarget) GetCollectionId 

func (x *EventTarget) GetCollectionId() string

func (*EventTarget) GetLayoutId 

func (x *EventTarget) GetLayoutId() string

func (*EventTarget) GetProjectId 

func (x *EventTarget) GetProjectId() string

func (*EventTarget) ProtoMessage 

func (*EventTarget) ProtoMessage()

func (*EventTarget) ProtoReflect 

func (x *EventTarget) ProtoReflect() protoreflect.Message

func (*EventTarget) Reset 

func (x *EventTarget) Reset()

func (*EventTarget) String 

func (x *EventTarget) String() string

type EventsStreamError 

type EventsStreamError struct {

	// The GRPC error code for the event.
	Code int32 `protobuf:"varint,1,opt,name=code,proto3" json:"code,omitempty"`
	// A mesasage indicating what the error is.
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

Indicates an error with a message sent to the Event API. Tie `correlation_id` on the message sent to the Event API and the `correlation_id` on the parent message to understand which request this error is for.

func (*EventsStreamError) Descriptor deprecated 

func (*EventsStreamError) Descriptor() ([]byte, []int)

Deprecated: Use EventsStreamError.ProtoReflect.Descriptor instead.

func (*EventsStreamError) GetCode 

func (x *EventsStreamError) GetCode() int32

func (*EventsStreamError) GetMessage 

func (x *EventsStreamError) GetMessage() string

func (*EventsStreamError) ProtoMessage 

func (*EventsStreamError) ProtoMessage()

func (*EventsStreamError) ProtoReflect 

func (x *EventsStreamError) ProtoReflect() protoreflect.Message

func (*EventsStreamError) Reset 

func (x *EventsStreamError) Reset()

func (*EventsStreamError) String 

func (x *EventsStreamError) String() string

type EventsStreamMessageType 

type EventsStreamMessageType int32
const (
	EventsStreamMessageType_EVENTS_STREAM_MESSAGE_TYPE_UNSPECIFIED  EventsStreamMessageType = 0
	EventsStreamMessageType_EVENTS_STREAM_MESSAGE_TYPE_PING         EventsStreamMessageType = 1
	EventsStreamMessageType_EVENTS_STREAM_MESSAGE_TYPE_ERROR        EventsStreamMessageType = 2
	EventsStreamMessageType_EVENTS_STREAM_MESSAGE_TYPE_SUBSCRIBED   EventsStreamMessageType = 3
	EventsStreamMessageType_EVENTS_STREAM_MESSAGE_TYPE_UNSUBSCRIBED EventsStreamMessageType = 4
	EventsStreamMessageType_EVENTS_STREAM_MESSAGE_TYPE_PUBLISHED    EventsStreamMessageType = 5
)

func (EventsStreamMessageType) Descriptor 

func (EventsStreamMessageType) Descriptor() protoreflect.EnumDescriptor

func (EventsStreamMessageType) Enum 

func (x EventsStreamMessageType) Enum() *EventsStreamMessageType

func (EventsStreamMessageType) EnumDescriptor deprecated 

func (EventsStreamMessageType) EnumDescriptor() ([]byte, []int)

Deprecated: Use EventsStreamMessageType.Descriptor instead.

func (EventsStreamMessageType) Number 

func (x EventsStreamMessageType) Number() protoreflect.EnumNumber

func (EventsStreamMessageType) String 

func (x EventsStreamMessageType) String() string

func (EventsStreamMessageType) Type 

func (EventsStreamMessageType) Type() protoreflect.EnumType

type EventsStreamReconnectRequest 

type EventsStreamReconnectRequest struct {

	// Whether the access token needs to be refreshed before reconnecting.
	Reauthenticate bool `protobuf:"varint,1,opt,name=reauthenticate,proto3" json:"reauthenticate,omitempty"`
	// A timestamp indicating when the connection should be reconnected by.
	// If you're maintaining multiple connections, you should reconnect at a random interval within this time range.
	BeforeTimestamp string `protobuf:"bytes,2,opt,name=before_timestamp,json=beforeTimestamp,proto3" json:"before_timestamp,omitempty"`
	// contains filtered or unexported fields
}

Indicate to the client that they should re-open their connection

func (*EventsStreamReconnectRequest) Descriptor deprecated 

func (*EventsStreamReconnectRequest) Descriptor() ([]byte, []int)

Deprecated: Use EventsStreamReconnectRequest.ProtoReflect.Descriptor instead.

func (*EventsStreamReconnectRequest) GetBeforeTimestamp 

func (x *EventsStreamReconnectRequest) GetBeforeTimestamp() string

func (*EventsStreamReconnectRequest) GetReauthenticate 

func (x *EventsStreamReconnectRequest) GetReauthenticate() bool

func (*EventsStreamReconnectRequest) ProtoMessage 

func (*EventsStreamReconnectRequest) ProtoMessage()

func (*EventsStreamReconnectRequest) ProtoReflect 

func (x *EventsStreamReconnectRequest) ProtoReflect() protoreflect.Message

func (*EventsStreamReconnectRequest) Reset 

func (x *EventsStreamReconnectRequest) Reset()

func (*EventsStreamReconnectRequest) String 

func (x *EventsStreamReconnectRequest) String() string

type EventsStreamRequest 

type EventsStreamRequest struct {

	// Optional value to tag any return values with. This can be any string-based value
	// that your are able to track.
	CorrelationId *string `protobuf:"bytes,1,opt,name=correlation_id,json=correlationId,proto3,oneof" json:"correlation_id,omitempty"`
	// Types that are assignable to EventPayload:
	//
	//	*EventsStreamRequest_Subscribe
	//	*EventsStreamRequest_Unsubscribe
	//	*EventsStreamRequest_Publish
	//	*EventsStreamRequest_Ping
	EventPayload isEventsStreamRequest_EventPayload `protobuf_oneof:"event_payload"`
	// contains filtered or unexported fields
}

Payload sent to the event API

func (*EventsStreamRequest) Descriptor deprecated 

func (*EventsStreamRequest) Descriptor() ([]byte, []int)

Deprecated: Use EventsStreamRequest.ProtoReflect.Descriptor instead.

func (*EventsStreamRequest) GetCorrelationId 

func (x *EventsStreamRequest) GetCorrelationId() string

func (*EventsStreamRequest) GetEventPayload 

func (m *EventsStreamRequest) GetEventPayload() isEventsStreamRequest_EventPayload

func (*EventsStreamRequest) GetPing 

func (x *EventsStreamRequest) GetPing() string

func (*EventsStreamRequest) GetPublish 

func (x *EventsStreamRequest) GetPublish() *PublishEventRequest

func (*EventsStreamRequest) GetSubscribe 

func (x *EventsStreamRequest) GetSubscribe() *SubscribePayload

func (*EventsStreamRequest) GetUnsubscribe 

func (x *EventsStreamRequest) GetUnsubscribe() *SubscribePayload

func (*EventsStreamRequest) ProtoMessage 

func (*EventsStreamRequest) ProtoMessage()

func (*EventsStreamRequest) ProtoReflect 

func (x *EventsStreamRequest) ProtoReflect() protoreflect.Message

func (*EventsStreamRequest) Reset 

func (x *EventsStreamRequest) Reset()

func (*EventsStreamRequest) String 

func (x *EventsStreamRequest) String() string

type EventsStreamRequest_Ping 

type EventsStreamRequest_Ping struct {
	// Initiate a ping-pong message.
	Ping string `protobuf:"bytes,103,opt,name=ping,proto3,oneof"`
}

type EventsStreamRequest_Publish 

type EventsStreamRequest_Publish struct {
	// Publish a new event.
	Publish *PublishEventRequest `protobuf:"bytes,102,opt,name=publish,proto3,oneof"`
}

type EventsStreamRequest_Subscribe 

type EventsStreamRequest_Subscribe struct {
	// Subscribe to a new event.
	Subscribe *SubscribePayload `protobuf:"bytes,100,opt,name=subscribe,proto3,oneof"`
}

type EventsStreamRequest_Unsubscribe 

type EventsStreamRequest_Unsubscribe struct {
	// Unsubscribe from an event.
	Unsubscribe *SubscribePayload `protobuf:"bytes,101,opt,name=unsubscribe,proto3,oneof"`
}

type EventsStreamResponse 

type EventsStreamResponse struct {

	// Optional value to tag any return values with.
	// Correlation ID should be used to correlate requests sent down the socket,
	// enabling you to tie a `PUBLISH` to a `PUBLISHED“
	CorrelationId *string `protobuf:"bytes,2,opt,name=correlation_id,json=correlationId,proto3,oneof" json:"correlation_id,omitempty"`
	// Optional session id
	// This is set by sending the `SessionId` header for any HTTP requests
	// and the `sessionId` query parameter for websockets.
	SessionId *string `protobuf:"bytes,3,opt,name=session_id,json=sessionId,proto3,oneof" json:"session_id,omitempty"`
	// Types that are assignable to EventPayload:
	//
	//	*EventsStreamResponse_Event
	//	*EventsStreamResponse_Pong
	//	*EventsStreamResponse_Error
	//	*EventsStreamResponse_Subscribed
	//	*EventsStreamResponse_Unsubscribed
	//	*EventsStreamResponse_Published
	//	*EventsStreamResponse_ReconnectBefore
	EventPayload isEventsStreamResponse_EventPayload `protobuf_oneof:"event_payload"`
	// contains filtered or unexported fields
}

Payload returned from the event API.

func (*EventsStreamResponse) Descriptor deprecated 

func (*EventsStreamResponse) Descriptor() ([]byte, []int)

Deprecated: Use EventsStreamResponse.ProtoReflect.Descriptor instead.

func (*EventsStreamResponse) GetCorrelationId 

func (x *EventsStreamResponse) GetCorrelationId() string

func (*EventsStreamResponse) GetError 

func (x *EventsStreamResponse) GetError() *EventsStreamError

func (*EventsStreamResponse) GetEvent 

func (x *EventsStreamResponse) GetEvent() *PublishEventResponse

func (*EventsStreamResponse) GetEventPayload 

func (m *EventsStreamResponse) GetEventPayload() isEventsStreamResponse_EventPayload

func (*EventsStreamResponse) GetPong 

func (x *EventsStreamResponse) GetPong() string

func (*EventsStreamResponse) GetPublished 

func (x *EventsStreamResponse) GetPublished() *PublishEventResponse

func (*EventsStreamResponse) GetReconnectBefore 

func (x *EventsStreamResponse) GetReconnectBefore() *EventsStreamReconnectRequest

func (*EventsStreamResponse) GetSessionId 

func (x *EventsStreamResponse) GetSessionId() string

func (*EventsStreamResponse) GetSubscribed 

func (x *EventsStreamResponse) GetSubscribed() *SubscribePayload

func (*EventsStreamResponse) GetUnsubscribed 

func (x *EventsStreamResponse) GetUnsubscribed() *SubscribePayload

func (*EventsStreamResponse) ProtoMessage 

func (*EventsStreamResponse) ProtoMessage()

func (*EventsStreamResponse) ProtoReflect 

func (x *EventsStreamResponse) ProtoReflect() protoreflect.Message

func (*EventsStreamResponse) Reset 

func (x *EventsStreamResponse) Reset()

func (*EventsStreamResponse) String 

func (x *EventsStreamResponse) String() string

type EventsStreamResponse_Error 

type EventsStreamResponse_Error struct {
	// Non-blocking streaming error
	Error *EventsStreamError `protobuf:"bytes,201,opt,name=error,proto3,oneof"`
}

type EventsStreamResponse_Event 

type EventsStreamResponse_Event struct {
	// Custom event emitted
	Event *PublishEventResponse `protobuf:"bytes,100,opt,name=event,proto3,oneof"`
}

type EventsStreamResponse_Pong 

type EventsStreamResponse_Pong struct {
	// Ping payload
	Pong string `protobuf:"bytes,200,opt,name=pong,proto3,oneof"`
}

type EventsStreamResponse_Published 

type EventsStreamResponse_Published struct {
	// Publish a new event.
	Published *PublishEventResponse `protobuf:"bytes,204,opt,name=published,proto3,oneof"`
}

type EventsStreamResponse_ReconnectBefore 

type EventsStreamResponse_ReconnectBefore struct {
	// Inform the client should reoconnect before a timestamp.
	ReconnectBefore *EventsStreamReconnectRequest `protobuf:"bytes,205,opt,name=reconnect_before,json=reconnectBefore,proto3,oneof"`
}

type EventsStreamResponse_Subscribed 

type EventsStreamResponse_Subscribed struct {
	// Subscribe to a new event.
	Subscribed *SubscribePayload `protobuf:"bytes,202,opt,name=subscribed,proto3,oneof"`
}

type EventsStreamResponse_Unsubscribed 

type EventsStreamResponse_Unsubscribed struct {
	// Unsubscribe from an event.
	Unsubscribed *SubscribePayload `protobuf:"bytes,203,opt,name=unsubscribed,proto3,oneof"`
}

type GetEventsQuery added in v0.0.2 

type GetEventsQuery struct {

	// Defaults to 100
	Limit int32 `protobuf:"varint,1,opt,name=limit,proto3" json:"limit,omitempty"`
	// Defaults to CREATED_AT_DESC
	Order  GetEventsQuery_PaginationOrder `protobuf:"varint,2,opt,name=order,proto3,enum=apis.event.v2.GetEventsQuery_PaginationOrder" json:"order,omitempty"`
	Events []string                       `protobuf:"bytes,3,rep,name=events,proto3" json:"events,omitempty"`
	// The target to filter by.
	Target *GetEventsQuery_Target `protobuf:"bytes,4,opt,name=target,proto3,oneof" json:"target,omitempty"`
	// Defaults to 1 day ago
	AfterTimestamp *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=after_timestamp,json=afterTimestamp,proto3,oneof" json:"after_timestamp,omitempty"`
	// Defaults to now
	BeforeTimestamp *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=before_timestamp,json=beforeTimestamp,proto3,oneof" json:"before_timestamp,omitempty"`
	// contains filtered or unexported fields
}

func (*GetEventsQuery) Descriptor deprecated added in v0.0.2 

func (*GetEventsQuery) Descriptor() ([]byte, []int)

Deprecated: Use GetEventsQuery.ProtoReflect.Descriptor instead.

func (*GetEventsQuery) GetAfterTimestamp added in v0.0.2 

func (x *GetEventsQuery) GetAfterTimestamp() *timestamppb.Timestamp

func (*GetEventsQuery) GetBeforeTimestamp added in v0.0.2 

func (x *GetEventsQuery) GetBeforeTimestamp() *timestamppb.Timestamp

func (*GetEventsQuery) GetEvents added in v0.0.2 

func (x *GetEventsQuery) GetEvents() []string

func (*GetEventsQuery) GetLimit added in v0.0.2 

func (x *GetEventsQuery) GetLimit() int32

func (*GetEventsQuery) GetOrder added in v0.0.2 

func (x *GetEventsQuery) GetOrder() GetEventsQuery_PaginationOrder

func (*GetEventsQuery) GetTarget added in v0.0.2 

func (x *GetEventsQuery) GetTarget() *GetEventsQuery_Target

func (*GetEventsQuery) ProtoMessage added in v0.0.2 

func (*GetEventsQuery) ProtoMessage()

func (*GetEventsQuery) ProtoReflect added in v0.0.2 

func (x *GetEventsQuery) ProtoReflect() protoreflect.Message

func (*GetEventsQuery) Reset added in v0.0.2 

func (x *GetEventsQuery) Reset()

func (*GetEventsQuery) String added in v0.0.2 

func (x *GetEventsQuery) String() string

type GetEventsQuery_PaginationOrder added in v0.0.2 

type GetEventsQuery_PaginationOrder int32
const (
	GetEventsQuery_PAGINATION_ORDER_UNSPECIFIED     GetEventsQuery_PaginationOrder = 0
	GetEventsQuery_PAGINATION_ORDER_CREATED_AT_DESC GetEventsQuery_PaginationOrder = 1
	GetEventsQuery_PAGINATION_ORDER_CREATED_AT_ASC  GetEventsQuery_PaginationOrder = 2
)

func (GetEventsQuery_PaginationOrder) Descriptor added in v0.0.2 

func (GetEventsQuery_PaginationOrder) Descriptor() protoreflect.EnumDescriptor

func (GetEventsQuery_PaginationOrder) Enum added in v0.0.2 

func (x GetEventsQuery_PaginationOrder) Enum() *GetEventsQuery_PaginationOrder

func (GetEventsQuery_PaginationOrder) EnumDescriptor deprecated added in v0.0.2 

func (GetEventsQuery_PaginationOrder) EnumDescriptor() ([]byte, []int)

Deprecated: Use GetEventsQuery_PaginationOrder.Descriptor instead.

func (GetEventsQuery_PaginationOrder) Number added in v0.0.2 

func (x GetEventsQuery_PaginationOrder) Number() protoreflect.EnumNumber

func (GetEventsQuery_PaginationOrder) String added in v0.0.2 

func (x GetEventsQuery_PaginationOrder) String() string

func (GetEventsQuery_PaginationOrder) Type added in v0.0.2 

func (GetEventsQuery_PaginationOrder) Type() protoreflect.EnumType

type GetEventsQuery_Target added in v0.0.2 

type GetEventsQuery_Target struct {
	ServiceUserId *GetEventsQuery_TargetValue `protobuf:"bytes,1,opt,name=service_user_id,json=serviceUserId,proto3,oneof" json:"service_user_id,omitempty"`
	CollectionId  *GetEventsQuery_TargetValue `protobuf:"bytes,2,opt,name=collection_id,json=collectionId,proto3,oneof" json:"collection_id,omitempty"`
	ProjectId     *GetEventsQuery_TargetValue `protobuf:"bytes,3,opt,name=project_id,json=projectId,proto3,oneof" json:"project_id,omitempty"`
	LayoutId      *GetEventsQuery_TargetValue `protobuf:"bytes,4,opt,name=layout_id,json=layoutId,proto3,oneof" json:"layout_id,omitempty"`
	// contains filtered or unexported fields
}

func (*GetEventsQuery_Target) Descriptor deprecated added in v0.0.2 

func (*GetEventsQuery_Target) Descriptor() ([]byte, []int)

Deprecated: Use GetEventsQuery_Target.ProtoReflect.Descriptor instead.

func (*GetEventsQuery_Target) GetCollectionId added in v0.0.2 

func (x *GetEventsQuery_Target) GetCollectionId() *GetEventsQuery_TargetValue

func (*GetEventsQuery_Target) GetLayoutId added in v0.0.2 

func (x *GetEventsQuery_Target) GetLayoutId() *GetEventsQuery_TargetValue

func (*GetEventsQuery_Target) GetProjectId added in v0.0.2 

func (x *GetEventsQuery_Target) GetProjectId() *GetEventsQuery_TargetValue

func (*GetEventsQuery_Target) GetServiceUserId added in v0.0.2 

func (x *GetEventsQuery_Target) GetServiceUserId() *GetEventsQuery_TargetValue

func (*GetEventsQuery_Target) ProtoMessage added in v0.0.2 

func (*GetEventsQuery_Target) ProtoMessage()

func (*GetEventsQuery_Target) ProtoReflect added in v0.0.2 

func (x *GetEventsQuery_Target) ProtoReflect() protoreflect.Message

func (*GetEventsQuery_Target) Reset added in v0.0.2 

func (x *GetEventsQuery_Target) Reset()

func (*GetEventsQuery_Target) String added in v0.0.2 

func (x *GetEventsQuery_Target) String() string

type GetEventsQuery_TargetValue added in v0.0.2 

type GetEventsQuery_TargetValue struct {
	Value string `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
	// By default this is assumed to be true, if set to false any events that aren't explicitly targetted will be included.
	// E.g you want to receive all events for a layout, but also want to receive broadcast events (only scoped to the project).
	ExplicitOnly bool `protobuf:"varint,2,opt,name=explicit_only,json=explicitOnly,proto3" json:"explicit_only,omitempty"`
	// contains filtered or unexported fields
}

func (*GetEventsQuery_TargetValue) Descriptor deprecated added in v0.0.2 

func (*GetEventsQuery_TargetValue) Descriptor() ([]byte, []int)

Deprecated: Use GetEventsQuery_TargetValue.ProtoReflect.Descriptor instead.

func (*GetEventsQuery_TargetValue) GetExplicitOnly added in v0.0.2 

func (x *GetEventsQuery_TargetValue) GetExplicitOnly() bool

func (*GetEventsQuery_TargetValue) GetValue added in v0.0.2 

func (x *GetEventsQuery_TargetValue) GetValue() string

func (*GetEventsQuery_TargetValue) ProtoMessage added in v0.0.2 

func (*GetEventsQuery_TargetValue) ProtoMessage()

func (*GetEventsQuery_TargetValue) ProtoReflect added in v0.0.2 

func (x *GetEventsQuery_TargetValue) ProtoReflect() protoreflect.Message

func (*GetEventsQuery_TargetValue) Reset added in v0.0.2 

func (x *GetEventsQuery_TargetValue) Reset()

func (*GetEventsQuery_TargetValue) String added in v0.0.2 

func (x *GetEventsQuery_TargetValue) String() string

type GetEventsRequest added in v0.0.2 

type GetEventsRequest struct {

	// Types that are assignable to Filter:
	//
	//	*GetEventsRequest_Cursor
	//	*GetEventsRequest_Query
	Filter isGetEventsRequest_Filter `protobuf_oneof:"filter"`
	// contains filtered or unexported fields
}

func (*GetEventsRequest) Descriptor deprecated added in v0.0.2 

func (*GetEventsRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetEventsRequest.ProtoReflect.Descriptor instead.

func (*GetEventsRequest) GetCursor added in v0.0.2 

func (x *GetEventsRequest) GetCursor() string

func (*GetEventsRequest) GetFilter added in v0.0.2 

func (m *GetEventsRequest) GetFilter() isGetEventsRequest_Filter

func (*GetEventsRequest) GetQuery added in v0.0.2 

func (x *GetEventsRequest) GetQuery() *GetEventsQuery

func (*GetEventsRequest) ProtoMessage added in v0.0.2 

func (*GetEventsRequest) ProtoMessage()

func (*GetEventsRequest) ProtoReflect added in v0.0.2 

func (x *GetEventsRequest) ProtoReflect() protoreflect.Message

func (*GetEventsRequest) Reset added in v0.0.2 

func (x *GetEventsRequest) Reset()

func (*GetEventsRequest) String added in v0.0.2 

func (x *GetEventsRequest) String() string

type GetEventsRequest_Cursor added in v0.0.2 

type GetEventsRequest_Cursor struct {
	Cursor string `protobuf:"bytes,1,opt,name=cursor,proto3,oneof"`
}

type GetEventsRequest_Query added in v0.0.2 

type GetEventsRequest_Query struct {
	Query *GetEventsQuery `protobuf:"bytes,2,opt,name=query,proto3,oneof"`
}

type GetEventsResponse added in v0.0.2 

type GetEventsResponse struct {
	Events     []*Event `protobuf:"bytes,1,rep,name=events,proto3" json:"events,omitempty"`
	NextCursor *string  `protobuf:"bytes,2,opt,name=next_cursor,json=nextCursor,proto3,oneof" json:"next_cursor,omitempty"`
	// contains filtered or unexported fields
}

func (*GetEventsResponse) Descriptor deprecated added in v0.0.2 

func (*GetEventsResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetEventsResponse.ProtoReflect.Descriptor instead.

func (*GetEventsResponse) GetEvents added in v0.0.2 

func (x *GetEventsResponse) GetEvents() []*Event

func (*GetEventsResponse) GetNextCursor added in v0.0.2 

func (x *GetEventsResponse) GetNextCursor() string

func (*GetEventsResponse) ProtoMessage added in v0.0.2 

func (*GetEventsResponse) ProtoMessage()

func (*GetEventsResponse) ProtoReflect added in v0.0.2 

func (x *GetEventsResponse) ProtoReflect() protoreflect.Message

func (*GetEventsResponse) Reset added in v0.0.2 

func (x *GetEventsResponse) Reset()

func (*GetEventsResponse) String added in v0.0.2 

func (x *GetEventsResponse) String() string

type HistoryServiceClient added in v0.0.2 

type HistoryServiceClient interface {
	GetEvents(ctx context.Context, in *GetEventsRequest, opts ...grpc.CallOption) (*GetEventsResponse, error)
}

HistoryServiceClient is the client API for HistoryService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewHistoryServiceClient added in v0.0.2 

func NewHistoryServiceClient(cc grpc.ClientConnInterface) HistoryServiceClient

type HistoryServiceServer added in v0.0.2 

type HistoryServiceServer interface {
	GetEvents(context.Context, *GetEventsRequest) (*GetEventsResponse, error)
}

HistoryServiceServer is the server API for HistoryService service. All implementations should embed UnimplementedHistoryServiceServer for forward compatibility

type ListWebhookSubscriptionsRequest added in v0.0.2 

type ListWebhookSubscriptionsRequest struct {

	// The target to filter by.
	Target *ServiceEventTarget `protobuf:"bytes,1,opt,name=target,proto3,oneof" json:"target,omitempty"`
	// contains filtered or unexported fields
}

func (*ListWebhookSubscriptionsRequest) Descriptor deprecated added in v0.0.2 

func (*ListWebhookSubscriptionsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListWebhookSubscriptionsRequest.ProtoReflect.Descriptor instead.

func (*ListWebhookSubscriptionsRequest) GetTarget added in v0.0.2 

func (x *ListWebhookSubscriptionsRequest) GetTarget() *ServiceEventTarget

func (*ListWebhookSubscriptionsRequest) ProtoMessage added in v0.0.2 

func (*ListWebhookSubscriptionsRequest) ProtoMessage()

func (*ListWebhookSubscriptionsRequest) ProtoReflect added in v0.0.2 

func (x *ListWebhookSubscriptionsRequest) ProtoReflect() protoreflect.Message

func (*ListWebhookSubscriptionsRequest) Reset added in v0.0.2 

func (x *ListWebhookSubscriptionsRequest) Reset()

func (*ListWebhookSubscriptionsRequest) String added in v0.0.2 

func (x *ListWebhookSubscriptionsRequest) String() string

type ListWebhookSubscriptionsResponse added in v0.0.2 

type ListWebhookSubscriptionsResponse struct {
	Subscriptions []*WebhookSubscription `protobuf:"bytes,1,rep,name=subscriptions,proto3" json:"subscriptions,omitempty"`
	// contains filtered or unexported fields
}

func (*ListWebhookSubscriptionsResponse) Descriptor deprecated added in v0.0.2 

func (*ListWebhookSubscriptionsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListWebhookSubscriptionsResponse.ProtoReflect.Descriptor instead.

func (*ListWebhookSubscriptionsResponse) GetSubscriptions added in v0.0.2 

func (x *ListWebhookSubscriptionsResponse) GetSubscriptions() []*WebhookSubscription

func (*ListWebhookSubscriptionsResponse) ProtoMessage added in v0.0.2 

func (*ListWebhookSubscriptionsResponse) ProtoMessage()

func (*ListWebhookSubscriptionsResponse) ProtoReflect added in v0.0.2 

func (x *ListWebhookSubscriptionsResponse) ProtoReflect() protoreflect.Message

func (*ListWebhookSubscriptionsResponse) Reset added in v0.0.2 

func (x *ListWebhookSubscriptionsResponse) Reset()

func (*ListWebhookSubscriptionsResponse) String added in v0.0.2 

func (x *ListWebhookSubscriptionsResponse) String() string

type PublishEventRequest 

type PublishEventRequest struct {

	// Name of the event.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Value of the event. This can be a free-form value which we do not inspect.
	Payload *structpb.Struct `protobuf:"bytes,2,opt,name=payload,proto3" json:"payload,omitempty"`
	// Metadata associated with the publishing of the event.
	// Typically this is information about _why_ the event happened. Use `payload` for
	// _what_ the event is.
	RequestMetadata *structpb.Value `protobuf:"bytes,4,opt,name=request_metadata,json=requestMetadata,proto3,oneof" json:"request_metadata,omitempty"`
	// Scope the event to a specific target
	Target *EventTarget `protobuf:"bytes,3,opt,name=target,proto3,oneof" json:"target,omitempty"`
	// contains filtered or unexported fields
}

Publish a custom event

func (*PublishEventRequest) Descriptor deprecated 

func (*PublishEventRequest) Descriptor() ([]byte, []int)

Deprecated: Use PublishEventRequest.ProtoReflect.Descriptor instead.

func (*PublishEventRequest) GetName 

func (x *PublishEventRequest) GetName() string

func (*PublishEventRequest) GetPayload 

func (x *PublishEventRequest) GetPayload() *structpb.Struct

func (*PublishEventRequest) GetRequestMetadata 

func (x *PublishEventRequest) GetRequestMetadata() *structpb.Value

func (*PublishEventRequest) GetTarget 

func (x *PublishEventRequest) GetTarget() *EventTarget

func (*PublishEventRequest) ProtoMessage 

func (*PublishEventRequest) ProtoMessage()

func (*PublishEventRequest) ProtoReflect 

func (x *PublishEventRequest) ProtoReflect() protoreflect.Message

func (*PublishEventRequest) Reset 

func (x *PublishEventRequest) Reset()

func (*PublishEventRequest) String 

func (x *PublishEventRequest) String() string

type PublishEventResponse 

type PublishEventResponse struct {

	// Name of the event.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Value of the event.
	Payload *structpb.Struct `protobuf:"bytes,2,opt,name=payload,proto3" json:"payload,omitempty"`
	// Custom scoping parameters.
	Target *EventTarget `protobuf:"bytes,3,opt,name=target,proto3,oneof" json:"target,omitempty"`
	// Metadata associated with the publishing of the event
	RequestMetadata *structpb.Value `protobuf:"bytes,4,opt,name=request_metadata,json=requestMetadata,proto3,oneof" json:"request_metadata,omitempty"`
	// Internal ID of the event.
	Id string `protobuf:"bytes,5,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

Response of an event being forwarded to a subscription. note: if this socket is also the publisher, this payload will be sent twice. Once for `published` and once for `event`. You can use `correlation_id` to identify the published event.

func (*PublishEventResponse) Descriptor deprecated 

func (*PublishEventResponse) Descriptor() ([]byte, []int)

Deprecated: Use PublishEventResponse.ProtoReflect.Descriptor instead.

func (*PublishEventResponse) GetId 

func (x *PublishEventResponse) GetId() string

func (*PublishEventResponse) GetName 

func (x *PublishEventResponse) GetName() string

func (*PublishEventResponse) GetPayload 

func (x *PublishEventResponse) GetPayload() *structpb.Struct

func (*PublishEventResponse) GetRequestMetadata 

func (x *PublishEventResponse) GetRequestMetadata() *structpb.Value

func (*PublishEventResponse) GetTarget 

func (x *PublishEventResponse) GetTarget() *EventTarget

func (*PublishEventResponse) ProtoMessage 

func (*PublishEventResponse) ProtoMessage()

func (*PublishEventResponse) ProtoReflect 

func (x *PublishEventResponse) ProtoReflect() protoreflect.Message

func (*PublishEventResponse) Reset 

func (x *PublishEventResponse) Reset()

func (*PublishEventResponse) String 

func (x *PublishEventResponse) String() string

type ServiceEventTarget added in v0.0.2 

type ServiceEventTarget struct {

	// Subscribe to events in a given collection.
	// this is deprecated, prefer `service_user_id`.
	UserId *string `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3,oneof" json:"user_id,omitempty"`
	// Subscribe to events in a given collection.
	CollectionId *string `protobuf:"bytes,2,opt,name=collection_id,json=collectionId,proto3,oneof" json:"collection_id,omitempty"`
	// Subscribe to events in a given project.
	ProjectId *string `protobuf:"bytes,3,opt,name=project_id,json=projectId,proto3,oneof" json:"project_id,omitempty"`
	// Stream events to a specific layout.
	// Note: when specified, collection_id and project_id are implictly defined. If you choose
	// to define them, you they _must_ match the layout.
	LayoutId *string `protobuf:"bytes,4,opt,name=layout_id,json=layoutId,proto3,oneof" json:"layout_id,omitempty"`
	// Subscribe to events by a given user, this takes priority over user_id
	ServiceUserId *string `protobuf:"bytes,5,opt,name=service_user_id,json=serviceUserId,proto3,oneof" json:"service_user_id,omitempty"`
	// contains filtered or unexported fields
}

func (*ServiceEventTarget) Descriptor deprecated added in v0.0.2 

func (*ServiceEventTarget) Descriptor() ([]byte, []int)

Deprecated: Use ServiceEventTarget.ProtoReflect.Descriptor instead.

func (*ServiceEventTarget) GetCollectionId added in v0.0.2 

func (x *ServiceEventTarget) GetCollectionId() string

func (*ServiceEventTarget) GetLayoutId added in v0.0.2 

func (x *ServiceEventTarget) GetLayoutId() string

func (*ServiceEventTarget) GetProjectId added in v0.0.2 

func (x *ServiceEventTarget) GetProjectId() string

func (*ServiceEventTarget) GetServiceUserId added in v0.0.2 

func (x *ServiceEventTarget) GetServiceUserId() string

func (*ServiceEventTarget) GetUserId added in v0.0.2 

func (x *ServiceEventTarget) GetUserId() string

func (*ServiceEventTarget) ProtoMessage added in v0.0.2 

func (*ServiceEventTarget) ProtoMessage()

func (*ServiceEventTarget) ProtoReflect added in v0.0.2 

func (x *ServiceEventTarget) ProtoReflect() protoreflect.Message

func (*ServiceEventTarget) Reset added in v0.0.2 

func (x *ServiceEventTarget) Reset()

func (*ServiceEventTarget) String added in v0.0.2 

func (x *ServiceEventTarget) String() string

type SubscribePayload 

type SubscribePayload struct {

	// Event name to subscribe to for custom events.
	// This can be a wildcard `my_service:*` or multiple events `my_event|my_other_event`. This is deprecated, prefer `events`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Event name to subscribe to for custom events, this can be a wildcard `my_service:*`
	Events []string `protobuf:"bytes,3,rep,name=events,proto3" json:"events,omitempty"`
	// The target to subscribe to.
	Target *EventTarget `protobuf:"bytes,2,opt,name=target,proto3,oneof" json:"target,omitempty"`
	// contains filtered or unexported fields
}

Payload to subscribe or unsubscribe from an event

func (*SubscribePayload) Descriptor deprecated 

func (*SubscribePayload) Descriptor() ([]byte, []int)

Deprecated: Use SubscribePayload.ProtoReflect.Descriptor instead.

func (*SubscribePayload) GetEvents added in v0.0.2 

func (x *SubscribePayload) GetEvents() []string

func (*SubscribePayload) GetName 

func (x *SubscribePayload) GetName() string

func (*SubscribePayload) GetTarget 

func (x *SubscribePayload) GetTarget() *EventTarget

func (*SubscribePayload) ProtoMessage 

func (*SubscribePayload) ProtoMessage()

func (*SubscribePayload) ProtoReflect 

func (x *SubscribePayload) ProtoReflect() protoreflect.Message

func (*SubscribePayload) Reset 

func (x *SubscribePayload) Reset()

func (*SubscribePayload) String 

func (x *SubscribePayload) String() string

type UnimplementedEventServiceServer 

type UnimplementedEventServiceServer struct {
}

UnimplementedEventServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedEventServiceServer) Publish 

func (UnimplementedEventServiceServer) Publish(context.Context, *PublishEventRequest) (*PublishEventResponse, error)

func (UnimplementedEventServiceServer) Stream 

func (UnimplementedEventServiceServer) Stream(EventService_StreamServer) error

type UnimplementedHistoryServiceServer added in v0.0.2 

type UnimplementedHistoryServiceServer struct {
}

UnimplementedHistoryServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedHistoryServiceServer) GetEvents added in v0.0.2 

func (UnimplementedHistoryServiceServer) GetEvents(context.Context, *GetEventsRequest) (*GetEventsResponse, error)

type UnimplementedWebhookServiceServer added in v0.0.2 

type UnimplementedWebhookServiceServer struct {
}

UnimplementedWebhookServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedWebhookServiceServer) CreateWebhookSubscription added in v0.0.2 

func (UnimplementedWebhookServiceServer) CreateWebhookSubscription(context.Context, *CreateWebhookSubscriptionRequest) (*CreateWebhookSubscriptionResponse, error)

func (UnimplementedWebhookServiceServer) DeleteWebhookSubscription added in v0.0.2 

func (UnimplementedWebhookServiceServer) DeleteWebhookSubscription(context.Context, *DeleteWebhookSubscriptionRequest) (*DeleteWebhookSubscriptionResponse, error)

func (UnimplementedWebhookServiceServer) ListWebhookSubscriptions added in v0.0.2 

func (UnimplementedWebhookServiceServer) ListWebhookSubscriptions(context.Context, *ListWebhookSubscriptionsRequest) (*ListWebhookSubscriptionsResponse, error)

type UnsafeEventServiceServer 

type UnsafeEventServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeEventServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to EventServiceServer will result in compilation errors.

type UnsafeHistoryServiceServer added in v0.0.2 

type UnsafeHistoryServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeHistoryServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to HistoryServiceServer will result in compilation errors.

type UnsafeWebhookServiceServer added in v0.0.2 

type UnsafeWebhookServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeWebhookServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to WebhookServiceServer will result in compilation errors.

type WebhookServiceClient added in v0.0.2 

type WebhookServiceClient interface {
	// List all webhook subscriptions.
	ListWebhookSubscriptions(ctx context.Context, in *ListWebhookSubscriptionsRequest, opts ...grpc.CallOption) (*ListWebhookSubscriptionsResponse, error)
	// Create a new webhook subscription.
	CreateWebhookSubscription(ctx context.Context, in *CreateWebhookSubscriptionRequest, opts ...grpc.CallOption) (*CreateWebhookSubscriptionResponse, error)
	// Delete a webhook subscription.
	// Existing events queued will be delivered before the subscription is removed.
	DeleteWebhookSubscription(ctx context.Context, in *DeleteWebhookSubscriptionRequest, opts ...grpc.CallOption) (*DeleteWebhookSubscriptionResponse, error)
}

WebhookServiceClient is the client API for WebhookService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewWebhookServiceClient added in v0.0.2 

func NewWebhookServiceClient(cc grpc.ClientConnInterface) WebhookServiceClient

type WebhookServiceServer added in v0.0.2 

type WebhookServiceServer interface {
	// List all webhook subscriptions.
	ListWebhookSubscriptions(context.Context, *ListWebhookSubscriptionsRequest) (*ListWebhookSubscriptionsResponse, error)
	// Create a new webhook subscription.
	CreateWebhookSubscription(context.Context, *CreateWebhookSubscriptionRequest) (*CreateWebhookSubscriptionResponse, error)
	// Delete a webhook subscription.
	// Existing events queued will be delivered before the subscription is removed.
	DeleteWebhookSubscription(context.Context, *DeleteWebhookSubscriptionRequest) (*DeleteWebhookSubscriptionResponse, error)
}

WebhookServiceServer is the server API for WebhookService service. All implementations should embed UnimplementedWebhookServiceServer for forward compatibility

type WebhookSubscription added in v0.0.2 

type WebhookSubscription struct {

	// Subscription identifier
	WebhookId string `protobuf:"bytes,1,opt,name=webhook_id,json=webhookId,proto3" json:"webhook_id,omitempty"`
	// Event name to subscribe to for custom events, this can be a wildcard `my_service:*`
	Events []string `protobuf:"bytes,2,rep,name=events,proto3" json:"events,omitempty"`
	// The target to subscribe to. If not defined, all events will be sent.
	Target *ServiceEventTarget `protobuf:"bytes,3,opt,name=target,proto3,oneof" json:"target,omitempty"`
	// The URL to send the event to.
	Url       string  `protobuf:"bytes,4,opt,name=url,proto3" json:"url,omitempty"`
	TimeoutMs *uint32 `protobuf:"varint,5,opt,name=timeout_ms,json=timeoutMs,proto3,oneof" json:"timeout_ms,omitempty"`
	// contains filtered or unexported fields
}

func (*WebhookSubscription) Descriptor deprecated added in v0.0.2 

func (*WebhookSubscription) Descriptor() ([]byte, []int)

Deprecated: Use WebhookSubscription.ProtoReflect.Descriptor instead.

func (*WebhookSubscription) GetEvents added in v0.0.2 

func (x *WebhookSubscription) GetEvents() []string

func (*WebhookSubscription) GetTarget added in v0.0.2 

func (x *WebhookSubscription) GetTarget() *ServiceEventTarget

func (*WebhookSubscription) GetTimeoutMs added in v0.0.2 

func (x *WebhookSubscription) GetTimeoutMs() uint32

func (*WebhookSubscription) GetUrl added in v0.0.2 

func (x *WebhookSubscription) GetUrl() string

func (*WebhookSubscription) GetWebhookId added in v0.0.2 

func (x *WebhookSubscription) GetWebhookId() string

func (*WebhookSubscription) ProtoMessage added in v0.0.2 

func (*WebhookSubscription) ProtoMessage()

func (*WebhookSubscription) ProtoReflect added in v0.0.2 

func (x *WebhookSubscription) ProtoReflect() protoreflect.Message

func (*WebhookSubscription) Reset added in v0.0.2 

func (x *WebhookSubscription) Reset()

func (*WebhookSubscription) String added in v0.0.2 

func (x *WebhookSubscription) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.