google-cloud-discovery_engine-v1 0.4.2 → 0.5.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (90) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/discovery_engine/v1/completion_service/client.rb +235 -4
  3. data/lib/google/cloud/discovery_engine/v1/completion_service/operations.rb +801 -0
  4. data/lib/google/cloud/discovery_engine/v1/completion_service/rest/client.rb +221 -4
  5. data/lib/google/cloud/discovery_engine/v1/completion_service/rest/operations.rb +1091 -0
  6. data/lib/google/cloud/discovery_engine/v1/completion_service/rest/service_stub.rb +136 -0
  7. data/lib/google/cloud/discovery_engine/v1/completion_service/rest.rb +1 -0
  8. data/lib/google/cloud/discovery_engine/v1/completion_service.rb +1 -0
  9. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/client.rb +20 -3
  10. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/paths.rb +91 -0
  11. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/rest/client.rb +20 -3
  12. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/rest/service_stub.rb +45 -0
  13. data/lib/google/cloud/discovery_engine/v1/data_store_service/client.rb +924 -0
  14. data/lib/google/cloud/discovery_engine/v1/data_store_service/credentials.rb +47 -0
  15. data/lib/google/cloud/discovery_engine/v1/data_store_service/operations.rb +801 -0
  16. data/lib/google/cloud/discovery_engine/v1/data_store_service/paths.rb +97 -0
  17. data/lib/google/cloud/discovery_engine/v1/data_store_service/rest/client.rb +863 -0
  18. data/lib/google/cloud/discovery_engine/v1/data_store_service/rest/operations.rb +1091 -0
  19. data/lib/google/cloud/discovery_engine/v1/data_store_service/rest/service_stub.rb +403 -0
  20. data/lib/google/cloud/discovery_engine/v1/data_store_service/rest.rb +54 -0
  21. data/lib/google/cloud/discovery_engine/v1/data_store_service.rb +57 -0
  22. data/lib/google/cloud/discovery_engine/v1/document_service/rest/operations.rb +14 -0
  23. data/lib/google/cloud/discovery_engine/v1/engine_service/client.rb +885 -0
  24. data/lib/google/cloud/discovery_engine/v1/engine_service/credentials.rb +47 -0
  25. data/lib/google/cloud/discovery_engine/v1/engine_service/operations.rb +801 -0
  26. data/lib/google/cloud/discovery_engine/v1/engine_service/paths.rb +73 -0
  27. data/lib/google/cloud/discovery_engine/v1/engine_service/rest/client.rb +824 -0
  28. data/lib/google/cloud/discovery_engine/v1/engine_service/rest/operations.rb +1091 -0
  29. data/lib/google/cloud/discovery_engine/v1/engine_service/rest/service_stub.rb +366 -0
  30. data/lib/google/cloud/discovery_engine/v1/engine_service/rest.rb +54 -0
  31. data/lib/google/cloud/discovery_engine/v1/engine_service.rb +57 -0
  32. data/lib/google/cloud/discovery_engine/v1/rest.rb +3 -0
  33. data/lib/google/cloud/discovery_engine/v1/schema_service/rest/operations.rb +14 -0
  34. data/lib/google/cloud/discovery_engine/v1/search_service/client.rb +40 -4
  35. data/lib/google/cloud/discovery_engine/v1/search_service/paths.rb +19 -0
  36. data/lib/google/cloud/discovery_engine/v1/search_service/rest/client.rb +40 -4
  37. data/lib/google/cloud/discovery_engine/v1/search_service/rest/service_stub.rb +8 -0
  38. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb +1631 -0
  39. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/credentials.rb +47 -0
  40. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/operations.rb +801 -0
  41. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/paths.rb +127 -0
  42. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/client.rb +1521 -0
  43. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/operations.rb +1091 -0
  44. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/service_stub.rb +860 -0
  45. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest.rb +53 -0
  46. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service.rb +56 -0
  47. data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/operations.rb +14 -0
  48. data/lib/google/cloud/discovery_engine/v1/version.rb +1 -1
  49. data/lib/google/cloud/discovery_engine/v1.rb +3 -0
  50. data/lib/google/cloud/discoveryengine/v1/common_pb.rb +5 -1
  51. data/lib/google/cloud/discoveryengine/v1/completion_pb.rb +45 -0
  52. data/lib/google/cloud/discoveryengine/v1/completion_service_pb.rb +4 -1
  53. data/lib/google/cloud/discoveryengine/v1/completion_service_services_pb.rb +8 -0
  54. data/lib/google/cloud/discoveryengine/v1/conversation_pb.rb +1 -1
  55. data/lib/google/cloud/discoveryengine/v1/conversational_search_service_pb.rb +1 -1
  56. data/lib/google/cloud/discoveryengine/v1/data_store_pb.rb +49 -0
  57. data/lib/google/cloud/discoveryengine/v1/data_store_service_pb.rb +62 -0
  58. data/lib/google/cloud/discoveryengine/v1/data_store_service_services_pb.rb +61 -0
  59. data/lib/google/cloud/discoveryengine/v1/document_pb.rb +1 -1
  60. data/lib/google/cloud/discoveryengine/v1/document_service_pb.rb +1 -1
  61. data/lib/google/cloud/discoveryengine/v1/engine_pb.rb +53 -0
  62. data/lib/google/cloud/discoveryengine/v1/engine_service_pb.rb +62 -0
  63. data/lib/google/cloud/discoveryengine/v1/engine_service_services_pb.rb +55 -0
  64. data/lib/google/cloud/discoveryengine/v1/import_config_pb.rb +7 -1
  65. data/lib/google/cloud/discoveryengine/v1/purge_config_pb.rb +6 -1
  66. data/lib/google/cloud/discoveryengine/v1/schema_pb.rb +1 -1
  67. data/lib/google/cloud/discoveryengine/v1/schema_service_pb.rb +1 -1
  68. data/lib/google/cloud/discoveryengine/v1/search_service_pb.rb +8 -1
  69. data/lib/google/cloud/discoveryengine/v1/site_search_engine_pb.rb +54 -0
  70. data/lib/google/cloud/discoveryengine/v1/site_search_engine_service_pb.rb +82 -0
  71. data/lib/google/cloud/discoveryengine/v1/site_search_engine_service_services_pb.rb +73 -0
  72. data/lib/google/cloud/discoveryengine/v1/user_event_pb.rb +1 -1
  73. data/lib/google/cloud/discoveryengine/v1/user_event_service_pb.rb +1 -1
  74. data/proto_docs/google/cloud/discoveryengine/v1/common.rb +51 -0
  75. data/proto_docs/google/cloud/discoveryengine/v1/completion.rb +53 -0
  76. data/proto_docs/google/cloud/discoveryengine/v1/completion_service.rb +10 -4
  77. data/proto_docs/google/cloud/discoveryengine/v1/conversation.rb +2 -0
  78. data/proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb +19 -1
  79. data/proto_docs/google/cloud/discoveryengine/v1/data_store.rb +88 -0
  80. data/proto_docs/google/cloud/discoveryengine/v1/data_store_service.rb +214 -0
  81. data/proto_docs/google/cloud/discoveryengine/v1/document.rb +1 -1
  82. data/proto_docs/google/cloud/discoveryengine/v1/engine.rb +214 -0
  83. data/proto_docs/google/cloud/discoveryengine/v1/engine_service.rb +177 -0
  84. data/proto_docs/google/cloud/discoveryengine/v1/import_config.rb +66 -0
  85. data/proto_docs/google/cloud/discoveryengine/v1/purge_config.rb +41 -0
  86. data/proto_docs/google/cloud/discoveryengine/v1/search_service.rb +149 -4
  87. data/proto_docs/google/cloud/discoveryengine/v1/site_search_engine.rb +160 -0
  88. data/proto_docs/google/cloud/discoveryengine/v1/site_search_engine_service.rb +525 -0
  89. data/proto_docs/google/cloud/discoveryengine/v1/user_event.rb +3 -3
  90. metadata +48 -2
