Protocol Documentation¶

Table of Contents¶

java/dev/enola/core/enola_core.proto
java/dev/enola/core/enola_ext.proto
- File-level Extensions
java/dev/enola/core/util/enola_util.proto
- Log
- Log.Entry
- Log.Inline
- Log.Severity
Scalar Value Types

java/dev/enola/core/enola_core.proto¶

GetFileDescriptorSetRequest¶

Intentionally empty (currently).

GetFileDescriptorSetResponse¶

Field	Type	Label	Description
protos	google.protobuf.FileDescriptorSet

GetThingRequest¶

Field	Type	Label	Description
iri	string		IRI of Thing to get. This may use an enola: scheme, see https://docs.enola.dev/concepts/uri.

GetThingResponse¶

Field	Type	Label	Description
thing	google.protobuf.Any		TODO Remove Any support by replacing this GetThingsResponse

GetThingsRequest¶

Field	Type	Label	Description
iri	string		IRI of a Thing to get, or query for Things; e.g. https://enola.dev/query/all?inline=true&limit=7, or sparql: or sql: something else like that.

GetThingsResponse¶

Field	Type	Label	Description
things	dev.enola.thing.Thing	repeated

EnolaService¶

This is the API with which Enola clients (such as a CLI or UI) connect.

Method Name	Request Type	Response Type
GetFileDescriptorSet	GetFileDescriptorSetRequest	GetFileDescriptorSetResponse
GetThing	GetThingRequest	GetThingResponse
GetThings	GetThingsRequest	GetThingsResponse

Top

java/dev/enola/core/enola_ext.proto¶

File-level Extensions¶

Extension	Type	Base	Number	Description
type	string	.google.protobuf.FieldOptions	2734

Top

java/dev/enola/core/util/enola_util.proto¶

Log¶

TODO Log isn't actually used, just yet…

Field	Type	Label	Description
url	string
inline	Log.Inline

Log.Entry¶

Field	Type	Label	Description
ts	google.protobuf.Timestamp
severity	Log.Severity
text	string

Log.Inline¶

Field	Type	Label	Description
entries	Log.Entry	repeated

Log.Severity¶

Inspired by https://cloud.google.com/service-infrastructure/docs/service-control/reference/rpc/google.logging.type, but could be extended here, as there is no real direct connection between this and GCP logging.

Name	Number	Description
SEVERITY_UNSPECIFIED	0	The log entry has no assigned severity level.
SEVERITY_DEBUG	100	Debug or trace information.
SEVERITY_INFO	200	Routine information, such as ongoing status or performance.
SEVERITY_NOTICE	300	Normal but significant events, such as start up, shut down, or a configuration change.
SEVERITY_WARNING	400	Warning events might cause problems.
SEVERITY_ERROR	500	Error events are likely to cause problems.
SEVERITY_CRITICAL	600	Critical events cause more severe problems or outages.
SEVERITY_ALERT	700	A person must take an action immediately.
SEVERITY_EMERGENCY	800	One or more systems are unusable.

Scalar Value Types¶

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	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	int32	int	integer	Bignum or Fixnum (as required)
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	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)