types/info.proto

Table of Contents

• types/info.proto

  • ResourceSupport

  • PullSupport

• Scalar Value Types

Top

types/info.proto

ResourceSupport

ResourceSupport describes how a trait resource supports read/write/subscribe apis.

For sensor traits any write oriented properties should be and will be ignored.

Field	Type	Label	Description
readable	bool		Whether the device supports querying, i.e. get apis
writable	bool		Whether the device supports writable actions, i.e. update or action apis
observable	bool		Whether the device supports subscriptions, i.e. pull apis
writable_fields	google.protobuf.FieldMask		Which fields can be written to. Relative to the resource type, not the message (FooRequest) type. If this field is absent, the list of updatable fields is unknown, assume all. Check the response to your Update request for the values that were updated. An attempt to explicitly (via update_mask) write to a non-writable field will error.
pull_support	PullSupport		How Pull is implemented by the server
pull_poll	google.protobuf.Duration		If Pull is emulated, how often updates can be expected. This is not strict, updates may be less or more frequent.

PullSupport

PullSupport describes how Pull methods are implemented by the server

Name	Number	Description
PULL_SUPPORT_UNSPECIFIED	0	How subscriptions are implemented is not known.
PULL_SUPPORT_NATIVE	1	Subscribing is supported natively by the underlying system.
PULL_SUPPORT_EMULATED	2	Subscribing is supported in the driver, rather than natively. Usually the driver will poll the system for data.

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)