@@ -0,0 +1,525 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module DiscoveryEngine
23
+ module V1
24
+ # Request message for
25
+ # {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client#get_site_search_engine SiteSearchEngineService.GetSiteSearchEngine}
26
+ # method.
27
+ # @!attribute [rw] name
28
+ # @return [::String]
29
+ # Required. Resource name of
30
+ # {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngine SiteSearchEngine}, such
31
+ # as
32
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
33
+ #
34
+ # If the caller does not have permission to access the [SiteSearchEngine],
35
+ # regardless of whether or not it exists, a PERMISSION_DENIED error is
36
+ # returned.
37
+ class GetSiteSearchEngineRequest
38
+ include ::Google::Protobuf::MessageExts
39
+ extend ::Google::Protobuf::MessageExts::ClassMethods
40
+ end
41
+
42
+ # Request message for
43
+ # {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client#create_target_site SiteSearchEngineService.CreateTargetSite}
44
+ # method.
45
+ # @!attribute [rw] parent
46
+ # @return [::String]
47
+ # Required. Parent resource name of
48
+ # {::Google::Cloud::DiscoveryEngine::V1::TargetSite TargetSite}, such as
49
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
50
+ # @!attribute [rw] target_site
51
+ # @return [::Google::Cloud::DiscoveryEngine::V1::TargetSite]
52
+ # Required. The {::Google::Cloud::DiscoveryEngine::V1::TargetSite TargetSite} to
53
+ # create.
54
+ class CreateTargetSiteRequest
55
+ include ::Google::Protobuf::MessageExts
56
+ extend ::Google::Protobuf::MessageExts::ClassMethods
57
+ end
58
+
59
+ # Metadata related to the progress of the
60
+ # {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client#create_target_site SiteSearchEngineService.CreateTargetSite}
61
+ # operation. This will be returned by the google.longrunning.Operation.metadata
62
+ # field.
63
+ # @!attribute [rw] create_time
64
+ # @return [::Google::Protobuf::Timestamp]
65
+ # Operation create time.
66
+ # @!attribute [rw] update_time
67
+ # @return [::Google::Protobuf::Timestamp]
68
+ # Operation last update time. If the operation is done, this is also the
69
+ # finish time.
70
+ class CreateTargetSiteMetadata
71
+ include ::Google::Protobuf::MessageExts
72
+ extend ::Google::Protobuf::MessageExts::ClassMethods
73
+ end
74
+
75
+ # Request message for
76
+ # {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client#batch_create_target_sites SiteSearchEngineService.BatchCreateTargetSites}
77
+ # method.
78
+ # @!attribute [rw] parent
79
+ # @return [::String]
80
+ # Required. The parent resource shared by all TargetSites being created.
81
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
82
+ # The parent field in the CreateBookRequest messages must either be empty or
83
+ # match this field.
84
+ # @!attribute [rw] requests
85
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1::CreateTargetSiteRequest>]
86
+ # Required. The request message specifying the resources to create.
87
+ # A maximum of 20 TargetSites can be created in a batch.
88
+ class BatchCreateTargetSitesRequest
89
+ include ::Google::Protobuf::MessageExts
90
+ extend ::Google::Protobuf::MessageExts::ClassMethods
91
+ end
92
+
93
+ # Request message for
94
+ # {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client#get_target_site SiteSearchEngineService.GetTargetSite}
95
+ # method.
96
+ # @!attribute [rw] name
97
+ # @return [::String]
98
+ # Required. Full resource name of
99
+ # {::Google::Cloud::DiscoveryEngine::V1::TargetSite TargetSite}, such as
100
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`.
101
+ #
102
+ # If the caller does not have permission to access the
103
+ # {::Google::Cloud::DiscoveryEngine::V1::TargetSite TargetSite}, regardless of
104
+ # whether or not it exists, a PERMISSION_DENIED error is returned.
105
+ #
106
+ # If the requested {::Google::Cloud::DiscoveryEngine::V1::TargetSite TargetSite}
107
+ # does not exist, a NOT_FOUND error is returned.
108
+ class GetTargetSiteRequest
109
+ include ::Google::Protobuf::MessageExts
110
+ extend ::Google::Protobuf::MessageExts::ClassMethods
111
+ end
112
+
113
+ # Request message for
114
+ # {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client#update_target_site SiteSearchEngineService.UpdateTargetSite}
115
+ # method.
116
+ # @!attribute [rw] target_site
117
+ # @return [::Google::Cloud::DiscoveryEngine::V1::TargetSite]
118
+ # Required. The target site to update.
119
+ # If the caller does not have permission to update the
120
+ # {::Google::Cloud::DiscoveryEngine::V1::TargetSite TargetSite}, regardless of
121
+ # whether or not it exists, a PERMISSION_DENIED error is returned.
122
+ #
123
+ # If the {::Google::Cloud::DiscoveryEngine::V1::TargetSite TargetSite} to update
124
+ # does not exist, a NOT_FOUND error is returned.
125
+ class UpdateTargetSiteRequest
126
+ include ::Google::Protobuf::MessageExts
127
+ extend ::Google::Protobuf::MessageExts::ClassMethods
128
+ end
129
+
130
+ # Metadata related to the progress of the
131
+ # {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client#update_target_site SiteSearchEngineService.UpdateTargetSite}
132
+ # operation. This will be returned by the google.longrunning.Operation.metadata
133
+ # field.
134
+ # @!attribute [rw] create_time
135
+ # @return [::Google::Protobuf::Timestamp]
136
+ # Operation create time.
137
+ # @!attribute [rw] update_time
138
+ # @return [::Google::Protobuf::Timestamp]
139
+ # Operation last update time. If the operation is done, this is also the
140
+ # finish time.
141
+ class UpdateTargetSiteMetadata
142
+ include ::Google::Protobuf::MessageExts
143
+ extend ::Google::Protobuf::MessageExts::ClassMethods
144
+ end
145
+
146
+ # Request message for
147
+ # {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client#delete_target_site SiteSearchEngineService.DeleteTargetSite}
148
+ # method.
149
+ # @!attribute [rw] name
150
+ # @return [::String]
151
+ # Required. Full resource name of
152
+ # {::Google::Cloud::DiscoveryEngine::V1::TargetSite TargetSite}, such as
153
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`.
154
+ #
155
+ # If the caller does not have permission to access the
156
+ # {::Google::Cloud::DiscoveryEngine::V1::TargetSite TargetSite}, regardless of
157
+ # whether or not it exists, a PERMISSION_DENIED error is returned.
158
+ #
159
+ # If the requested {::Google::Cloud::DiscoveryEngine::V1::TargetSite TargetSite}
160
+ # does not exist, a NOT_FOUND error is returned.
161
+ class DeleteTargetSiteRequest
162
+ include ::Google::Protobuf::MessageExts
163
+ extend ::Google::Protobuf::MessageExts::ClassMethods
164
+ end
165
+
166
+ # Metadata related to the progress of the
167
+ # {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client#delete_target_site SiteSearchEngineService.DeleteTargetSite}
168
+ # operation. This will be returned by the google.longrunning.Operation.metadata
169
+ # field.
170
+ # @!attribute [rw] create_time
171
+ # @return [::Google::Protobuf::Timestamp]
172
+ # Operation create time.
173
+ # @!attribute [rw] update_time
174
+ # @return [::Google::Protobuf::Timestamp]
175
+ # Operation last update time. If the operation is done, this is also the
176
+ # finish time.
177
+ class DeleteTargetSiteMetadata
178
+ include ::Google::Protobuf::MessageExts
179
+ extend ::Google::Protobuf::MessageExts::ClassMethods
180
+ end
181
+
182
+ # Request message for
183
+ # {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client#list_target_sites SiteSearchEngineService.ListTargetSites}
184
+ # method.
185
+ # @!attribute [rw] parent
186
+ # @return [::String]
187
+ # Required. The parent site search engine resource name, such as
188
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
189
+ #
190
+ # If the caller does not have permission to list
191
+ # {::Google::Cloud::DiscoveryEngine::V1::TargetSite TargetSite}s under this site
192
+ # search engine, regardless of whether or not this branch exists, a
193
+ # PERMISSION_DENIED error is returned.
194
+ # @!attribute [rw] page_size
195
+ # @return [::Integer]
196
+ # Requested page size. Server may return fewer items than requested. If
197
+ # unspecified, server will pick an appropriate default. The maximum value is
198
+ # 1000; values above 1000 will be coerced to 1000.
199
+ #
200
+ # If this field is negative, an INVALID_ARGUMENT error is returned.
201
+ # @!attribute [rw] page_token
202
+ # @return [::String]
203
+ # A page token, received from a previous `ListTargetSites` call.
204
+ # Provide this to retrieve the subsequent page.
205
+ #
206
+ # When paginating, all other parameters provided to `ListTargetSites`
207
+ # must match the call that provided the page token.
208
+ class ListTargetSitesRequest
209
+ include ::Google::Protobuf::MessageExts
210
+ extend ::Google::Protobuf::MessageExts::ClassMethods
211
+ end
212
+
213
+ # Response message for
214
+ # {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client#list_target_sites SiteSearchEngineService.ListTargetSites}
215
+ # method.
216
+ # @!attribute [rw] target_sites
217
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1::TargetSite>]
218
+ # List of TargetSites.
219
+ # @!attribute [rw] next_page_token
220
+ # @return [::String]
221
+ # A token that can be sent as `page_token` to retrieve the next page.
222
+ # If this field is omitted, there are no subsequent pages.
223
+ # @!attribute [rw] total_size
224
+ # @return [::Integer]
225
+ # The total number of items matching the request.
226
+ # This will always be populated in the response.
227
+ class ListTargetSitesResponse
228
+ include ::Google::Protobuf::MessageExts
229
+ extend ::Google::Protobuf::MessageExts::ClassMethods
230
+ end
231
+
232
+ # Metadata related to the progress of the
233
+ # {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client#batch_create_target_sites SiteSearchEngineService.BatchCreateTargetSites}
234
+ # operation. This will be returned by the google.longrunning.Operation.metadata
235
+ # field.
236
+ # @!attribute [rw] create_time
237
+ # @return [::Google::Protobuf::Timestamp]
238
+ # Operation create time.
239
+ # @!attribute [rw] update_time
240
+ # @return [::Google::Protobuf::Timestamp]
241
+ # Operation last update time. If the operation is done, this is also the
242
+ # finish time.
243
+ class BatchCreateTargetSiteMetadata
244
+ include ::Google::Protobuf::MessageExts
245
+ extend ::Google::Protobuf::MessageExts::ClassMethods
246
+ end
247
+
248
+ # Response message for
249
+ # {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client#batch_create_target_sites SiteSearchEngineService.BatchCreateTargetSites}
250
+ # method.
251
+ # @!attribute [rw] target_sites
252
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1::TargetSite>]
253
+ # TargetSites created.
254
+ class BatchCreateTargetSitesResponse
255
+ include ::Google::Protobuf::MessageExts
256
+ extend ::Google::Protobuf::MessageExts::ClassMethods
257
+ end
258
+
259
+ # Request message for
260
+ # {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client#enable_advanced_site_search SiteSearchEngineService.EnableAdvancedSiteSearch}
261
+ # method.
262
+ # @!attribute [rw] site_search_engine
263
+ # @return [::String]
264
+ # Required. Full resource name of the
265
+ # {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngine SiteSearchEngine}, such
266
+ # as
267
+ # `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.
268
+ class EnableAdvancedSiteSearchRequest
269
+ include ::Google::Protobuf::MessageExts
270
+ extend ::Google::Protobuf::MessageExts::ClassMethods
271
+ end
272
+
273
+ # Response message for
274
+ # {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client#enable_advanced_site_search SiteSearchEngineService.EnableAdvancedSiteSearch}
275
+ # method.
276
+ class EnableAdvancedSiteSearchResponse
277
+ include ::Google::Protobuf::MessageExts
278
+ extend ::Google::Protobuf::MessageExts::ClassMethods
279
+ end
280
+
281
+ # Metadata related to the progress of the
282
+ # {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client#enable_advanced_site_search SiteSearchEngineService.EnableAdvancedSiteSearch}
283
+ # operation. This will be returned by the google.longrunning.Operation.metadata
284
+ # field.
285
+ # @!attribute [rw] create_time
286
+ # @return [::Google::Protobuf::Timestamp]
287
+ # Operation create time.
288
+ # @!attribute [rw] update_time
289
+ # @return [::Google::Protobuf::Timestamp]
290
+ # Operation last update time. If the operation is done, this is also the
291
+ # finish time.
292
+ class EnableAdvancedSiteSearchMetadata
293
+ include ::Google::Protobuf::MessageExts
294
+ extend ::Google::Protobuf::MessageExts::ClassMethods
295
+ end
296
+
297
+ # Request message for
298
+ # {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client#disable_advanced_site_search SiteSearchEngineService.DisableAdvancedSiteSearch}
299
+ # method.
300
+ # @!attribute [rw] site_search_engine
301
+ # @return [::String]
302
+ # Required. Full resource name of the
303
+ # {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngine SiteSearchEngine}, such
304
+ # as
305
+ # `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.
306
+ class DisableAdvancedSiteSearchRequest
307
+ include ::Google::Protobuf::MessageExts
308
+ extend ::Google::Protobuf::MessageExts::ClassMethods
309
+ end
310
+
311
+ # Response message for
312
+ # {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client#disable_advanced_site_search SiteSearchEngineService.DisableAdvancedSiteSearch}
313
+ # method.
314
+ class DisableAdvancedSiteSearchResponse
315
+ include ::Google::Protobuf::MessageExts
316
+ extend ::Google::Protobuf::MessageExts::ClassMethods
317
+ end
318
+
319
+ # Metadata related to the progress of the
320
+ # {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client#disable_advanced_site_search SiteSearchEngineService.DisableAdvancedSiteSearch}
321
+ # operation. This will be returned by the google.longrunning.Operation.metadata
322
+ # field.
323
+ # @!attribute [rw] create_time
324
+ # @return [::Google::Protobuf::Timestamp]
325
+ # Operation create time.
326
+ # @!attribute [rw] update_time
327
+ # @return [::Google::Protobuf::Timestamp]
328
+ # Operation last update time. If the operation is done, this is also the
329
+ # finish time.
330
+ class DisableAdvancedSiteSearchMetadata
331
+ include ::Google::Protobuf::MessageExts
332
+ extend ::Google::Protobuf::MessageExts::ClassMethods
333
+ end
334
+
335
+ # Request message for
336
+ # {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client#recrawl_uris SiteSearchEngineService.RecrawlUris}
337
+ # method.
338
+ # @!attribute [rw] site_search_engine
339
+ # @return [::String]
340
+ # Required. Full resource name of the
341
+ # {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngine SiteSearchEngine}, such
342
+ # as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.
343
+ # @!attribute [rw] uris
344
+ # @return [::Array<::String>]
345
+ # Required. List of URIs to crawl. At most 10K URIs are supported, otherwise
346
+ # an INVALID_ARGUMENT error is thrown. Each URI should match at least one
347
+ # {::Google::Cloud::DiscoveryEngine::V1::TargetSite TargetSite} in
348
+ # `site_search_engine`.
349
+ class RecrawlUrisRequest
350
+ include ::Google::Protobuf::MessageExts
351
+ extend ::Google::Protobuf::MessageExts::ClassMethods
352
+ end
353
+
354
+ # Response message for
355
+ # {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client#recrawl_uris SiteSearchEngineService.RecrawlUris}
356
+ # method.
357
+ # @!attribute [rw] failure_samples
358
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1::RecrawlUrisResponse::FailureInfo>]
359
+ # Details for a sample of up to 10 `failed_uris`.
360
+ # @!attribute [rw] failed_uris
361
+ # @return [::Array<::String>]
362
+ # URIs that were not crawled before the LRO terminated.
363
+ class RecrawlUrisResponse
364
+ include ::Google::Protobuf::MessageExts
365
+ extend ::Google::Protobuf::MessageExts::ClassMethods
366
+
367
+ # Details about why a particular URI failed to be crawled. Each FailureInfo
368
+ # contains one FailureReason per CorpusType.
369
+ # @!attribute [rw] uri
370
+ # @return [::String]
371
+ # URI that failed to be crawled.
372
+ # @!attribute [rw] failure_reasons
373
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1::RecrawlUrisResponse::FailureInfo::FailureReason>]
374
+ # List of failure reasons by corpus type (e.g. desktop, mobile).
375
+ class FailureInfo
376
+ include ::Google::Protobuf::MessageExts
377
+ extend ::Google::Protobuf::MessageExts::ClassMethods
378
+
379
+ # Details about why crawling failed for a particular CorpusType, e.g.,
380
+ # DESKTOP and MOBILE crawling may fail for different reasons.
381
+ # @!attribute [rw] corpus_type
382
+ # @return [::Google::Cloud::DiscoveryEngine::V1::RecrawlUrisResponse::FailureInfo::FailureReason::CorpusType]
383
+ # DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED.
384
+ # @!attribute [rw] error_message
385
+ # @return [::String]
386
+ # Reason why the URI was not crawled.
387
+ class FailureReason
388
+ include ::Google::Protobuf::MessageExts
389
+ extend ::Google::Protobuf::MessageExts::ClassMethods
390
+
391
+ # CorpusType for the failed crawling operation.
392
+ module CorpusType
393
+ # Default value.
394
+ CORPUS_TYPE_UNSPECIFIED = 0
395
+
396
+ # Denotes a crawling attempt for the desktop version of a page.
397
+ DESKTOP = 1
398
+
399
+ # Denotes a crawling attempt for the mobile version of a page.
400
+ MOBILE = 2
401
+ end
402
+ end
403
+ end
404
+ end
405
+
406
+ # Metadata related to the progress of the
407
+ # {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client#recrawl_uris SiteSearchEngineService.RecrawlUris}
408
+ # operation. This will be returned by the google.longrunning.Operation.metadata
409
+ # field.
410
+ # @!attribute [rw] create_time
411
+ # @return [::Google::Protobuf::Timestamp]
412
+ # Operation create time.
413
+ # @!attribute [rw] update_time
414
+ # @return [::Google::Protobuf::Timestamp]
415
+ # Operation last update time. If the operation is done, this is also the
416
+ # finish time.
417
+ # @!attribute [rw] invalid_uris
418
+ # @return [::Array<::String>]
419
+ # Unique URIs in the request that don't match any TargetSite in the
420
+ # DataStore, only match TargetSites that haven't been fully indexed, or match
421
+ # a TargetSite with type EXCLUDE.
422
+ # @!attribute [rw] valid_uris_count
423
+ # @return [::Integer]
424
+ # Total number of unique URIs in the request that are not in invalid_uris.
425
+ # @!attribute [rw] success_count
426
+ # @return [::Integer]
427
+ # Total number of URIs that have been crawled so far.
428
+ # @!attribute [rw] pending_count
429
+ # @return [::Integer]
430
+ # Total number of URIs that have yet to be crawled.
431
+ # @!attribute [rw] quota_exceeded_count
432
+ # @return [::Integer]
433
+ # Total number of URIs that were rejected due to insufficient indexing
434
+ # resources.
435
+ class RecrawlUrisMetadata
436
+ include ::Google::Protobuf::MessageExts
437
+ extend ::Google::Protobuf::MessageExts::ClassMethods
438
+ end
439
+
440
+ # Request message for
441
+ # {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client#batch_verify_target_sites SiteSearchEngineService.BatchVerifyTargetSites}
442
+ # method.
443
+ # @!attribute [rw] parent
444
+ # @return [::String]
445
+ # Required. The parent resource shared by all TargetSites being verified.
446
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
447
+ class BatchVerifyTargetSitesRequest
448
+ include ::Google::Protobuf::MessageExts
449
+ extend ::Google::Protobuf::MessageExts::ClassMethods
450
+ end
451
+
452
+ # Response message for
453
+ # {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client#batch_verify_target_sites SiteSearchEngineService.BatchVerifyTargetSites}
454
+ # method.
455
+ class BatchVerifyTargetSitesResponse
456
+ include ::Google::Protobuf::MessageExts
457
+ extend ::Google::Protobuf::MessageExts::ClassMethods
458
+ end
459
+
460
+ # Metadata related to the progress of the
461
+ # {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client#batch_verify_target_sites SiteSearchEngineService.BatchVerifyTargetSites}
462
+ # operation. This will be returned by the google.longrunning.Operation.metadata
463
+ # field.
464
+ # @!attribute [rw] create_time
465
+ # @return [::Google::Protobuf::Timestamp]
466
+ # Operation create time.
467
+ # @!attribute [rw] update_time
468
+ # @return [::Google::Protobuf::Timestamp]
469
+ # Operation last update time. If the operation is done, this is also the
470
+ # finish time.
471
+ class BatchVerifyTargetSitesMetadata
472
+ include ::Google::Protobuf::MessageExts
473
+ extend ::Google::Protobuf::MessageExts::ClassMethods
474
+ end
475
+
476
+ # Request message for
477
+ # {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client#fetch_domain_verification_status SiteSearchEngineService.FetchDomainVerificationStatus}
478
+ # method.
479
+ # @!attribute [rw] site_search_engine
480
+ # @return [::String]
481
+ # Required. The site search engine resource under which we fetch all the
482
+ # domain verification status.
483
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
484
+ # @!attribute [rw] page_size
485
+ # @return [::Integer]
486
+ # Requested page size. Server may return fewer items than requested. If
487
+ # unspecified, server will pick an appropriate default. The maximum value is
488
+ # 1000; values above 1000 will be coerced to 1000.
489
+ #
490
+ # If this field is negative, an INVALID_ARGUMENT error is returned.
491
+ # @!attribute [rw] page_token
492
+ # @return [::String]
493
+ # A page token, received from a previous `FetchDomainVerificationStatus`
494
+ # call. Provide this to retrieve the subsequent page.
495
+ #
496
+ # When paginating, all other parameters provided to
497
+ # `FetchDomainVerificationStatus` must match the call that provided the page
498
+ # token.
499
+ class FetchDomainVerificationStatusRequest
500
+ include ::Google::Protobuf::MessageExts
501
+ extend ::Google::Protobuf::MessageExts::ClassMethods
502
+ end
503
+
504
+ # Response message for
505
+ # {::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client#fetch_domain_verification_status SiteSearchEngineService.FetchDomainVerificationStatus}
506
+ # method.
507
+ # @!attribute [rw] target_sites
508
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1::TargetSite>]
509
+ # List of TargetSites containing the site verification status.
510
+ # @!attribute [rw] next_page_token
511
+ # @return [::String]
512
+ # A token that can be sent as `page_token` to retrieve the next page.
513
+ # If this field is omitted, there are no subsequent pages.
514
+ # @!attribute [rw] total_size
515
+ # @return [::Integer]
516
+ # The total number of items matching the request.
517
+ # This will always be populated in the response.
518
+ class FetchDomainVerificationStatusResponse
519
+ include ::Google::Protobuf::MessageExts
520
+ extend ::Google::Protobuf::MessageExts::ClassMethods
521
+ end
522
+ end
523
+ end
524
+ end
525
+ end
@@ -133,9 +133,9 @@ module Google
133
133
  # conforming to https://google.aip.dev/160#filtering.
