google-cloud-discovery_engine-v1beta 0.7.1 → 0.8.0

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