forked from TheThingsNetwork/lorawan-stack
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathevents.proto
More file actions
70 lines (63 loc) · 2.9 KB
/
events.proto
File metadata and controls
70 lines (63 loc) · 2.9 KB
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
// Copyright © 2019 The Things Network Foundation, The Things Industries B.V.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
syntax = "proto3";
import "github.com/envoyproxy/protoc-gen-validate/validate/validate.proto";
import "github.com/gogo/protobuf/gogoproto/gogo.proto";
import "google/api/annotations.proto";
import "google/protobuf/any.proto";
import "google/protobuf/timestamp.proto";
import "lorawan-stack/api/identifiers.proto";
import "lorawan-stack/api/rights.proto";
package ttn.lorawan.v3;
option go_package = "go.thethings.network/lorawan-stack/v3/pkg/ttnpb";
message Event {
string name = 1;
google.protobuf.Timestamp time = 2 [(gogoproto.nullable) = false, (gogoproto.stdtime) = true, (validate.rules).timestamp.required = true];
repeated EntityIdentifiers identifiers = 3;
google.protobuf.Any data = 4;
repeated string correlation_ids = 5 [(gogoproto.customname) = "CorrelationIDs", (validate.rules).repeated.items.string.max_len = 100];
string origin = 6;
map<string,bytes> context = 7;
// The event will be visible to a caller that has any of these rights.
Rights visibility = 8;
message Authentication {
string type = 1;
string token_type = 2;
string token_id = 3 [(gogoproto.customname) = "TokenID"];
string remote_ip = 4 [(gogoproto.customname) = "RemoteIP"];
}
Authentication authentication = 9;
}
message StreamEventsRequest {
repeated EntityIdentifiers identifiers = 1;
// If greater than zero, this will return historical events, up to this maximum when the stream starts.
// If used in combination with "after", the limit that is reached first, is used.
// The availability of historical events depends on server support and retention policy.
uint32 tail = 2;
// If not empty, this will return historical events after the given time when the stream starts.
// If used in combination with "tail", the limit that is reached first, is used.
// The availability of historical events depends on server support and retention policy.
google.protobuf.Timestamp after = 3 [(gogoproto.stdtime) = true];
}
// The Events service serves events from the cluster.
service Events {
// Stream live events, optionally with a tail of historical events (depending on server support and retention policy).
// Events may arrive out-of-order.
rpc Stream(StreamEventsRequest) returns (stream Event) {
option (google.api.http) = {
post: "/events"
body: "*"
};
};
}