134
134
  #
135
135
  # Similarly, for `view-item-list` events that are generated from a
136
- # [RecommendationService.RecommendRequest][], this field may be populated
137
- # directly from [RecommendationService.RecommendRequest.filter][] conforming
138
- # to https://google.aip.dev/160#filtering.
136
+ # [RecommendRequest][], this field may be populated directly from
137
+ # [RecommendRequest.filter][] conforming to
138
+ # https://google.aip.dev/160#filtering.
139
139
  #
140
140
  # The value must be a UTF-8 encoded string with a length limit of 1,000
141
141
  # characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-discovery_engine-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.4.2
4
+ version: 0.5.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-02-01 00:00:00.000000000 Z
11
+ date: 2024-02-12 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -193,9 +193,11 @@ files:
193
193
  - lib/google/cloud/discovery_engine/v1/completion_service.rb
194
194
  - lib/google/cloud/discovery_engine/v1/completion_service/client.rb
195
195
  - lib/google/cloud/discovery_engine/v1/completion_service/credentials.rb
196
+ - lib/google/cloud/discovery_engine/v1/completion_service/operations.rb
196
197
  - lib/google/cloud/discovery_engine/v1/completion_service/paths.rb
197
198
  - lib/google/cloud/discovery_engine/v1/completion_service/rest.rb
