apidocs_apricot.md

Protocol Documentation

Table of Contents

• apricot.proto

  • AliasedLinkIDsRequest

  • AliasedLinkIDsResponse

  • CRUCardEndpointResponse

  • CRUCardsResponse

  • CardRequest

  • ComponentEntriesQuery

  • ComponentEntriesResponse

  • ComponentQuery

  • ComponentRequest

  • ComponentRequest.VarStackEntry

  • ComponentResponse

  • ComponentResponseWithLastIndex

  • DetectorEntriesResponse

  • DetectorEntriesResponse.DetectorEntriesEntry

  • DetectorInventoryResponse

  • DetectorResponse

  • DetectorsRequest

  • DetectorsResponse

  • Empty

  • GetEntryRequest

  • GetRuntimeEntriesRequest

  • GetRuntimeEntryRequest

  • HostEntriesResponse

  • HostGetRequest

  • HostRequest

  • HostsRequest

  • ImportComponentConfigurationRequest

  • ImportComponentConfigurationResponse

  • LinkIDsRequest

  • LinkIDsResponse

  • ListComponentEntriesRequest

  • ListRuntimeEntriesRequest

  • RawGetRecursiveRequest

  • RunNumberResponse

  • SetRuntimeEntryRequest

  • StringMap

  • StringMap.StringMapEntry

  • RunType

  • Apricot

• Scalar Value Types

Top

apricot.proto

AliasedLinkIDsRequest

Field	Type	Label	Description
detector	string
onlyEnabled	bool

AliasedLinkIDsResponse

Field	Type	Label	Description
aliasedLinkIDs	string	repeated

CRUCardEndpointResponse

Field	Type	Label	Description
endpoints	string

CRUCardsResponse

Field	Type	Label	Description
cards	string

CardRequest

Field	Type	Label	Description
hostname	string
cardSerial	string

ComponentEntriesQuery

Field	Type	Label	Description
component	string
runType	RunType
machineRole	string

ComponentEntriesResponse

Field	Type	Label	Description
payload	string	repeated

ComponentQuery

Field	Type	Label	Description
component	string
runType	RunType
machineRole	string
entry	string

ComponentRequest

Field	Type	Label	Description
path	string
query	ComponentQuery
processTemplate	bool
varStack	ComponentRequest.VarStackEntry	repeated

ComponentRequest.VarStackEntry

Field	Type	Label	Description
key	string
value	string

ComponentResponse

Field	Type	Label	Description
payload	string

ComponentResponseWithLastIndex

Field	Type	Label	Description
payload	string
lastIndex	uint64

DetectorEntriesResponse

Field	Type	Label	Description
detectorEntries	DetectorEntriesResponse.DetectorEntriesEntry	repeated

DetectorEntriesResponse.DetectorEntriesEntry

Field	Type	Label	Description
key	string
value	DetectorInventoryResponse

DetectorInventoryResponse

Field	Type	Label	Description
flps	string	repeated

DetectorResponse

Field	Type	Label	Description
payload	string

DetectorsRequest

Field	Type	Label	Description
getAll	bool		if false(default) restricts "private" detectors (e.g. TRG)

DetectorsResponse

Field	Type	Label	Description
detectors	string	repeated

Empty

GetEntryRequest

Field	Type	Label	Description
key	string

GetRuntimeEntriesRequest

Field	Type	Label	Description
component	string

GetRuntimeEntryRequest

Field	Type	Label	Description
component	string
key	string

HostEntriesResponse

Field	Type	Label	Description
hosts	string	repeated

HostGetRequest

Field	Type	Label	Description
detector	string

HostRequest

Field	Type	Label	Description
hostname	string

HostsRequest

Field	Type	Label	Description
hosts	string	repeated

ImportComponentConfigurationRequest

Field	Type	Label	Description
query	ComponentQuery
payload	string
newComponent	bool

ImportComponentConfigurationResponse

Field	Type	Label	Description
existingComponentUpdated	bool
existingEntryUpdated	bool

LinkIDsRequest

Field	Type	Label	Description
hostname	string
cardSerial	string
endpoint	string
onlyEnabled	bool

LinkIDsResponse

Field	Type	Label	Description
linkIDs	string	repeated

ListComponentEntriesRequest

Field	Type	Label	Description
path	string
query	ComponentEntriesQuery

ListRuntimeEntriesRequest

Field	Type	Label	Description
component	string

RawGetRecursiveRequest

Field	Type	Label	Description
rawPath	string

RunNumberResponse

Field	Type	Label	Description
runNumber	uint32

SetRuntimeEntryRequest

Field	Type	Label	Description
component	string
key	string
value	string

StringMap

Field	Type	Label	Description
stringMap	StringMap.StringMapEntry	repeated

StringMap.StringMapEntry

Field	Type	Label	Description
key	string
value	string

RunType

Name	Number	Description
NULL	0
PHYSICS	1
TECHNICAL	2
PEDESTAL	3
PULSER	4
LASER	5
CALIBRATION_ITHR_TUNING	6
CALIBRATION_VCASN_TUNING	7
CALIBRATION_THR_SCAN	8
CALIBRATION_DIGITAL_SCAN	9
CALIBRATION_ANALOG_SCAN	10
CALIBRATION_FHR	11
CALIBRATION_ALPIDE_SCAN	12
CALIBRATION	13
COSMICS	14
SYNTHETIC	15
NOISE	16
CALIBRATION_PULSE_LENGTH	17
CALIBRATION_VRESETD	18
ANY	300

Apricot

Method Name	Request Type	Response Type	Description
NewRunNumber	Empty	RunNumberResponse
GetDefaults	Empty	StringMap
GetVars	Empty	StringMap
RawGetRecursive	RawGetRecursiveRequest	ComponentResponse
ListDetectors	DetectorsRequest	DetectorsResponse	Detectors and host inventories
GetHostInventory	HostGetRequest	HostEntriesResponse
GetDetectorsInventory	Empty	DetectorEntriesResponse
GetDetectorForHost	HostRequest	DetectorResponse
GetDetectorsForHosts	HostsRequest	DetectorsResponse
GetCRUCardsForHost	HostRequest	CRUCardsResponse
GetEndpointsForCRUCard	CardRequest	CRUCardEndpointResponse
GetLinkIDsForCRUEndpoint	LinkIDsRequest	LinkIDsResponse
GetAliasedLinkIDsForDetector	AliasedLinkIDsRequest	AliasedLinkIDsResponse
GetRuntimeEntry	GetRuntimeEntryRequest	ComponentResponse	Runtime KV calls
SetRuntimeEntry	SetRuntimeEntryRequest	Empty
GetRuntimeEntries	GetRuntimeEntriesRequest	StringMap
ListRuntimeEntries	ListRuntimeEntriesRequest	ComponentEntriesResponse
ListComponents	Empty	ComponentEntriesResponse	Component configuration calls
ListComponentEntries	ListComponentEntriesRequest	ComponentEntriesResponse
GetComponentConfiguration	ComponentRequest	ComponentResponse
GetComponentConfigurationWithLastIndex	ComponentRequest	ComponentResponseWithLastIndex
ResolveComponentQuery	ComponentQuery	ComponentQuery
ImportComponentConfiguration	ImportComponentConfigurationRequest	ImportComponentConfigurationResponse
InvalidateComponentTemplateCache	Empty	Empty

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)