-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
specialist_pool_service.proto
225 lines (199 loc) · 8.58 KB
/
specialist_pool_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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
// Copyright 2023 Google LLC
//
// 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 google.cloud.aiplatform.v1;
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/cloud/aiplatform/v1/operation.proto";
import "google/cloud/aiplatform/v1/specialist_pool.proto";
import "google/longrunning/operations.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "SpecialistPoolServiceProto";
option java_package = "com.google.cloud.aiplatform.v1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1";
option ruby_package = "Google::Cloud::AIPlatform::V1";
// A service for creating and managing Customer SpecialistPools.
// When customers start Data Labeling jobs, they can reuse/create Specialist
// Pools to bring their own Specialists to label the data.
// Customers can add/remove Managers for the Specialist Pool on Cloud console,
// then Managers will get email notifications to manage Specialists and tasks on
// CrowdCompute console.
service SpecialistPoolService {
option (google.api.default_host) = "aiplatform.googleapis.com";
option (google.api.oauth_scopes) =
"https://www.googleapis.com/auth/cloud-platform";
// Creates a SpecialistPool.
rpc CreateSpecialistPool(CreateSpecialistPoolRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/specialistPools"
body: "specialist_pool"
};
option (google.api.method_signature) = "parent,specialist_pool";
option (google.longrunning.operation_info) = {
response_type: "SpecialistPool"
metadata_type: "CreateSpecialistPoolOperationMetadata"
};
}
// Gets a SpecialistPool.
rpc GetSpecialistPool(GetSpecialistPoolRequest) returns (SpecialistPool) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/specialistPools/*}"
};
option (google.api.method_signature) = "name";
}
// Lists SpecialistPools in a Location.
rpc ListSpecialistPools(ListSpecialistPoolsRequest)
returns (ListSpecialistPoolsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/specialistPools"
};
option (google.api.method_signature) = "parent";
}
// Deletes a SpecialistPool as well as all Specialists in the pool.
rpc DeleteSpecialistPool(DeleteSpecialistPoolRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/specialistPools/*}"
};
option (google.api.method_signature) = "name";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
metadata_type: "DeleteOperationMetadata"
};
}
// Updates a SpecialistPool.
rpc UpdateSpecialistPool(UpdateSpecialistPoolRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
patch: "/v1/{specialist_pool.name=projects/*/locations/*/specialistPools/*}"
body: "specialist_pool"
};
option (google.api.method_signature) = "specialist_pool,update_mask";
option (google.longrunning.operation_info) = {
response_type: "SpecialistPool"
metadata_type: "UpdateSpecialistPoolOperationMetadata"
};
}
}
// Request message for
// [SpecialistPoolService.CreateSpecialistPool][google.cloud.aiplatform.v1.SpecialistPoolService.CreateSpecialistPool].
message CreateSpecialistPoolRequest {
// Required. The parent Project name for the new SpecialistPool.
// The form is `projects/{project}/locations/{location}`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "locations.googleapis.com/Location"
}
];
// Required. The SpecialistPool to create.
SpecialistPool specialist_pool = 2 [(google.api.field_behavior) = REQUIRED];
}
// Runtime operation information for
// [SpecialistPoolService.CreateSpecialistPool][google.cloud.aiplatform.v1.SpecialistPoolService.CreateSpecialistPool].
message CreateSpecialistPoolOperationMetadata {
// The operation generic information.
GenericOperationMetadata generic_metadata = 1;
}
// Request message for
// [SpecialistPoolService.GetSpecialistPool][google.cloud.aiplatform.v1.SpecialistPoolService.GetSpecialistPool].
message GetSpecialistPoolRequest {
// Required. The name of the SpecialistPool resource.
// The form is
// `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "aiplatform.googleapis.com/SpecialistPool"
}
];
}
// Request message for
// [SpecialistPoolService.ListSpecialistPools][google.cloud.aiplatform.v1.SpecialistPoolService.ListSpecialistPools].
message ListSpecialistPoolsRequest {
// Required. The name of the SpecialistPool's parent resource.
// Format: `projects/{project}/locations/{location}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "locations.googleapis.com/Location"
}
];
// The standard list page size.
int32 page_size = 2;
// The standard list page token.
// Typically obtained by
// [ListSpecialistPoolsResponse.next_page_token][google.cloud.aiplatform.v1.ListSpecialistPoolsResponse.next_page_token]
// of the previous
// [SpecialistPoolService.ListSpecialistPools][google.cloud.aiplatform.v1.SpecialistPoolService.ListSpecialistPools]
// call. Return first page if empty.
string page_token = 3;
// Mask specifying which fields to read. FieldMask represents a set of
google.protobuf.FieldMask read_mask = 4;
}
// Response message for
// [SpecialistPoolService.ListSpecialistPools][google.cloud.aiplatform.v1.SpecialistPoolService.ListSpecialistPools].
message ListSpecialistPoolsResponse {
// A list of SpecialistPools that matches the specified filter in the request.
repeated SpecialistPool specialist_pools = 1;
// The standard List next-page token.
string next_page_token = 2;
}
// Request message for
// [SpecialistPoolService.DeleteSpecialistPool][google.cloud.aiplatform.v1.SpecialistPoolService.DeleteSpecialistPool].
message DeleteSpecialistPoolRequest {
// Required. The resource name of the SpecialistPool to delete. Format:
// `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "aiplatform.googleapis.com/SpecialistPool"
}
];
// If set to true, any specialist managers in this SpecialistPool will also be
// deleted. (Otherwise, the request will only work if the SpecialistPool has
// no specialist managers.)
bool force = 2;
}
// Request message for
// [SpecialistPoolService.UpdateSpecialistPool][google.cloud.aiplatform.v1.SpecialistPoolService.UpdateSpecialistPool].
message UpdateSpecialistPoolRequest {
// Required. The SpecialistPool which replaces the resource on the server.
SpecialistPool specialist_pool = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The update mask applies to the resource.
google.protobuf.FieldMask update_mask = 2
[(google.api.field_behavior) = REQUIRED];
}
// Runtime operation metadata for
// [SpecialistPoolService.UpdateSpecialistPool][google.cloud.aiplatform.v1.SpecialistPoolService.UpdateSpecialistPool].
message UpdateSpecialistPoolOperationMetadata {
// Output only. The name of the SpecialistPool to which the specialists are
// being added. Format:
// `projects/{project_id}/locations/{location_id}/specialistPools/{specialist_pool}`
string specialist_pool = 1 [
(google.api.field_behavior) = OUTPUT_ONLY,
(google.api.resource_reference) = {
type: "aiplatform.googleapis.com/SpecialistPool"
}
];
// The operation generic information.
GenericOperationMetadata generic_metadata = 2;
}