Protocol Documentation

Table of Contents

firewheel_grpc.proto

CountVMMappingsNotReadyRequest

Field	Type	Label	Description
db	string		The database to use. (e.g. "prod" or "test")

CountVMMappingsNotReadyResponse

Field	Type	Label	Description
db	string		The database to use. (e.g. "prod" or "test")
count	uint32		The count of not ready VMs

DestroyAllVMMappingsRequest

Field	Type	Label	Description
db	string		The database to use. (e.g. "prod" or "test")

DestroyAllVMMappingsResponse

DestroyVMMappingResponse

ExperimentLaunchTime

Field	Type	Label	Description
db	string		The database to use. (e.g. "prod" or "test")
launch_time	google.protobuf.Timestamp		The experiment launch time.

ExperimentStartTime

Field	Type	Label	Description
db	string		The database to use. (e.g. "prod" or "test")
start_time	google.protobuf.Timestamp		The experiment start time.

GetExperimentLaunchTimeRequest

Field	Type	Label	Description
db	string		The database to use. (e.g. "prod" or "test")

GetExperimentStartTimeRequest

Field	Type	Label	Description
db	string		The database to use. (e.g. "prod" or "test")

GetInfoRequest

GetInfoResponse

Field	Type	Label	Description
version	string		The grpc server version.
uptime	float		The grpc server uptime.
experiment_running	bool		Whether an experiment is running.

InitializeExperimentStartTimeRequest

Field	Type	Label	Description
db	string		The database to use. (e.g. "prod" or "test")

InitializeExperimentStartTimeResponse

ListVMMappingsRequest

Field	Type	Label	Description
db	string		The database to use. (e.g. "prod" or "test")
json_match_dict	string		A json dictionary containing search criteria to match against.

SetVMStateByUUIDRequest

Field	Type	Label	Description
db	string		The database to use. (e.g. "prod" or "test")
server_uuid	string		The uuid of the VM
state	string		The state to update the VM with

SetVMTimeByUUIDRequest

Field	Type	Label	Description
db	string		The database to use. (e.g. "prod" or "test")
server_uuid	string		The uuid of the VM
current_time	string		The time to update the VM with

VMMapping

Field	Type	Label	Description
db	string		The database to use. (e.g. "prod" or "test")
server_uuid	string		The uuid of the VM
server_name	string		The name of the VM
control_ip	string		The IP of the VM on the control network.
state	string		The state of the VM.
current_time	string		The current time in the VM.

VMMappingUUID

Field	Type	Label	Description
db	string		The database to use. (e.g. "prod" or "test")
server_uuid	string		The uuid of the VM

Firewheel

Method Name	Request Type	Response Type	Description
GetInfo	GetInfoRequest	GetInfoResponse	Gets the gRPC server info.
GetVMMappingByUUID	VMMappingUUID	VMMapping	Gets the vm_mapping associated with the given uuid.
DestroyVMMappingByUUID	VMMappingUUID	DestroyVMMappingResponse	Destroys the vm_mapping associated with the given uuid.
SetVMTimeByUUID	SetVMTimeByUUIDRequest	VMMapping	Sets the time for the vm_mapping associated with the given uuid.
SetVMStateByUUID	SetVMStateByUUIDRequest	VMMapping	Sets the state for the vm_mapping associated with the given uuid.
SetVMMapping	VMMapping	VMMapping	Sets the given vm_mapping.
ListVMMappings	ListVMMappingsRequest	VMMappingstream	Iterates through all requested vm_mappings.
CountVMMappingsNotReady	CountVMMappingsNotReadyRequest	CountVMMappingsNotReadyResponse	Returns the count of VMs that are not ready.
DestroyAllVMMappings	DestroyAllVMMappingsRequest	DestroyAllVMMappingsResponse	Destroys all vm_mappings.
GetExperimentStartTime	GetExperimentStartTimeRequest	ExperimentStartTime	Gets the experiment start time.
SetExperimentStartTime	ExperimentStartTime	ExperimentStartTime	Sets the experiment start time.
GetExperimentLaunchTime	GetExperimentLaunchTimeRequest	ExperimentLaunchTime	Gets the experiment launch time.
SetExperimentLaunchTime	ExperimentLaunchTime	ExperimentLaunchTime	Sets the experiment start time.
InitializeExperimentStartTime	InitializeExperimentStartTimeRequest	InitializeExperimentStartTimeResponse	Initializes the experiment launch time.

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)