Control/core/integration/bookkeeping/protos/run.proto at e0d2c041ce726ea78d96971de4ab917c29c2d7c3 · AliceO2Group/Control · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
syntax = 'proto3';

package o2.bookkeeping;
option go_package = "github.com/AliceO2Group/Control/core/integration/bookkeeping/protos;bkpb";

import "protos/bkcommon.proto";

// Services

service RunService {
  rpc Get(RunFetchRequest) returns (RunWithRelations);
  rpc Create(RunCreationRequest) returns (Run);
  rpc Update(RunUpdateRequest) returns (Run);
}

// High level messages

message RunFetchRequest {
  int32 runNumber = 1;
  // Specify the list of relations to fetch alongside the run
  // For example if this contains RUN_RELATIONS_LHC_FILL then the returned RunWithRelation will have a populated
  // lhcFill, else it will not be defined
  repeated RunRelations relations = 2;
}

message RunWithRelations {
  Run run = 1;
  optional LHCFill lhcFill = 2;
}

message RunCreationRequest {
  string environmentId = 1;
  int32 nDetectors = 2;
  int32 nEpns = 3;
  int32 nFlps = 4;
  int32 runNumber = 5;
  RunType runType = 6;
  bool dd_flp = 7;
  bool dcs = 8;
  bool epn = 9;
  string epnTopology = 10;
  optional string odcTopologyFullName = 11;
  repeated Detector detectors = 12;
  // Optional users that stopped or started the run (can also be undefined)
  optional User userO2Start = 13;
  optional User userO2Stop = 14;
}

message RunUpdateRequest {
  int32 runNumber = 1;
  optional int64 timeO2Start = 3;
  optional int64 timeO2End = 4;
  optional int64 timeTrgStart = 5;
  optional int64 timeTrgEnd = 6;
  optional string triggerValue = 7;
  optional string rawCtpTriggerConfiguration = 19;
  optional string pdpConfigOption = 8;
  optional string pdpTopologyDescriptionLibraryFile = 9;
  optional string tfbDdMode = 10;
  optional string lhcPeriod = 11;
  optional string odcTopologyFullName = 12;
  optional string pdpWorkflowParameters = 13;
  optional string pdpBeamType = 14;
  optional string readoutCfgUri = 15;
  repeated EorReason eorReasons = 16;
  // Optional users that stopped or started the run (can also be undefined)
  optional User userO2Start = 17;
  optional User userO2Stop = 18;
  // 19 is trigger raw configuration
}

// Enums

enum RunRelations {
  // IGNORED - Here to comply with proto specification
  RUN_RELATIONS_NULL = 0;
  // Include the LHC fill related to the run
  RUN_RELATIONS_LHC_FILL = 1;
}