-
Notifications
You must be signed in to change notification settings - Fork 2.2k
/
serving_config_service.proto
240 lines (212 loc) · 9.03 KB
/
serving_config_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
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
// Copyright 2021 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.retail.v2;
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/cloud/retail/v2/serving_config.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.Retail.V2";
option go_package = "cloud.google.com/go/retail/apiv2/retailpb;retailpb";
option java_multiple_files = true;
option java_outer_classname = "ServingConfigServiceProto";
option java_package = "com.google.cloud.retail.v2";
option objc_class_prefix = "RETAIL";
option php_namespace = "Google\\Cloud\\Retail\\V2";
option ruby_package = "Google::Cloud::Retail::V2";
// Service for modifying ServingConfig.
service ServingConfigService {
option (google.api.default_host) = "retail.googleapis.com";
option (google.api.oauth_scopes) =
"https://www.googleapis.com/auth/cloud-platform";
// Creates a ServingConfig.
//
// A maximum of 100 [ServingConfig][google.cloud.retail.v2.ServingConfig]s are
// allowed in a [Catalog][google.cloud.retail.v2.Catalog], otherwise a
// FAILED_PRECONDITION error is returned.
rpc CreateServingConfig(CreateServingConfigRequest) returns (ServingConfig) {
option (google.api.http) = {
post: "/v2/{parent=projects/*/locations/*/catalogs/*}/servingConfigs"
body: "serving_config"
};
option (google.api.method_signature) =
"parent,serving_config,serving_config_id";
}
// Deletes a ServingConfig.
//
// Returns a NotFound error if the ServingConfig does not exist.
rpc DeleteServingConfig(DeleteServingConfigRequest)
returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v2/{name=projects/*/locations/*/catalogs/*/servingConfigs/*}"
};
option (google.api.method_signature) = "name";
}
// Updates a ServingConfig.
rpc UpdateServingConfig(UpdateServingConfigRequest) returns (ServingConfig) {
option (google.api.http) = {
patch: "/v2/{serving_config.name=projects/*/locations/*/catalogs/*/servingConfigs/*}"
body: "serving_config"
};
option (google.api.method_signature) = "serving_config,update_mask";
}
// Gets a ServingConfig.
//
// Returns a NotFound error if the ServingConfig does not exist.
rpc GetServingConfig(GetServingConfigRequest) returns (ServingConfig) {
option (google.api.http) = {
get: "/v2/{name=projects/*/locations/*/catalogs/*/servingConfigs/*}"
};
option (google.api.method_signature) = "name";
}
// Lists all ServingConfigs linked to this catalog.
rpc ListServingConfigs(ListServingConfigsRequest)
returns (ListServingConfigsResponse) {
option (google.api.http) = {
get: "/v2/{parent=projects/*/locations/*/catalogs/*}/servingConfigs"
};
option (google.api.method_signature) = "parent";
}
// Enables a Control on the specified ServingConfig.
// The control is added in the last position of the list of controls
// it belongs to (e.g. if it's a facet spec control it will be applied
// in the last position of servingConfig.facetSpecIds)
// Returns a ALREADY_EXISTS error if the control has already been applied.
// Returns a FAILED_PRECONDITION error if the addition could exceed maximum
// number of control allowed for that type of control.
rpc AddControl(AddControlRequest) returns (ServingConfig) {
option (google.api.http) = {
post: "/v2/{serving_config=projects/*/locations/*/catalogs/*/servingConfigs/*}:addControl"
body: "*"
};
option (google.api.method_signature) = "serving_config";
}
// Disables a Control on the specified ServingConfig.
// The control is removed from the ServingConfig.
// Returns a NOT_FOUND error if the Control is not enabled for the
// ServingConfig.
rpc RemoveControl(RemoveControlRequest) returns (ServingConfig) {
option (google.api.http) = {
post: "/v2/{serving_config=projects/*/locations/*/catalogs/*/servingConfigs/*}:removeControl"
body: "*"
};
option (google.api.method_signature) = "serving_config";
}
}
// Request for CreateServingConfig method.
message CreateServingConfigRequest {
// Required. Full resource name of parent. Format:
// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = { type: "retail.googleapis.com/Catalog" }
];
// Required. The ServingConfig to create.
ServingConfig serving_config = 2 [(google.api.field_behavior) = REQUIRED];
// Required. The ID to use for the ServingConfig, which will become the final
// component of the ServingConfig's resource name.
//
// This value should be 4-63 characters, and valid characters
// are /[a-z][0-9]-_/.
string serving_config_id = 3 [(google.api.field_behavior) = REQUIRED];
}
// Request for UpdateServingConfig method.
message UpdateServingConfigRequest {
// Required. The ServingConfig to update.
ServingConfig serving_config = 1 [(google.api.field_behavior) = REQUIRED];
// Indicates which fields in the provided
// [ServingConfig][google.cloud.retail.v2.ServingConfig] to update. The
// following are NOT supported:
//
// * [ServingConfig.name][google.cloud.retail.v2.ServingConfig.name]
//
// If not set, all supported fields are updated.
google.protobuf.FieldMask update_mask = 2;
}
// Request for DeleteServingConfig method.
message DeleteServingConfigRequest {
// Required. The resource name of the ServingConfig to delete. Format:
// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "retail.googleapis.com/ServingConfig"
}
];
}
// Request for GetServingConfig method.
message GetServingConfigRequest {
// Required. The resource name of the ServingConfig to get. Format:
// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "retail.googleapis.com/ServingConfig"
}
];
}
// Request for ListServingConfigs method.
message ListServingConfigsRequest {
// Required. The catalog resource name. Format:
// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = { type: "retail.googleapis.com/Catalog" }
];
// Optional. Maximum number of results to return. If unspecified, defaults
// to 100. If a value greater than 100 is provided, at most 100 results are
// returned.
int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
// Optional. A page token, received from a previous `ListServingConfigs` call.
// Provide this to retrieve the subsequent page.
string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
}
// Response for ListServingConfigs method.
message ListServingConfigsResponse {
// All the ServingConfigs for a given catalog.
repeated ServingConfig serving_configs = 1;
// Pagination token, if not returned indicates the last page.
string next_page_token = 2;
}
// Request for AddControl method.
message AddControlRequest {
// Required. The source ServingConfig resource name . Format:
// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`
string serving_config = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "retail.googleapis.com/ServingConfig"
}
];
// Required. The id of the control to apply. Assumed to be in the same catalog
// as the serving config - if id is not found a NOT_FOUND error is returned.
string control_id = 2 [(google.api.field_behavior) = REQUIRED];
}
// Request for RemoveControl method.
message RemoveControlRequest {
// Required. The source ServingConfig resource name . Format:
// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`
string serving_config = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "retail.googleapis.com/ServingConfig"
}
];
// Required. The id of the control to apply. Assumed to be in the same catalog
// as the serving config.
string control_id = 2 [(google.api.field_behavior) = REQUIRED];
}