198
199
  - lib/google/cloud/discovery_engine/v1/completion_service/rest/client.rb
200
+ - lib/google/cloud/discovery_engine/v1/completion_service/rest/operations.rb
199
201
  - lib/google/cloud/discovery_engine/v1/completion_service/rest/service_stub.rb
200
202
  - lib/google/cloud/discovery_engine/v1/conversational_search_service.rb
201
203
  - lib/google/cloud/discovery_engine/v1/conversational_search_service/client.rb
@@ -204,6 +206,15 @@ files:
204
206
  - lib/google/cloud/discovery_engine/v1/conversational_search_service/rest.rb
205
207
  - lib/google/cloud/discovery_engine/v1/conversational_search_service/rest/client.rb
206
208
  - lib/google/cloud/discovery_engine/v1/conversational_search_service/rest/service_stub.rb
209
+ - lib/google/cloud/discovery_engine/v1/data_store_service.rb
210
+ - lib/google/cloud/discovery_engine/v1/data_store_service/client.rb
211
+ - lib/google/cloud/discovery_engine/v1/data_store_service/credentials.rb
212
+ - lib/google/cloud/discovery_engine/v1/data_store_service/operations.rb
213
+ - lib/google/cloud/discovery_engine/v1/data_store_service/paths.rb
214
+ - lib/google/cloud/discovery_engine/v1/data_store_service/rest.rb
215
+ - lib/google/cloud/discovery_engine/v1/data_store_service/rest/client.rb
216
+ - lib/google/cloud/discovery_engine/v1/data_store_service/rest/operations.rb
217
+ - lib/google/cloud/discovery_engine/v1/data_store_service/rest/service_stub.rb
207
218
  - lib/google/cloud/discovery_engine/v1/document_service.rb
