Protocol Documentation

api/types/snapshot/types.proto

RetentionOptions specifies the retention policy for a change log

Field	Type	Label	Description
retain_window	google.protobuf.Duration		'retain_window' is the duration for which to retain network changes

Status is the status of a snapshot

Field	Type	Label	Description
phase	Phase		'phase' is the snapshot phase
state	State		'state' is the state of a snapshot

Phase is a snapshot phase

Name	Number	Description
MARK	0	MARK is the first phase in which changes are marked for deletion
DELETE	1	DELETE is the second phase in which changes are deleted from stores

State is the state of a snapshot within a phase

Name	Number	Description
PENDING	0	PENDING indicates the snapshot is pending
RUNNING	1	RUNNING indicates the snapshot is in progress
COMPLETE	2	COMPLETE indicates the snapshot is complete

.proto Type	Notes	C++ Type	Java Type	Python Type
double		double	double	float
float		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
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
uint32	Uses variable-length encoding.	uint32	int	int/long
uint64	Uses variable-length encoding.	uint64	long	int/long
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long
sfixed32	Always four bytes.	int32	int	int
sfixed64	Always eight bytes.	int64	long	int/long
bool		bool	boolean	boolean
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str