@google-cloud/discoveryengine 1.3.0 → 1.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +7 -0
- package/README.md +12 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +0 -5
- package/build/protos/google/cloud/discoveryengine/v1alpha/conversation.proto +3 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +39 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto +1 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/engine_service.proto +1 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +97 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/search_tuning_service.proto +147 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine.proto +164 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine_service.proto +540 -0
- package/build/protos/protos.d.ts +4473 -550
- package/build/protos/protos.js +27437 -19222
- package/build/protos/protos.json +1060 -358
- package/build/src/index.js +1 -1
- package/build/src/v1/completion_service_client.js +1 -1
- package/build/src/v1/conversational_search_service_client.js +1 -1
- package/build/src/v1/document_service_client.js +1 -1
- package/build/src/v1/index.js +1 -1
- package/build/src/v1/schema_service_client.js +1 -1
- package/build/src/v1/search_service_client.js +1 -1
- package/build/src/v1/user_event_service_client.js +1 -1
- package/build/src/v1alpha/completion_service_client.d.ts +219 -0
- package/build/src/v1alpha/completion_service_client.js +302 -0
- package/build/src/v1alpha/conversational_search_service_client.d.ts +236 -0
- package/build/src/v1alpha/conversational_search_service_client.js +302 -0
- package/build/src/v1alpha/data_store_service_client.d.ts +219 -0
- package/build/src/v1alpha/data_store_service_client.js +310 -2
- package/build/src/v1alpha/document_service_client.d.ts +219 -0
- package/build/src/v1alpha/document_service_client.js +310 -2
- package/build/src/v1alpha/engine_service_client.d.ts +220 -1
- package/build/src/v1alpha/engine_service_client.js +310 -2
- package/build/src/v1alpha/index.d.ts +1 -0
- package/build/src/v1alpha/index.js +3 -1
- package/build/src/v1alpha/recommendation_service_client.d.ts +219 -0
- package/build/src/v1alpha/recommendation_service_client.js +302 -0
- package/build/src/v1alpha/schema_service_client.d.ts +219 -0
- package/build/src/v1alpha/schema_service_client.js +310 -2
- package/build/src/v1alpha/search_service_client.d.ts +258 -0
- package/build/src/v1alpha/search_service_client.js +328 -0
- package/build/src/v1alpha/search_tuning_service_client.d.ts +968 -0
- package/build/src/v1alpha/search_tuning_service_client.js +1452 -0
- package/build/src/v1alpha/search_tuning_service_client_config.json +30 -0
- package/build/src/v1alpha/site_search_engine_service_client.d.ts +739 -1
- package/build/src/v1alpha/site_search_engine_service_client.js +801 -4
- package/build/src/v1alpha/site_search_engine_service_client_config.json +44 -0
- package/build/src/v1alpha/user_event_service_client.d.ts +219 -0
- package/build/src/v1alpha/user_event_service_client.js +310 -2
- package/build/src/v1beta/completion_service_client.js +1 -1
- package/build/src/v1beta/conversational_search_service_client.js +1 -1
- package/build/src/v1beta/document_service_client.js +1 -1
- package/build/src/v1beta/index.js +1 -1
- package/build/src/v1beta/recommendation_service_client.js +1 -1
- package/build/src/v1beta/schema_service_client.js +1 -1
- package/build/src/v1beta/search_service_client.js +1 -1
- package/build/src/v1beta/user_event_service_client.js +1 -1
- package/package.json +2 -2
@@ -20,7 +20,9 @@ import "google/api/annotations.proto";
|
|
20
20
|
import "google/api/client.proto";
|
21
21
|
import "google/api/field_behavior.proto";
|
22
22
|
import "google/api/resource.proto";
|
23
|
+
import "google/cloud/discoveryengine/v1alpha/site_search_engine.proto";
|
23
24
|
import "google/longrunning/operations.proto";
|
25
|
+
import "google/protobuf/empty.proto";
|
24
26
|
import "google/protobuf/timestamp.proto";
|
25
27
|
|
26
28
|
option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Alpha";
|
@@ -38,6 +40,147 @@ service SiteSearchEngineService {
|
|
38
40
|
option (google.api.oauth_scopes) =
|
39
41
|
"https://www.googleapis.com/auth/cloud-platform";
|
40
42
|
|
43
|
+
// Gets the
|
44
|
+
// [SiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngine].
|
45
|
+
rpc GetSiteSearchEngine(GetSiteSearchEngineRequest)
|
46
|
+
returns (SiteSearchEngine) {
|
47
|
+
option (google.api.http) = {
|
48
|
+
get: "/v1alpha/{name=projects/*/locations/*/dataStores/*/siteSearchEngine}"
|
49
|
+
additional_bindings {
|
50
|
+
get: "/v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}"
|
51
|
+
}
|
52
|
+
};
|
53
|
+
option (google.api.method_signature) = "name";
|
54
|
+
}
|
55
|
+
|
56
|
+
// Creates a [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite].
|
57
|
+
rpc CreateTargetSite(CreateTargetSiteRequest)
|
58
|
+
returns (google.longrunning.Operation) {
|
59
|
+
option (google.api.http) = {
|
60
|
+
post: "/v1alpha/{parent=projects/*/locations/*/dataStores/*/siteSearchEngine}/targetSites"
|
61
|
+
body: "target_site"
|
62
|
+
additional_bindings {
|
63
|
+
post: "/v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}/targetSites"
|
64
|
+
body: "target_site"
|
65
|
+
}
|
66
|
+
};
|
67
|
+
option (google.api.method_signature) = "parent,target_site";
|
68
|
+
option (google.longrunning.operation_info) = {
|
69
|
+
response_type: "google.cloud.discoveryengine.v1alpha.TargetSite"
|
70
|
+
metadata_type: "google.cloud.discoveryengine.v1alpha.CreateTargetSiteMetadata"
|
71
|
+
};
|
72
|
+
}
|
73
|
+
|
74
|
+
// Creates [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite] in a
|
75
|
+
// batch.
|
76
|
+
rpc BatchCreateTargetSites(BatchCreateTargetSitesRequest)
|
77
|
+
returns (google.longrunning.Operation) {
|
78
|
+
option (google.api.http) = {
|
79
|
+
post: "/v1alpha/{parent=projects/*/locations/*/dataStores/*/siteSearchEngine}/targetSites:batchCreate"
|
80
|
+
body: "*"
|
81
|
+
additional_bindings {
|
82
|
+
post: "/v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}/targetSites:batchCreate"
|
83
|
+
body: "*"
|
84
|
+
}
|
85
|
+
};
|
86
|
+
option (google.longrunning.operation_info) = {
|
87
|
+
response_type: "google.cloud.discoveryengine.v1alpha.BatchCreateTargetSitesResponse"
|
88
|
+
metadata_type: "google.cloud.discoveryengine.v1alpha.BatchCreateTargetSiteMetadata"
|
89
|
+
};
|
90
|
+
}
|
91
|
+
|
92
|
+
// Gets a [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite].
|
93
|
+
rpc GetTargetSite(GetTargetSiteRequest) returns (TargetSite) {
|
94
|
+
option (google.api.http) = {
|
95
|
+
get: "/v1alpha/{name=projects/*/locations/*/dataStores/*/siteSearchEngine/targetSites/*}"
|
96
|
+
additional_bindings {
|
97
|
+
get: "/v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/targetSites/*}"
|
98
|
+
}
|
99
|
+
};
|
100
|
+
option (google.api.method_signature) = "name";
|
101
|
+
}
|
102
|
+
|
103
|
+
// Updates a [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite].
|
104
|
+
rpc UpdateTargetSite(UpdateTargetSiteRequest)
|
105
|
+
returns (google.longrunning.Operation) {
|
106
|
+
option (google.api.http) = {
|
107
|
+
patch: "/v1alpha/{target_site.name=projects/*/locations/*/dataStores/*/siteSearchEngine/targetSites/*}"
|
108
|
+
body: "target_site"
|
109
|
+
additional_bindings {
|
110
|
+
patch: "/v1alpha/{target_site.name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/targetSites/*}"
|
111
|
+
body: "target_site"
|
112
|
+
}
|
113
|
+
};
|
114
|
+
option (google.api.method_signature) = "target_site";
|
115
|
+
option (google.longrunning.operation_info) = {
|
116
|
+
response_type: "google.cloud.discoveryengine.v1alpha.TargetSite"
|
117
|
+
metadata_type: "google.cloud.discoveryengine.v1alpha.UpdateTargetSiteMetadata"
|
118
|
+
};
|
119
|
+
}
|
120
|
+
|
121
|
+
// Deletes a [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite].
|
122
|
+
rpc DeleteTargetSite(DeleteTargetSiteRequest)
|
123
|
+
returns (google.longrunning.Operation) {
|
124
|
+
option (google.api.http) = {
|
125
|
+
delete: "/v1alpha/{name=projects/*/locations/*/dataStores/*/siteSearchEngine/targetSites/*}"
|
126
|
+
additional_bindings {
|
127
|
+
delete: "/v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/targetSites/*}"
|
128
|
+
}
|
129
|
+
};
|
130
|
+
option (google.api.method_signature) = "name";
|
131
|
+
option (google.longrunning.operation_info) = {
|
132
|
+
response_type: "google.protobuf.Empty"
|
133
|
+
metadata_type: "google.cloud.discoveryengine.v1alpha.DeleteTargetSiteMetadata"
|
134
|
+
};
|
135
|
+
}
|
136
|
+
|
137
|
+
// Gets a list of
|
138
|
+
// [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite]s.
|
139
|
+
rpc ListTargetSites(ListTargetSitesRequest)
|
140
|
+
returns (ListTargetSitesResponse) {
|
141
|
+
option (google.api.http) = {
|
142
|
+
get: "/v1alpha/{parent=projects/*/locations/*/dataStores/*/siteSearchEngine}/targetSites"
|
143
|
+
additional_bindings {
|
144
|
+
get: "/v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}/targetSites"
|
145
|
+
}
|
146
|
+
};
|
147
|
+
option (google.api.method_signature) = "parent";
|
148
|
+
}
|
149
|
+
|
150
|
+
// Upgrade from basic site search to advanced site search.
|
151
|
+
rpc EnableAdvancedSiteSearch(EnableAdvancedSiteSearchRequest)
|
152
|
+
returns (google.longrunning.Operation) {
|
153
|
+
option (google.api.http) = {
|
154
|
+
post: "/v1alpha/{site_search_engine=projects/*/locations/*/dataStores/*/siteSearchEngine}:enableAdvancedSiteSearch"
|
155
|
+
body: "*"
|
156
|
+
additional_bindings {
|
157
|
+
post: "/v1alpha/{site_search_engine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:enableAdvancedSiteSearch"
|
158
|
+
body: "*"
|
159
|
+
}
|
160
|
+
};
|
161
|
+
option (google.longrunning.operation_info) = {
|
162
|
+
response_type: "google.cloud.discoveryengine.v1alpha.EnableAdvancedSiteSearchResponse"
|
163
|
+
metadata_type: "google.cloud.discoveryengine.v1alpha.EnableAdvancedSiteSearchMetadata"
|
164
|
+
};
|
165
|
+
}
|
166
|
+
|
167
|
+
// Downgrade from advanced site search to basic site search.
|
168
|
+
rpc DisableAdvancedSiteSearch(DisableAdvancedSiteSearchRequest)
|
169
|
+
returns (google.longrunning.Operation) {
|
170
|
+
option (google.api.http) = {
|
171
|
+
post: "/v1alpha/{site_search_engine=projects/*/locations/*/dataStores/*/siteSearchEngine}:disableAdvancedSiteSearch"
|
172
|
+
body: "*"
|
173
|
+
additional_bindings {
|
174
|
+
post: "/v1alpha/{site_search_engine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:disableAdvancedSiteSearch"
|
175
|
+
body: "*"
|
176
|
+
}
|
177
|
+
};
|
178
|
+
option (google.longrunning.operation_info) = {
|
179
|
+
response_type: "google.cloud.discoveryengine.v1alpha.DisableAdvancedSiteSearchResponse"
|
180
|
+
metadata_type: "google.cloud.discoveryengine.v1alpha.DisableAdvancedSiteSearchMetadata"
|
181
|
+
};
|
182
|
+
}
|
183
|
+
|
41
184
|
// Request on-demand recrawl for a list of URIs.
|
42
185
|
rpc RecrawlUris(RecrawlUrisRequest) returns (google.longrunning.Operation) {
|
43
186
|
option (google.api.http) = {
|
@@ -53,6 +196,325 @@ service SiteSearchEngineService {
|
|
53
196
|
metadata_type: "google.cloud.discoveryengine.v1alpha.RecrawlUrisMetadata"
|
54
197
|
};
|
55
198
|
}
|
199
|
+
|
200
|
+
// Verify target sites' ownership and validity.
|
201
|
+
// This API sends all the target sites under site search engine for
|
202
|
+
// verification.
|
203
|
+
rpc BatchVerifyTargetSites(BatchVerifyTargetSitesRequest)
|
204
|
+
returns (google.longrunning.Operation) {
|
205
|
+
option (google.api.http) = {
|
206
|
+
post: "/v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:batchVerifyTargetSites"
|
207
|
+
body: "*"
|
208
|
+
};
|
209
|
+
option (google.longrunning.operation_info) = {
|
210
|
+
response_type: "google.cloud.discoveryengine.v1alpha.BatchVerifyTargetSitesResponse"
|
211
|
+
metadata_type: "google.cloud.discoveryengine.v1alpha.BatchVerifyTargetSitesMetadata"
|
212
|
+
};
|
213
|
+
}
|
214
|
+
|
215
|
+
// Returns list of target sites with its domain verification status.
|
216
|
+
// This method can only be called under data store with BASIC_SITE_SEARCH
|
217
|
+
// state at the moment.
|
218
|
+
rpc FetchDomainVerificationStatus(FetchDomainVerificationStatusRequest)
|
219
|
+
returns (FetchDomainVerificationStatusResponse) {
|
220
|
+
option (google.api.http) = {
|
221
|
+
get: "/v1alpha/{site_search_engine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:fetchDomainVerificationStatus"
|
222
|
+
};
|
223
|
+
}
|
224
|
+
}
|
225
|
+
|
226
|
+
// Request message for
|
227
|
+
// [SiteSearchEngineService.GetSiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.GetSiteSearchEngine]
|
228
|
+
// method.
|
229
|
+
message GetSiteSearchEngineRequest {
|
230
|
+
// Required. Resource name of
|
231
|
+
// [SiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngine],
|
232
|
+
// such as
|
233
|
+
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
|
234
|
+
//
|
235
|
+
// If the caller does not have permission to access the [SiteSearchEngine],
|
236
|
+
// regardless of whether or not it exists, a PERMISSION_DENIED error is
|
237
|
+
// returned.
|
238
|
+
string name = 1 [
|
239
|
+
(google.api.field_behavior) = REQUIRED,
|
240
|
+
(google.api.resource_reference) = {
|
241
|
+
type: "discoveryengine.googleapis.com/SiteSearchEngine"
|
242
|
+
}
|
243
|
+
];
|
244
|
+
}
|
245
|
+
|
246
|
+
// Request message for
|
247
|
+
// [SiteSearchEngineService.CreateTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.CreateTargetSite]
|
248
|
+
// method.
|
249
|
+
message CreateTargetSiteRequest {
|
250
|
+
// Required. Parent resource name of
|
251
|
+
// [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite], such as
|
252
|
+
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
|
253
|
+
string parent = 1 [
|
254
|
+
(google.api.field_behavior) = REQUIRED,
|
255
|
+
(google.api.resource_reference) = {
|
256
|
+
type: "discoveryengine.googleapis.com/SiteSearchEngine"
|
257
|
+
}
|
258
|
+
];
|
259
|
+
|
260
|
+
// Required. The [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite]
|
261
|
+
// to create.
|
262
|
+
TargetSite target_site = 2 [(google.api.field_behavior) = REQUIRED];
|
263
|
+
}
|
264
|
+
|
265
|
+
// Metadata related to the progress of the
|
266
|
+
// [SiteSearchEngineService.CreateTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.CreateTargetSite]
|
267
|
+
// operation. This will be returned by the google.longrunning.Operation.metadata
|
268
|
+
// field.
|
269
|
+
message CreateTargetSiteMetadata {
|
270
|
+
// Operation create time.
|
271
|
+
google.protobuf.Timestamp create_time = 1;
|
272
|
+
|
273
|
+
// Operation last update time. If the operation is done, this is also the
|
274
|
+
// finish time.
|
275
|
+
google.protobuf.Timestamp update_time = 2;
|
276
|
+
}
|
277
|
+
|
278
|
+
// Request message for [SiteSearchEngineService.s][] method.
|
279
|
+
message BatchCreateTargetSitesRequest {
|
280
|
+
// Required. The parent resource shared by all TargetSites being created.
|
281
|
+
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
|
282
|
+
// The parent field in the CreateBookRequest messages must either be empty or
|
283
|
+
// match this field.
|
284
|
+
string parent = 1 [
|
285
|
+
(google.api.field_behavior) = REQUIRED,
|
286
|
+
(google.api.resource_reference) = {
|
287
|
+
type: "discoveryengine.googleapis.com/SiteSearchEngine"
|
288
|
+
}
|
289
|
+
];
|
290
|
+
|
291
|
+
// Required. The request message specifying the resources to create.
|
292
|
+
// A maximum of 20 TargetSites can be created in a batch.
|
293
|
+
repeated CreateTargetSiteRequest requests = 2
|
294
|
+
[(google.api.field_behavior) = REQUIRED];
|
295
|
+
}
|
296
|
+
|
297
|
+
// Request message for
|
298
|
+
// [SiteSearchEngineService.GetTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.GetTargetSite]
|
299
|
+
// method.
|
300
|
+
message GetTargetSiteRequest {
|
301
|
+
// Required. Full resource name of
|
302
|
+
// [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite], such as
|
303
|
+
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`.
|
304
|
+
//
|
305
|
+
// If the caller does not have permission to access the
|
306
|
+
// [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite], regardless
|
307
|
+
// of whether or not it exists, a PERMISSION_DENIED error is returned.
|
308
|
+
//
|
309
|
+
// If the requested
|
310
|
+
// [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite] does not
|
311
|
+
// exist, a NOT_FOUND error is returned.
|
312
|
+
string name = 1 [
|
313
|
+
(google.api.field_behavior) = REQUIRED,
|
314
|
+
(google.api.resource_reference) = {
|
315
|
+
type: "discoveryengine.googleapis.com/TargetSite"
|
316
|
+
}
|
317
|
+
];
|
318
|
+
}
|
319
|
+
|
320
|
+
// Request message for
|
321
|
+
// [SiteSearchEngineService.UpdateTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.UpdateTargetSite]
|
322
|
+
// method.
|
323
|
+
message UpdateTargetSiteRequest {
|
324
|
+
// Required. The target site to update.
|
325
|
+
// If the caller does not have permission to update the
|
326
|
+
// [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite], regardless
|
327
|
+
// of whether or not it exists, a PERMISSION_DENIED error is returned.
|
328
|
+
//
|
329
|
+
// If the [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite] to
|
330
|
+
// update does not exist, a NOT_FOUND error is returned.
|
331
|
+
TargetSite target_site = 1 [(google.api.field_behavior) = REQUIRED];
|
332
|
+
}
|
333
|
+
|
334
|
+
// Metadata related to the progress of the
|
335
|
+
// [SiteSearchEngineService.UpdateTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.UpdateTargetSite]
|
336
|
+
// operation. This will be returned by the google.longrunning.Operation.metadata
|
337
|
+
// field.
|
338
|
+
message UpdateTargetSiteMetadata {
|
339
|
+
// Operation create time.
|
340
|
+
google.protobuf.Timestamp create_time = 1;
|
341
|
+
|
342
|
+
// Operation last update time. If the operation is done, this is also the
|
343
|
+
// finish time.
|
344
|
+
google.protobuf.Timestamp update_time = 2;
|
345
|
+
}
|
346
|
+
|
347
|
+
// Request message for
|
348
|
+
// [SiteSearchEngineService.DeleteTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.DeleteTargetSite]
|
349
|
+
// method.
|
350
|
+
message DeleteTargetSiteRequest {
|
351
|
+
// Required. Full resource name of
|
352
|
+
// [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite], such as
|
353
|
+
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`.
|
354
|
+
//
|
355
|
+
// If the caller does not have permission to access the
|
356
|
+
// [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite], regardless
|
357
|
+
// of whether or not it exists, a PERMISSION_DENIED error is returned.
|
358
|
+
//
|
359
|
+
// If the requested
|
360
|
+
// [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite] does not
|
361
|
+
// exist, a NOT_FOUND error is returned.
|
362
|
+
string name = 1 [
|
363
|
+
(google.api.field_behavior) = REQUIRED,
|
364
|
+
(google.api.resource_reference) = {
|
365
|
+
type: "discoveryengine.googleapis.com/TargetSite"
|
366
|
+
}
|
367
|
+
];
|
368
|
+
}
|
369
|
+
|
370
|
+
// Metadata related to the progress of the
|
371
|
+
// [SiteSearchEngineService.DeleteTargetSite][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.DeleteTargetSite]
|
372
|
+
// operation. This will be returned by the google.longrunning.Operation.metadata
|
373
|
+
// field.
|
374
|
+
message DeleteTargetSiteMetadata {
|
375
|
+
// Operation create time.
|
376
|
+
google.protobuf.Timestamp create_time = 1;
|
377
|
+
|
378
|
+
// Operation last update time. If the operation is done, this is also the
|
379
|
+
// finish time.
|
380
|
+
google.protobuf.Timestamp update_time = 2;
|
381
|
+
}
|
382
|
+
|
383
|
+
// Request message for
|
384
|
+
// [SiteSearchEngineService.ListTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.ListTargetSites]
|
385
|
+
// method.
|
386
|
+
message ListTargetSitesRequest {
|
387
|
+
// Required. The parent site search engine resource name, such as
|
388
|
+
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
|
389
|
+
//
|
390
|
+
// If the caller does not have permission to list
|
391
|
+
// [TargetSite][google.cloud.discoveryengine.v1alpha.TargetSite]s under this
|
392
|
+
// site search engine, regardless of whether or not this branch exists, a
|
393
|
+
// PERMISSION_DENIED error is returned.
|
394
|
+
string parent = 1 [
|
395
|
+
(google.api.field_behavior) = REQUIRED,
|
396
|
+
(google.api.resource_reference) = {
|
397
|
+
type: "discoveryengine.googleapis.com/SiteSearchEngine"
|
398
|
+
}
|
399
|
+
];
|
400
|
+
|
401
|
+
// Requested page size. Server may return fewer items than requested. If
|
402
|
+
// unspecified, server will pick an appropriate default. The maximum value is
|
403
|
+
// 1000; values above 1000 will be coerced to 1000.
|
404
|
+
//
|
405
|
+
// If this field is negative, an INVALID_ARGUMENT error is returned.
|
406
|
+
int32 page_size = 2;
|
407
|
+
|
408
|
+
// A page token, received from a previous `ListTargetSites` call.
|
409
|
+
// Provide this to retrieve the subsequent page.
|
410
|
+
//
|
411
|
+
// When paginating, all other parameters provided to `ListTargetSites`
|
412
|
+
// must match the call that provided the page token.
|
413
|
+
string page_token = 3;
|
414
|
+
}
|
415
|
+
|
416
|
+
// Response message for
|
417
|
+
// [SiteSearchEngineService.ListTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.ListTargetSites]
|
418
|
+
// method.
|
419
|
+
message ListTargetSitesResponse {
|
420
|
+
// List of TargetSites.
|
421
|
+
repeated TargetSite target_sites = 1;
|
422
|
+
|
423
|
+
// A token that can be sent as `page_token` to retrieve the next page.
|
424
|
+
// If this field is omitted, there are no subsequent pages.
|
425
|
+
string next_page_token = 2;
|
426
|
+
|
427
|
+
// The total number of items matching the request.
|
428
|
+
// This will always be populated in the response.
|
429
|
+
int32 total_size = 3;
|
430
|
+
}
|
431
|
+
|
432
|
+
// Metadata related to the progress of the
|
433
|
+
// [SiteSearchEngineService.BatchCreateTargetSite][] operation. This will be
|
434
|
+
// returned by the google.longrunning.Operation.metadata field.
|
435
|
+
message BatchCreateTargetSiteMetadata {
|
436
|
+
// Operation create time.
|
437
|
+
google.protobuf.Timestamp create_time = 1;
|
438
|
+
|
439
|
+
// Operation last update time. If the operation is done, this is also the
|
440
|
+
// finish time.
|
441
|
+
google.protobuf.Timestamp update_time = 2;
|
442
|
+
}
|
443
|
+
|
444
|
+
// Response message for
|
445
|
+
// [SiteSearchEngineService.BatchCreateTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.BatchCreateTargetSites]
|
446
|
+
// method.
|
447
|
+
message BatchCreateTargetSitesResponse {
|
448
|
+
// TargetSites created.
|
449
|
+
repeated TargetSite target_sites = 1;
|
450
|
+
}
|
451
|
+
|
452
|
+
// Request message for
|
453
|
+
// [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.EnableAdvancedSiteSearch]
|
454
|
+
// method.
|
455
|
+
message EnableAdvancedSiteSearchRequest {
|
456
|
+
// Required. Full resource name of the
|
457
|
+
// [SiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngine],
|
458
|
+
// such as
|
459
|
+
// `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.
|
460
|
+
string site_search_engine = 1 [
|
461
|
+
(google.api.field_behavior) = REQUIRED,
|
462
|
+
(google.api.resource_reference) = {
|
463
|
+
type: "discoveryengine.googleapis.com/SiteSearchEngine"
|
464
|
+
}
|
465
|
+
];
|
466
|
+
}
|
467
|
+
|
468
|
+
// Response message for
|
469
|
+
// [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.EnableAdvancedSiteSearch]
|
470
|
+
// method.
|
471
|
+
message EnableAdvancedSiteSearchResponse {}
|
472
|
+
|
473
|
+
// Metadata related to the progress of the
|
474
|
+
// [SiteSearchEngineService.EnableAdvancedSiteSearch][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.EnableAdvancedSiteSearch]
|
475
|
+
// operation. This will be returned by the google.longrunning.Operation.metadata
|
476
|
+
// field.
|
477
|
+
message EnableAdvancedSiteSearchMetadata {
|
478
|
+
// Operation create time.
|
479
|
+
google.protobuf.Timestamp create_time = 1;
|
480
|
+
|
481
|
+
// Operation last update time. If the operation is done, this is also the
|
482
|
+
// finish time.
|
483
|
+
google.protobuf.Timestamp update_time = 2;
|
484
|
+
}
|
485
|
+
|
486
|
+
// Request message for
|
487
|
+
// [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.DisableAdvancedSiteSearch]
|
488
|
+
// method.
|
489
|
+
message DisableAdvancedSiteSearchRequest {
|
490
|
+
// Required. Full resource name of the
|
491
|
+
// [SiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngine],
|
492
|
+
// such as
|
493
|
+
// `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.
|
494
|
+
string site_search_engine = 1 [
|
495
|
+
(google.api.field_behavior) = REQUIRED,
|
496
|
+
(google.api.resource_reference) = {
|
497
|
+
type: "discoveryengine.googleapis.com/SiteSearchEngine"
|
498
|
+
}
|
499
|
+
];
|
500
|
+
}
|
501
|
+
|
502
|
+
// Response message for
|
503
|
+
// [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.DisableAdvancedSiteSearch]
|
504
|
+
// method.
|
505
|
+
message DisableAdvancedSiteSearchResponse {}
|
506
|
+
|
507
|
+
// Metadata related to the progress of the
|
508
|
+
// [SiteSearchEngineService.DisableAdvancedSiteSearch][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.DisableAdvancedSiteSearch]
|
509
|
+
// operation. This will be returned by the google.longrunning.Operation.metadata
|
510
|
+
// field.
|
511
|
+
message DisableAdvancedSiteSearchMetadata {
|
512
|
+
// Operation create time.
|
513
|
+
google.protobuf.Timestamp create_time = 1;
|
514
|
+
|
515
|
+
// Operation last update time. If the operation is done, this is also the
|
516
|
+
// finish time.
|
517
|
+
google.protobuf.Timestamp update_time = 2;
|
56
518
|
}
|
57
519
|
|
58
520
|
// Request message for
|
@@ -150,3 +612,81 @@ message RecrawlUrisMetadata {
|
|
150
612
|
// resources.
|
151
613
|
int32 quota_exceeded_count = 7;
|
152
614
|
}
|
615
|
+
|
616
|
+
// Request message for
|
617
|
+
// [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.BatchVerifyTargetSites]
|
618
|
+
// method.
|
619
|
+
message BatchVerifyTargetSitesRequest {
|
620
|
+
// Required. The parent resource shared by all TargetSites being verified.
|
621
|
+
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
|
622
|
+
string parent = 1 [
|
623
|
+
(google.api.field_behavior) = REQUIRED,
|
624
|
+
(google.api.resource_reference) = {
|
625
|
+
type: "discoveryengine.googleapis.com/SiteSearchEngine"
|
626
|
+
}
|
627
|
+
];
|
628
|
+
}
|
629
|
+
|
630
|
+
// Response message for
|
631
|
+
// [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.BatchVerifyTargetSites]
|
632
|
+
// method.
|
633
|
+
message BatchVerifyTargetSitesResponse {}
|
634
|
+
|
635
|
+
// Metadata related to the progress of the
|
636
|
+
// [SiteSearchEngineService.BatchVerifyTargetSites][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.BatchVerifyTargetSites]
|
637
|
+
// operation. This will be returned by the google.longrunning.Operation.metadata
|
638
|
+
// field.
|
639
|
+
message BatchVerifyTargetSitesMetadata {
|
640
|
+
// Operation create time.
|
641
|
+
google.protobuf.Timestamp create_time = 1;
|
642
|
+
|
643
|
+
// Operation last update time. If the operation is done, this is also the
|
644
|
+
// finish time.
|
645
|
+
google.protobuf.Timestamp update_time = 2;
|
646
|
+
}
|
647
|
+
|
648
|
+
// Request message for
|
649
|
+
// [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.FetchDomainVerificationStatus]
|
650
|
+
// method.
|
651
|
+
message FetchDomainVerificationStatusRequest {
|
652
|
+
// Required. The site search engine resource under which we fetch all the
|
653
|
+
// domain verification status.
|
654
|
+
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
|
655
|
+
string site_search_engine = 1 [
|
656
|
+
(google.api.field_behavior) = REQUIRED,
|
657
|
+
(google.api.resource_reference) = {
|
658
|
+
type: "discoveryengine.googleapis.com/SiteSearchEngine"
|
659
|
+
}
|
660
|
+
];
|
661
|
+
|
662
|
+
// Requested page size. Server may return fewer items than requested. If
|
663
|
+
// unspecified, server will pick an appropriate default. The maximum value is
|
664
|
+
// 1000; values above 1000 will be coerced to 1000.
|
665
|
+
//
|
666
|
+
// If this field is negative, an INVALID_ARGUMENT error is returned.
|
667
|
+
int32 page_size = 2;
|
668
|
+
|
669
|
+
// A page token, received from a previous `FetchDomainVerificationStatus`
|
670
|
+
// call. Provide this to retrieve the subsequent page.
|
671
|
+
//
|
672
|
+
// When paginating, all other parameters provided to
|
673
|
+
// `FetchDomainVerificationStatus` must match the call that provided the page
|
674
|
+
// token.
|
675
|
+
string page_token = 3;
|
676
|
+
}
|
677
|
+
|
678
|
+
// Response message for
|
679
|
+
// [SiteSearchEngineService.FetchDomainVerificationStatus][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.FetchDomainVerificationStatus]
|
680
|
+
// method.
|
681
|
+
message FetchDomainVerificationStatusResponse {
|
682
|
+
// List of TargetSites containing the site verification status.
|
683
|
+
repeated TargetSite target_sites = 1;
|
684
|
+
|
685
|
+
// A token that can be sent as `page_token` to retrieve the next page.
|
686
|
+
// If this field is omitted, there are no subsequent pages.
|
687
|
+
string next_page_token = 2;
|
688
|
+
|
689
|
+
// The total number of items matching the request.
|
690
|
+
// This will always be populated in the response.
|
691
|
+
int32 total_size = 3;
|
692
|
+
}
|