208
219
  - lib/google/cloud/discovery_engine/v1/document_service/client.rb
209
220
  - lib/google/cloud/discovery_engine/v1/document_service/credentials.rb
@@ -213,6 +224,15 @@ files:
213
224
  - lib/google/cloud/discovery_engine/v1/document_service/rest/client.rb
214
225
  - lib/google/cloud/discovery_engine/v1/document_service/rest/operations.rb
215
226
  - lib/google/cloud/discovery_engine/v1/document_service/rest/service_stub.rb
227
+ - lib/google/cloud/discovery_engine/v1/engine_service.rb
228
+ - lib/google/cloud/discovery_engine/v1/engine_service/client.rb
229
+ - lib/google/cloud/discovery_engine/v1/engine_service/credentials.rb
230
+ - lib/google/cloud/discovery_engine/v1/engine_service/operations.rb
231
+ - lib/google/cloud/discovery_engine/v1/engine_service/paths.rb
232
+ - lib/google/cloud/discovery_engine/v1/engine_service/rest.rb
233
+ - lib/google/cloud/discovery_engine/v1/engine_service/rest/client.rb
234
+ - lib/google/cloud/discovery_engine/v1/engine_service/rest/operations.rb
235
+ - lib/google/cloud/discovery_engine/v1/engine_service/rest/service_stub.rb
216
236
  - lib/google/cloud/discovery_engine/v1/rest.rb
