Protocol Documentation

Table of Contents

• cluster.proto
  • ClusterCreated
  • ClusterDestroyed
  • ClusterRead
  • ClusterTokenRead
  • ClusterUpdated
  • ClustersRead
  • CreateCluster
  • DestroyCluster
  • ReadCluster
  • ReadClusterToken
  • ReadClusters

  • UpdateCluster

  • Cluster
• Scalar Value Types

Top

cluster.proto

Cluster is the service managing external clusters.

ClusterCreated

Field	Type	Label	Description
uuid	string		the uuid of the cluster, used when setting up the agent

ClusterDestroyed

ClusterRead

Field	Type	Label	Description
uuid	string		unique id of the cluster
name	string		name of the cluster
ready	bool		server ready status, based on agent status

ClusterTokenRead

Field	Type	Label	Description
token	string		the token for this cluster

ClusterUpdated

ClustersRead

Field	Type	Label	Description
clusters	ClusterRead	repeated	clusters read

CreateCluster

Field	Type	Label	Description
name	string		name of the cluster

DestroyCluster

Field	Type	Label	Description
uuid	string		unique id of the cluster

ReadCluster

Field	Type	Label	Description
uuid	string		unique id of the cluster

ReadClusterToken

Field	Type	Label	Description
uuid	string		unique id of the cluster

ReadClusters

UpdateCluster

Field	Type	Label	Description
uuid	string		unique id of the cluster
name	string		name of the cluster

Cluster

Method Name	Request Type	Response Type	Description
Create	CreateCluster	ClusterCreated	adds a cluster to the list of configurations
Update	UpdateCluster	ClusterUpdated	edits an already existing cluster
Destroy	DestroyCluster	ClusterDestroyed	removes a cluster from the list of configurations
Read	ReadCluster	ClusterRead	reads out a cluster
All	ReadClusters	ClustersRead	gets all clusters currently configured and their status
Token	ReadClusterToken	ClusterTokenRead	gets the cluster's access token

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)