info/health.proto

Table of Contents

• info/health.proto

  • CommHealth

  • ConnectionHealth

  • GetHealthStateRequest

  • HealthState

  • HealthStateChange

  • PullHealthStatesRequest

  • PullHealthStatesResponse

  • Health

• Scalar Value Types

Top

info/health.proto

CommHealth

Describes the health of communication.

Field	Type	Label	Description
status	smartcore.types.CommStatus
failure_time	google.protobuf.Timestamp		The most recent time the status changed to COMM_FAILURE
success_time	google.protobuf.Timestamp		The most recent time the status changed to COMM_SUCCESS

ConnectionHealth

Describes the health of a connection

Field	Type	Label	Description
status	smartcore.types.Connectivity		are we currently connected
connect_time	google.protobuf.Timestamp		When was the last time a successful connection was established
disconnect_time	google.protobuf.Timestamp		When was the last time a connection was closed/ended

GetHealthStateRequest

Field	Type	Label	Description
name	string		Name of the device to query the health state for

HealthState

Field	Type	Label	Description
connection	ConnectionHealth		Health of the connection to the physical device
comm	CommHealth		Health of communication with the device

HealthStateChange

Field	Type	Label	Description
name	string		The name of the device that is the source of the change
change_time	google.protobuf.Timestamp		When the change was applied
health	HealthState		The new state for the change

PullHealthStatesRequest

Field	Type	Label	Description
name	string		Name of the device to subscribe to the health state for

PullHealthStatesResponse

Field	Type	Label	Description
changes	HealthStateChange	repeated

Health

Describe the health of a device.

Method Name	Request Type	Response Type	Description
GetHealthState	GetHealthStateRequest	HealthState
PullHealthStates	PullHealthStatesRequest	PullHealthStatesResponse stream

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)