217
237
  - lib/google/cloud/discovery_engine/v1/schema_service.rb
218
238
  - lib/google/cloud/discovery_engine/v1/schema_service/client.rb
@@ -230,6 +250,15 @@ files:
230
250
  - lib/google/cloud/discovery_engine/v1/search_service/rest.rb
231
251
  - lib/google/cloud/discovery_engine/v1/search_service/rest/client.rb
232
252
  - lib/google/cloud/discovery_engine/v1/search_service/rest/service_stub.rb
253
+ - lib/google/cloud/discovery_engine/v1/site_search_engine_service.rb
254
+ - lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb
255
+ - lib/google/cloud/discovery_engine/v1/site_search_engine_service/credentials.rb
256
+ - lib/google/cloud/discovery_engine/v1/site_search_engine_service/operations.rb
257
+ - lib/google/cloud/discovery_engine/v1/site_search_engine_service/paths.rb
258
+ - lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest.rb
259
+ - lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/client.rb
260
+ - lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/operations.rb
261
+ - lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/service_stub.rb
233
262
  - lib/google/cloud/discovery_engine/v1/user_event_service.rb
234
263
  - lib/google/cloud/discovery_engine/v1/user_event_service/client.rb
235
264
  - lib/google/cloud/discovery_engine/v1/user_event_service/credentials.rb
