events

API Reference: v1/events.proto

Table of Contents

Messages
- DPSEvent
- EventSubscriptionRequest
Scalar Value Types

Messages

DPSEvent

DPSEvent contains the event payload.

Field	Type	Description
when	google.protobuf.Timestamp	none
event_name	string	none
correlation_id	string	none
oneof event.ping	google.protobuf.Empty	none

EventSubscriptionRequest

Subscribes to one or more events. The subscriber id identifies the receiver, and must be unique among subscribers.

Field	Type	Description
event_names	repeated string	Names of the events to subscribe. If multiple, the returned stream will have all these subscribed events.
subscriber_id	string	The unique id of the subscriber. Messages will be queued by subscriber.
persistent	bool	If persistent, the subscription is a persistent subscription. An event queue will be kept for the subscriber and events will be queued when the subscriber is not actively connected. If a subscriber is not persistent, events will be delivered only when the subscriber is connected. Undelivered events will not be queued.

Scalar Value Types

.proto Type	Notes	C++ Type	Java Type	Python Type
double		double	double	float
float		float	float	float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long
uint32	Uses variable-length encoding.	uint32	int	int/long
uint64	Uses variable-length encoding.	uint64	long	int/long
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long
sfixed32	Always four bytes.	int32	int	int
sfixed64	Always eight bytes.	int64	long	int/long
bool		bool	boolean	boolean
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str