-
Notifications
You must be signed in to change notification settings - Fork 2
/
event_groups_service.proto
104 lines (87 loc) · 3.79 KB
/
event_groups_service.proto
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
// Copyright 2020 The Cross-Media Measurement Authors
//
// 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";
package wfa.measurement.api.v2alpha;
import "google/api/resource.proto";
import "wfa/measurement/api/v2alpha/event_group.proto";
option java_package = "org.wfanet.measurement.api.v2alpha";
option java_multiple_files = true;
option java_outer_classname = "EventGroupsServiceProto";
// Service for interacting with `EventGroup` resources.
service EventGroups {
// Returns the `EventGroup` with the specified resource key.
rpc GetEventGroup(GetEventGroupRequest) returns (EventGroup) {}
// Creates (registers) a `EventGroup` defined in the specified
// `DataProvider`'s system.
rpc CreateEventGroup(CreateEventGroupRequest) returns (EventGroup) {}
// Updates an existing `EventGroup`. Results in a `PERMISSION_DENIED` error if
// the authenticated user does not have access to the `EventGroup`. Results in
// a `NOT_FOUND` error if the the specified `EventGroup` does not exist.
rpc UpdateEventGroup(UpdateEventGroupRequest) returns (EventGroup) {}
// Lists `EventGroup`s. Results in a `PERMISSION_DENIED` error if attempting
// to list `EventGroup`s that the authenticated user does not have access to.
rpc ListEventGroups(ListEventGroupsRequest)
returns (ListEventGroupsResponse) {}
}
// Request message for `GetEventGroup` method.
message GetEventGroupRequest {
// Resource name.
string name = 1
[(google.api.resource_reference).type = "halo.wfanet.org/EventGroup"];
}
// Request message for `CreateEventGroup` method.
message CreateEventGroupRequest {
// Resource name of the parent `DataProvider`. Required.
string parent = 1
[(google.api.resource_reference).type = "halo.wfanet.org/DataProvider"];
// The `EventGroup` to create. Required.
//
// The `key` field will be ignored, and the system will assign an ID. Results
// in an `ALREADY_EXISTS` error if there is already a child `EventGroup` with
// the same `event_group_reference_id`.
EventGroup event_group = 2;
}
// Request message for `UpdateEventGroup` method.
message UpdateEventGroupRequest {
// The `EventGroup` to update. Required.
EventGroup event_group = 1;
}
message ListEventGroupsRequest {
// Resource key of the parent `DataProvider`. The wildcard ID (`-`) may be
// used in place of the `DataProvider` ID to list across `DataProvider`s, in
// which case a filter should be specified.
string parent = 1
[(google.api.resource_reference).type = "halo.wfanet.org/DataProvider"];
// The maximum number of resources to return. See https://aip.dev/158.
int32 page_size = 2;
// A token from a previous call, specified to retrieve the next page. See
// https://aip.dev/158.
string page_token = 3;
// Filter criteria. Repeated fields are treated as logical ORs, and multiple
// fields specified as logical ANDs.
message Filter {
repeated string measurement_consumers = 1
[(google.api.resource_reference).type =
"halo.wfanet.org/MeasurementConsumer"];
}
// Result filter.
Filter filter = 4;
}
message ListEventGroupsResponse {
// The `EventGroup` resources.
repeated EventGroup event_groups = 1;
// A token that can be specified in a subsequent call to retrieve the next
// page. See https://aip.dev/158.
string next_page_token = 2;
}