@@ -241,14 +270,21 @@ files:
241
270
  - lib/google/cloud/discovery_engine/v1/user_event_service/rest/service_stub.rb
242
271
  - lib/google/cloud/discovery_engine/v1/version.rb
243
272
  - lib/google/cloud/discoveryengine/v1/common_pb.rb
273
+ - lib/google/cloud/discoveryengine/v1/completion_pb.rb
244
274
  - lib/google/cloud/discoveryengine/v1/completion_service_pb.rb
245
275
  - lib/google/cloud/discoveryengine/v1/completion_service_services_pb.rb
246
276
  - lib/google/cloud/discoveryengine/v1/conversation_pb.rb
247
277
  - lib/google/cloud/discoveryengine/v1/conversational_search_service_pb.rb
248
278
  - lib/google/cloud/discoveryengine/v1/conversational_search_service_services_pb.rb
279
+ - lib/google/cloud/discoveryengine/v1/data_store_pb.rb
280
+ - lib/google/cloud/discoveryengine/v1/data_store_service_pb.rb
281
+ - lib/google/cloud/discoveryengine/v1/data_store_service_services_pb.rb
249
282
  - lib/google/cloud/discoveryengine/v1/document_pb.rb
250
283
  - lib/google/cloud/discoveryengine/v1/document_service_pb.rb
251
284
  - lib/google/cloud/discoveryengine/v1/document_service_services_pb.rb
285
+ - lib/google/cloud/discoveryengine/v1/engine_pb.rb
286
+ - lib/google/cloud/discoveryengine/v1/engine_service_pb.rb
287
+ - lib/google/cloud/discoveryengine/v1/engine_service_services_pb.rb
252
288
  - lib/google/cloud/discoveryengine/v1/import_config_pb.rb
253
289
  - lib/google/cloud/discoveryengine/v1/purge_config_pb.rb
254
290
  - lib/google/cloud/discoveryengine/v1/schema_pb.rb
@@ -256,6 +292,9 @@ files:
256
292
  - lib/google/cloud/discoveryengine/v1/schema_service_services_pb.rb
257
293
  - lib/google/cloud/discoveryengine/v1/search_service_pb.rb
258
294
  - lib/google/cloud/discoveryengine/v1/search_service_services_pb.rb
295
+ - lib/google/cloud/discoveryengine/v1/site_search_engine_pb.rb
296
+ - lib/google/cloud/discoveryengine/v1/site_search_engine_service_pb.rb
297
+ - lib/google/cloud/discoveryengine/v1/site_search_engine_service_services_pb.rb
259
298
  - lib/google/cloud/discoveryengine/v1/user_event_pb.rb
260
299
  - lib/google/cloud/discoveryengine/v1/user_event_service_pb.rb
261
300
  - lib/google/cloud/discoveryengine/v1/user_event_service_services_pb.rb
@@ -266,16 +305,23 @@ files:
266
305
  - proto_docs/google/api/launch_stage.rb
267
306
  - proto_docs/google/api/resource.rb
268
307
  - proto_docs/google/cloud/discoveryengine/v1/common.rb
308
+ - proto_docs/google/cloud/discoveryengine/v1/completion.rb
269
309
  - proto_docs/google/cloud/discoveryengine/v1/completion_service.rb
270
310
  - proto_docs/google/cloud/discoveryengine/v1/conversation.rb
271
311
  - proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb
312
+ - proto_docs/google/cloud/discoveryengine/v1/data_store.rb
313
+ - proto_docs/google/cloud/discoveryengine/v1/data_store_service.rb
272
314
  - proto_docs/google/cloud/discoveryengine/v1/document.rb
273
315
  - proto_docs/google/cloud/discoveryengine/v1/document_service.rb
316
+ - proto_docs/google/cloud/discoveryengine/v1/engine.rb
317
+ - proto_docs/google/cloud/discoveryengine/v1/engine_service.rb
274
318
  - proto_docs/google/cloud/discoveryengine/v1/import_config.rb
275
319
  - proto_docs/google/cloud/discoveryengine/v1/purge_config.rb
276
320
  - proto_docs/google/cloud/discoveryengine/v1/schema.rb
277
321
  - proto_docs/google/cloud/discoveryengine/v1/schema_service.rb
278
322
  - proto_docs/google/cloud/discoveryengine/v1/search_service.rb
323
+ - proto_docs/google/cloud/discoveryengine/v1/site_search_engine.rb
324
+ - proto_docs/google/cloud/discoveryengine/v1/site_search_engine_service.rb
279
325
  - proto_docs/google/cloud/discoveryengine/v1/user_event.rb
280
326
  - proto_docs/google/cloud/discoveryengine/v1/user_event_service.rb
281
327
  - proto_docs/google/longrunning/operations.rb