google-apis-discoveryengine_v1beta 0.7.0 → 0.9.0
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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/lib/google/apis/discoveryengine_v1beta/classes.rb +219 -36
- data/lib/google/apis/discoveryengine_v1beta/gem_version.rb +2 -2
- data/lib/google/apis/discoveryengine_v1beta/representations.rb +94 -2
- data/lib/google/apis/discoveryengine_v1beta/service.rb +709 -59
- metadata +3 -3
|
@@ -52,7 +52,684 @@ module Google
|
|
|
52
52
|
# Creates a Document.
|
|
53
53
|
# @param [String] parent
|
|
54
54
|
# Required. The parent resource name, such as `projects/`project`/locations/`
|
|
55
|
-
# location`/dataStores/`data_store`/branches/`branch``.
|
|
55
|
+
# location`/collections/`collection`/dataStores/`data_store`/branches/`branch``.
|
|
56
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument] google_cloud_discoveryengine_v1beta_document_object
|
|
57
|
+
# @param [String] document_id
|
|
58
|
+
# Required. The ID to use for the Document, which will become the final
|
|
59
|
+
# component of the Document.name. If the caller does not have permission to
|
|
60
|
+
# create the Document, regardless of whether or not it exists, a
|
|
61
|
+
# PERMISSION_DENIED error is returned. This field must be unique among all
|
|
62
|
+
# Documents with the same parent. Otherwise, an ALREADY_EXISTS error is returned.
|
|
63
|
+
# This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
|
|
64
|
+
# standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT
|
|
65
|
+
# error is returned.
|
|
66
|
+
# @param [String] fields
|
|
67
|
+
# Selector specifying which fields to include in a partial response.
|
|
68
|
+
# @param [String] quota_user
|
|
69
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
70
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
71
|
+
# @param [Google::Apis::RequestOptions] options
|
|
72
|
+
# Request-specific options
|
|
73
|
+
#
|
|
74
|
+
# @yield [result, err] Result & error if block supplied
|
|
75
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument] parsed result object
|
|
76
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
77
|
+
#
|
|
78
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument]
|
|
79
|
+
#
|
|
80
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
81
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
82
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
83
|
+
def create_project_location_collection_data_store_branch_document(parent, google_cloud_discoveryengine_v1beta_document_object = nil, document_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
84
|
+
command = make_simple_command(:post, 'v1beta/{+parent}/documents', options)
|
|
85
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument::Representation
|
|
86
|
+
command.request_object = google_cloud_discoveryengine_v1beta_document_object
|
|
87
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument::Representation
|
|
88
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument
|
|
89
|
+
command.params['parent'] = parent unless parent.nil?
|
|
90
|
+
command.query['documentId'] = document_id unless document_id.nil?
|
|
91
|
+
command.query['fields'] = fields unless fields.nil?
|
|
92
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
93
|
+
execute_or_queue_command(command, &block)
|
|
94
|
+
end
|
|
95
|
+
|
|
96
|
+
# Deletes a Document.
|
|
97
|
+
# @param [String] name
|
|
98
|
+
# Required. Full resource name of Document, such as `projects/`project`/
|
|
99
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
|
100
|
+
# `branch`/documents/`document``. If the caller does not have permission to
|
|
101
|
+
# delete the Document, regardless of whether or not it exists, a
|
|
102
|
+
# PERMISSION_DENIED error is returned. If the Document to delete does not exist,
|
|
103
|
+
# a NOT_FOUND error is returned.
|
|
104
|
+
# @param [String] fields
|
|
105
|
+
# Selector specifying which fields to include in a partial response.
|
|
106
|
+
# @param [String] quota_user
|
|
107
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
108
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
109
|
+
# @param [Google::Apis::RequestOptions] options
|
|
110
|
+
# Request-specific options
|
|
111
|
+
#
|
|
112
|
+
# @yield [result, err] Result & error if block supplied
|
|
113
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty] parsed result object
|
|
114
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
115
|
+
#
|
|
116
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty]
|
|
117
|
+
#
|
|
118
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
119
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
120
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
121
|
+
def delete_project_location_collection_data_store_branch_document(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
122
|
+
command = make_simple_command(:delete, 'v1beta/{+name}', options)
|
|
123
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty::Representation
|
|
124
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty
|
|
125
|
+
command.params['name'] = name unless name.nil?
|
|
126
|
+
command.query['fields'] = fields unless fields.nil?
|
|
127
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
128
|
+
execute_or_queue_command(command, &block)
|
|
129
|
+
end
|
|
130
|
+
|
|
131
|
+
# Gets a Document.
|
|
132
|
+
# @param [String] name
|
|
133
|
+
# Required. Full resource name of Document, such as `projects/`project`/
|
|
134
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
|
135
|
+
# `branch`/documents/`document``. If the caller does not have permission to
|
|
136
|
+
# access the Document, regardless of whether or not it exists, a
|
|
137
|
+
# PERMISSION_DENIED error is returned. If the requested Document does not exist,
|
|
138
|
+
# a NOT_FOUND error is returned.
|
|
139
|
+
# @param [String] fields
|
|
140
|
+
# Selector specifying which fields to include in a partial response.
|
|
141
|
+
# @param [String] quota_user
|
|
142
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
143
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
144
|
+
# @param [Google::Apis::RequestOptions] options
|
|
145
|
+
# Request-specific options
|
|
146
|
+
#
|
|
147
|
+
# @yield [result, err] Result & error if block supplied
|
|
148
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument] parsed result object
|
|
149
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
150
|
+
#
|
|
151
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument]
|
|
152
|
+
#
|
|
153
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
154
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
155
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
156
|
+
def get_project_location_collection_data_store_branch_document(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
157
|
+
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
|
158
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument::Representation
|
|
159
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument
|
|
160
|
+
command.params['name'] = name unless name.nil?
|
|
161
|
+
command.query['fields'] = fields unless fields.nil?
|
|
162
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
163
|
+
execute_or_queue_command(command, &block)
|
|
164
|
+
end
|
|
165
|
+
|
|
166
|
+
# Bulk import of multiple Documents. Request processing may be synchronous. Non-
|
|
167
|
+
# existing items will be created. Note: It is possible for a subset of the
|
|
168
|
+
# Documents to be successfully updated.
|
|
169
|
+
# @param [String] parent
|
|
170
|
+
# Required. The parent branch resource name, such as `projects/`project`/
|
|
171
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
|
172
|
+
# `branch``. Requires create/update permission.
|
|
173
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportDocumentsRequest] google_cloud_discoveryengine_v1beta_import_documents_request_object
|
|
174
|
+
# @param [String] fields
|
|
175
|
+
# Selector specifying which fields to include in a partial response.
|
|
176
|
+
# @param [String] quota_user
|
|
177
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
178
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
179
|
+
# @param [Google::Apis::RequestOptions] options
|
|
180
|
+
# Request-specific options
|
|
181
|
+
#
|
|
182
|
+
# @yield [result, err] Result & error if block supplied
|
|
183
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
|
184
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
185
|
+
#
|
|
186
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
|
187
|
+
#
|
|
188
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
189
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
190
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
191
|
+
def import_project_location_collection_data_store_branch_document(parent, google_cloud_discoveryengine_v1beta_import_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
192
|
+
command = make_simple_command(:post, 'v1beta/{+parent}/documents:import', options)
|
|
193
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportDocumentsRequest::Representation
|
|
194
|
+
command.request_object = google_cloud_discoveryengine_v1beta_import_documents_request_object
|
|
195
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
|
196
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
|
197
|
+
command.params['parent'] = parent unless parent.nil?
|
|
198
|
+
command.query['fields'] = fields unless fields.nil?
|
|
199
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
200
|
+
execute_or_queue_command(command, &block)
|
|
201
|
+
end
|
|
202
|
+
|
|
203
|
+
# Gets a list of Documents.
|
|
204
|
+
# @param [String] parent
|
|
205
|
+
# Required. The parent branch resource name, such as `projects/`project`/
|
|
206
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
|
207
|
+
# `branch``. Use `default_branch` as the branch ID, to list documents under the
|
|
208
|
+
# default branch. If the caller does not have permission to list Documentss
|
|
209
|
+
# under this branch, regardless of whether or not this branch exists, a
|
|
210
|
+
# PERMISSION_DENIED error is returned.
|
|
211
|
+
# @param [Fixnum] page_size
|
|
212
|
+
# Maximum number of Documents to return. If unspecified, defaults to 100. The
|
|
213
|
+
# maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If
|
|
214
|
+
# this field is negative, an INVALID_ARGUMENT error is returned.
|
|
215
|
+
# @param [String] page_token
|
|
216
|
+
# A page token ListDocumentsResponse.next_page_token, received from a previous
|
|
217
|
+
# DocumentService.ListDocuments call. Provide this to retrieve the subsequent
|
|
218
|
+
# page. When paginating, all other parameters provided to DocumentService.
|
|
219
|
+
# ListDocuments must match the call that provided the page token. Otherwise, an
|
|
220
|
+
# INVALID_ARGUMENT error is returned.
|
|
221
|
+
# @param [String] fields
|
|
222
|
+
# Selector specifying which fields to include in a partial response.
|
|
223
|
+
# @param [String] quota_user
|
|
224
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
225
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
226
|
+
# @param [Google::Apis::RequestOptions] options
|
|
227
|
+
# Request-specific options
|
|
228
|
+
#
|
|
229
|
+
# @yield [result, err] Result & error if block supplied
|
|
230
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListDocumentsResponse] parsed result object
|
|
231
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
232
|
+
#
|
|
233
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListDocumentsResponse]
|
|
234
|
+
#
|
|
235
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
236
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
237
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
238
|
+
def list_project_location_collection_data_store_branch_documents(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
239
|
+
command = make_simple_command(:get, 'v1beta/{+parent}/documents', options)
|
|
240
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListDocumentsResponse::Representation
|
|
241
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListDocumentsResponse
|
|
242
|
+
command.params['parent'] = parent unless parent.nil?
|
|
243
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
244
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
245
|
+
command.query['fields'] = fields unless fields.nil?
|
|
246
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
247
|
+
execute_or_queue_command(command, &block)
|
|
248
|
+
end
|
|
249
|
+
|
|
250
|
+
# Updates a Document.
|
|
251
|
+
# @param [String] name
|
|
252
|
+
# Immutable. The full resource name of the document. Format: `projects/`project`/
|
|
253
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
|
254
|
+
# `branch`/documents/`document_id``. This field must be a UTF-8 encoded string
|
|
255
|
+
# with a length limit of 1024 characters.
|
|
256
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument] google_cloud_discoveryengine_v1beta_document_object
|
|
257
|
+
# @param [Boolean] allow_missing
|
|
258
|
+
# If set to true, and the Document is not found, a new Document will be created.
|
|
259
|
+
# @param [String] fields
|
|
260
|
+
# Selector specifying which fields to include in a partial response.
|
|
261
|
+
# @param [String] quota_user
|
|
262
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
263
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
264
|
+
# @param [Google::Apis::RequestOptions] options
|
|
265
|
+
# Request-specific options
|
|
266
|
+
#
|
|
267
|
+
# @yield [result, err] Result & error if block supplied
|
|
268
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument] parsed result object
|
|
269
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
270
|
+
#
|
|
271
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument]
|
|
272
|
+
#
|
|
273
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
274
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
275
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
276
|
+
def patch_project_location_collection_data_store_branch_document(name, google_cloud_discoveryengine_v1beta_document_object = nil, allow_missing: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
277
|
+
command = make_simple_command(:patch, 'v1beta/{+name}', options)
|
|
278
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument::Representation
|
|
279
|
+
command.request_object = google_cloud_discoveryengine_v1beta_document_object
|
|
280
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument::Representation
|
|
281
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument
|
|
282
|
+
command.params['name'] = name unless name.nil?
|
|
283
|
+
command.query['allowMissing'] = allow_missing unless allow_missing.nil?
|
|
284
|
+
command.query['fields'] = fields unless fields.nil?
|
|
285
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
286
|
+
execute_or_queue_command(command, &block)
|
|
287
|
+
end
|
|
288
|
+
|
|
289
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
|
290
|
+
# to poll the operation result at intervals as recommended by the API service.
|
|
291
|
+
# @param [String] name
|
|
292
|
+
# The name of the operation resource.
|
|
293
|
+
# @param [String] fields
|
|
294
|
+
# Selector specifying which fields to include in a partial response.
|
|
295
|
+
# @param [String] quota_user
|
|
296
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
297
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
298
|
+
# @param [Google::Apis::RequestOptions] options
|
|
299
|
+
# Request-specific options
|
|
300
|
+
#
|
|
301
|
+
# @yield [result, err] Result & error if block supplied
|
|
302
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
|
303
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
304
|
+
#
|
|
305
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
|
306
|
+
#
|
|
307
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
308
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
309
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
310
|
+
def get_project_location_collection_data_store_branch_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
311
|
+
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
|
312
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
|
313
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
|
314
|
+
command.params['name'] = name unless name.nil?
|
|
315
|
+
command.query['fields'] = fields unless fields.nil?
|
|
316
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
317
|
+
execute_or_queue_command(command, &block)
|
|
318
|
+
end
|
|
319
|
+
|
|
320
|
+
# Lists operations that match the specified filter in the request. If the server
|
|
321
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`.
|
|
322
|
+
# @param [String] name
|
|
323
|
+
# The name of the operation's parent resource.
|
|
324
|
+
# @param [String] filter
|
|
325
|
+
# The standard list filter.
|
|
326
|
+
# @param [Fixnum] page_size
|
|
327
|
+
# The standard list page size.
|
|
328
|
+
# @param [String] page_token
|
|
329
|
+
# The standard list page token.
|
|
330
|
+
# @param [String] fields
|
|
331
|
+
# Selector specifying which fields to include in a partial response.
|
|
332
|
+
# @param [String] quota_user
|
|
333
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
334
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
335
|
+
# @param [Google::Apis::RequestOptions] options
|
|
336
|
+
# Request-specific options
|
|
337
|
+
#
|
|
338
|
+
# @yield [result, err] Result & error if block supplied
|
|
339
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse] parsed result object
|
|
340
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
341
|
+
#
|
|
342
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse]
|
|
343
|
+
#
|
|
344
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
345
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
346
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
347
|
+
def list_project_location_collection_data_store_branch_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
348
|
+
command = make_simple_command(:get, 'v1beta/{+name}/operations', options)
|
|
349
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse::Representation
|
|
350
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse
|
|
351
|
+
command.params['name'] = name unless name.nil?
|
|
352
|
+
command.query['filter'] = filter unless filter.nil?
|
|
353
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
354
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
355
|
+
command.query['fields'] = fields unless fields.nil?
|
|
356
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
357
|
+
execute_or_queue_command(command, &block)
|
|
358
|
+
end
|
|
359
|
+
|
|
360
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
|
361
|
+
# to poll the operation result at intervals as recommended by the API service.
|
|
362
|
+
# @param [String] name
|
|
363
|
+
# The name of the operation resource.
|
|
364
|
+
# @param [String] fields
|
|
365
|
+
# Selector specifying which fields to include in a partial response.
|
|
366
|
+
# @param [String] quota_user
|
|
367
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
368
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
369
|
+
# @param [Google::Apis::RequestOptions] options
|
|
370
|
+
# Request-specific options
|
|
371
|
+
#
|
|
372
|
+
# @yield [result, err] Result & error if block supplied
|
|
373
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
|
374
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
375
|
+
#
|
|
376
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
|
377
|
+
#
|
|
378
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
379
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
380
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
381
|
+
def get_project_location_collection_data_store_model_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
382
|
+
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
|
383
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
|
384
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
|
385
|
+
command.params['name'] = name unless name.nil?
|
|
386
|
+
command.query['fields'] = fields unless fields.nil?
|
|
387
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
388
|
+
execute_or_queue_command(command, &block)
|
|
389
|
+
end
|
|
390
|
+
|
|
391
|
+
# Lists operations that match the specified filter in the request. If the server
|
|
392
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`.
|
|
393
|
+
# @param [String] name
|
|
394
|
+
# The name of the operation's parent resource.
|
|
395
|
+
# @param [String] filter
|
|
396
|
+
# The standard list filter.
|
|
397
|
+
# @param [Fixnum] page_size
|
|
398
|
+
# The standard list page size.
|
|
399
|
+
# @param [String] page_token
|
|
400
|
+
# The standard list page token.
|
|
401
|
+
# @param [String] fields
|
|
402
|
+
# Selector specifying which fields to include in a partial response.
|
|
403
|
+
# @param [String] quota_user
|
|
404
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
405
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
406
|
+
# @param [Google::Apis::RequestOptions] options
|
|
407
|
+
# Request-specific options
|
|
408
|
+
#
|
|
409
|
+
# @yield [result, err] Result & error if block supplied
|
|
410
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse] parsed result object
|
|
411
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
412
|
+
#
|
|
413
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse]
|
|
414
|
+
#
|
|
415
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
416
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
417
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
418
|
+
def list_project_location_collection_data_store_model_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
419
|
+
command = make_simple_command(:get, 'v1beta/{+name}/operations', options)
|
|
420
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse::Representation
|
|
421
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse
|
|
422
|
+
command.params['name'] = name unless name.nil?
|
|
423
|
+
command.query['filter'] = filter unless filter.nil?
|
|
424
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
425
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
426
|
+
command.query['fields'] = fields unless fields.nil?
|
|
427
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
428
|
+
execute_or_queue_command(command, &block)
|
|
429
|
+
end
|
|
430
|
+
|
|
431
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
|
432
|
+
# to poll the operation result at intervals as recommended by the API service.
|
|
433
|
+
# @param [String] name
|
|
434
|
+
# The name of the operation resource.
|
|
435
|
+
# @param [String] fields
|
|
436
|
+
# Selector specifying which fields to include in a partial response.
|
|
437
|
+
# @param [String] quota_user
|
|
438
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
439
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
440
|
+
# @param [Google::Apis::RequestOptions] options
|
|
441
|
+
# Request-specific options
|
|
442
|
+
#
|
|
443
|
+
# @yield [result, err] Result & error if block supplied
|
|
444
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
|
445
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
446
|
+
#
|
|
447
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
|
448
|
+
#
|
|
449
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
450
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
451
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
452
|
+
def get_project_location_collection_data_store_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
453
|
+
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
|
454
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
|
455
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
|
456
|
+
command.params['name'] = name unless name.nil?
|
|
457
|
+
command.query['fields'] = fields unless fields.nil?
|
|
458
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
459
|
+
execute_or_queue_command(command, &block)
|
|
460
|
+
end
|
|
461
|
+
|
|
462
|
+
# Lists operations that match the specified filter in the request. If the server
|
|
463
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`.
|
|
464
|
+
# @param [String] name
|
|
465
|
+
# The name of the operation's parent resource.
|
|
466
|
+
# @param [String] filter
|
|
467
|
+
# The standard list filter.
|
|
468
|
+
# @param [Fixnum] page_size
|
|
469
|
+
# The standard list page size.
|
|
470
|
+
# @param [String] page_token
|
|
471
|
+
# The standard list page token.
|
|
472
|
+
# @param [String] fields
|
|
473
|
+
# Selector specifying which fields to include in a partial response.
|
|
474
|
+
# @param [String] quota_user
|
|
475
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
476
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
477
|
+
# @param [Google::Apis::RequestOptions] options
|
|
478
|
+
# Request-specific options
|
|
479
|
+
#
|
|
480
|
+
# @yield [result, err] Result & error if block supplied
|
|
481
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse] parsed result object
|
|
482
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
483
|
+
#
|
|
484
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse]
|
|
485
|
+
#
|
|
486
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
487
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
488
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
489
|
+
def list_project_location_collection_data_store_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
490
|
+
command = make_simple_command(:get, 'v1beta/{+name}/operations', options)
|
|
491
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse::Representation
|
|
492
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse
|
|
493
|
+
command.params['name'] = name unless name.nil?
|
|
494
|
+
command.query['filter'] = filter unless filter.nil?
|
|
495
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
496
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
497
|
+
command.query['fields'] = fields unless fields.nil?
|
|
498
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
499
|
+
execute_or_queue_command(command, &block)
|
|
500
|
+
end
|
|
501
|
+
|
|
502
|
+
# Makes a recommendation, which requires a contextual user event.
|
|
503
|
+
# @param [String] serving_config
|
|
504
|
+
# Required. Full resource name of the format: projects/*/locations/global/
|
|
505
|
+
# collections/*/dataStores/*/servingConfigs/* Before you can request
|
|
506
|
+
# recommendations from your model, you must create at least one serving config
|
|
507
|
+
# for it.
|
|
508
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendRequest] google_cloud_discoveryengine_v1beta_recommend_request_object
|
|
509
|
+
# @param [String] fields
|
|
510
|
+
# Selector specifying which fields to include in a partial response.
|
|
511
|
+
# @param [String] quota_user
|
|
512
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
513
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
514
|
+
# @param [Google::Apis::RequestOptions] options
|
|
515
|
+
# Request-specific options
|
|
516
|
+
#
|
|
517
|
+
# @yield [result, err] Result & error if block supplied
|
|
518
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendResponse] parsed result object
|
|
519
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
520
|
+
#
|
|
521
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendResponse]
|
|
522
|
+
#
|
|
523
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
524
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
525
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
526
|
+
def recommend_project_location_collection_data_store_serving_config(serving_config, google_cloud_discoveryengine_v1beta_recommend_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
527
|
+
command = make_simple_command(:post, 'v1beta/{+servingConfig}:recommend', options)
|
|
528
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendRequest::Representation
|
|
529
|
+
command.request_object = google_cloud_discoveryengine_v1beta_recommend_request_object
|
|
530
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendResponse::Representation
|
|
531
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendResponse
|
|
532
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
|
533
|
+
command.query['fields'] = fields unless fields.nil?
|
|
534
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
535
|
+
execute_or_queue_command(command, &block)
|
|
536
|
+
end
|
|
537
|
+
|
|
538
|
+
# Writes a single user event from the browser. This uses a GET request to due to
|
|
539
|
+
# browser restriction of POST-ing to a 3rd party domain. This method is used
|
|
540
|
+
# only by the Discovery Engine API JavaScript pixel and Google Tag Manager.
|
|
541
|
+
# Users should not call this method directly.
|
|
542
|
+
# @param [String] parent
|
|
543
|
+
# Required. The parent DataStore resource name, such as `projects/`project`/
|
|
544
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store``.
|
|
545
|
+
# @param [Fixnum] ets
|
|
546
|
+
# The event timestamp in milliseconds. This prevents browser caching of
|
|
547
|
+
# otherwise identical get requests. The name is abbreviated to reduce the
|
|
548
|
+
# payload bytes.
|
|
549
|
+
# @param [String] uri
|
|
550
|
+
# The URL including cgi-parameters but excluding the hash fragment with a length
|
|
551
|
+
# limit of 5,000 characters. This is often more useful than the referer URL,
|
|
552
|
+
# because many browsers only send the domain for 3rd party requests.
|
|
553
|
+
# @param [String] user_event
|
|
554
|
+
# Required. URL encoded UserEvent proto with a length limit of 2,000,000
|
|
555
|
+
# characters.
|
|
556
|
+
# @param [String] fields
|
|
557
|
+
# Selector specifying which fields to include in a partial response.
|
|
558
|
+
# @param [String] quota_user
|
|
559
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
560
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
561
|
+
# @param [Google::Apis::RequestOptions] options
|
|
562
|
+
# Request-specific options
|
|
563
|
+
#
|
|
564
|
+
# @yield [result, err] Result & error if block supplied
|
|
565
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleApiHttpBody] parsed result object
|
|
566
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
567
|
+
#
|
|
568
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleApiHttpBody]
|
|
569
|
+
#
|
|
570
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
571
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
572
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
573
|
+
def collect_project_location_collection_data_store_user_event(parent, ets: nil, uri: nil, user_event: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
574
|
+
command = make_simple_command(:get, 'v1beta/{+parent}/userEvents:collect', options)
|
|
575
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleApiHttpBody::Representation
|
|
576
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleApiHttpBody
|
|
577
|
+
command.params['parent'] = parent unless parent.nil?
|
|
578
|
+
command.query['ets'] = ets unless ets.nil?
|
|
579
|
+
command.query['uri'] = uri unless uri.nil?
|
|
580
|
+
command.query['userEvent'] = user_event unless user_event.nil?
|
|
581
|
+
command.query['fields'] = fields unless fields.nil?
|
|
582
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
583
|
+
execute_or_queue_command(command, &block)
|
|
584
|
+
end
|
|
585
|
+
|
|
586
|
+
# Bulk import of User events. Request processing might be synchronous. Events
|
|
587
|
+
# that already exist are skipped. Use this method for backfilling historical
|
|
588
|
+
# user events. Operation.response is of type ImportResponse. Note that it is
|
|
589
|
+
# possible for a subset of the items to be successfully inserted. Operation.
|
|
590
|
+
# metadata is of type ImportMetadata.
|
|
591
|
+
# @param [String] parent
|
|
592
|
+
# Required. Parent DataStore resource name, of the form `projects/`project`/
|
|
593
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store``
|
|
594
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportUserEventsRequest] google_cloud_discoveryengine_v1beta_import_user_events_request_object
|
|
595
|
+
# @param [String] fields
|
|
596
|
+
# Selector specifying which fields to include in a partial response.
|
|
597
|
+
# @param [String] quota_user
|
|
598
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
599
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
600
|
+
# @param [Google::Apis::RequestOptions] options
|
|
601
|
+
# Request-specific options
|
|
602
|
+
#
|
|
603
|
+
# @yield [result, err] Result & error if block supplied
|
|
604
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
|
605
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
606
|
+
#
|
|
607
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
|
608
|
+
#
|
|
609
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
610
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
611
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
612
|
+
def import_project_location_collection_data_store_user_event(parent, google_cloud_discoveryengine_v1beta_import_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
613
|
+
command = make_simple_command(:post, 'v1beta/{+parent}/userEvents:import', options)
|
|
614
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportUserEventsRequest::Representation
|
|
615
|
+
command.request_object = google_cloud_discoveryengine_v1beta_import_user_events_request_object
|
|
616
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
|
617
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
|
618
|
+
command.params['parent'] = parent unless parent.nil?
|
|
619
|
+
command.query['fields'] = fields unless fields.nil?
|
|
620
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
621
|
+
execute_or_queue_command(command, &block)
|
|
622
|
+
end
|
|
623
|
+
|
|
624
|
+
# Writes a single user event.
|
|
625
|
+
# @param [String] parent
|
|
626
|
+
# Required. The parent DataStore resource name, such as `projects/`project`/
|
|
627
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store``.
|
|
628
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent] google_cloud_discoveryengine_v1beta_user_event_object
|
|
629
|
+
# @param [String] fields
|
|
630
|
+
# Selector specifying which fields to include in a partial response.
|
|
631
|
+
# @param [String] quota_user
|
|
632
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
633
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
634
|
+
# @param [Google::Apis::RequestOptions] options
|
|
635
|
+
# Request-specific options
|
|
636
|
+
#
|
|
637
|
+
# @yield [result, err] Result & error if block supplied
|
|
638
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent] parsed result object
|
|
639
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
640
|
+
#
|
|
641
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent]
|
|
642
|
+
#
|
|
643
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
644
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
645
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
646
|
+
def write_project_location_collection_data_store_user_event(parent, google_cloud_discoveryengine_v1beta_user_event_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
647
|
+
command = make_simple_command(:post, 'v1beta/{+parent}/userEvents:write', options)
|
|
648
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent::Representation
|
|
649
|
+
command.request_object = google_cloud_discoveryengine_v1beta_user_event_object
|
|
650
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent::Representation
|
|
651
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent
|
|
652
|
+
command.params['parent'] = parent unless parent.nil?
|
|
653
|
+
command.query['fields'] = fields unless fields.nil?
|
|
654
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
655
|
+
execute_or_queue_command(command, &block)
|
|
656
|
+
end
|
|
657
|
+
|
|
658
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
|
659
|
+
# to poll the operation result at intervals as recommended by the API service.
|
|
660
|
+
# @param [String] name
|
|
661
|
+
# The name of the operation resource.
|
|
662
|
+
# @param [String] fields
|
|
663
|
+
# Selector specifying which fields to include in a partial response.
|
|
664
|
+
# @param [String] quota_user
|
|
665
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
666
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
667
|
+
# @param [Google::Apis::RequestOptions] options
|
|
668
|
+
# Request-specific options
|
|
669
|
+
#
|
|
670
|
+
# @yield [result, err] Result & error if block supplied
|
|
671
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
|
672
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
673
|
+
#
|
|
674
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
|
675
|
+
#
|
|
676
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
677
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
678
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
679
|
+
def get_project_location_collection_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
680
|
+
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
|
681
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
|
682
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
|
683
|
+
command.params['name'] = name unless name.nil?
|
|
684
|
+
command.query['fields'] = fields unless fields.nil?
|
|
685
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
686
|
+
execute_or_queue_command(command, &block)
|
|
687
|
+
end
|
|
688
|
+
|
|
689
|
+
# Lists operations that match the specified filter in the request. If the server
|
|
690
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`.
|
|
691
|
+
# @param [String] name
|
|
692
|
+
# The name of the operation's parent resource.
|
|
693
|
+
# @param [String] filter
|
|
694
|
+
# The standard list filter.
|
|
695
|
+
# @param [Fixnum] page_size
|
|
696
|
+
# The standard list page size.
|
|
697
|
+
# @param [String] page_token
|
|
698
|
+
# The standard list page token.
|
|
699
|
+
# @param [String] fields
|
|
700
|
+
# Selector specifying which fields to include in a partial response.
|
|
701
|
+
# @param [String] quota_user
|
|
702
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
703
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
704
|
+
# @param [Google::Apis::RequestOptions] options
|
|
705
|
+
# Request-specific options
|
|
706
|
+
#
|
|
707
|
+
# @yield [result, err] Result & error if block supplied
|
|
708
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse] parsed result object
|
|
709
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
710
|
+
#
|
|
711
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse]
|
|
712
|
+
#
|
|
713
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
714
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
715
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
716
|
+
def list_project_location_collection_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
717
|
+
command = make_simple_command(:get, 'v1beta/{+name}/operations', options)
|
|
718
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse::Representation
|
|
719
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse
|
|
720
|
+
command.params['name'] = name unless name.nil?
|
|
721
|
+
command.query['filter'] = filter unless filter.nil?
|
|
722
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
723
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
724
|
+
command.query['fields'] = fields unless fields.nil?
|
|
725
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
726
|
+
execute_or_queue_command(command, &block)
|
|
727
|
+
end
|
|
728
|
+
|
|
729
|
+
# Creates a Document.
|
|
730
|
+
# @param [String] parent
|
|
731
|
+
# Required. The parent resource name, such as `projects/`project`/locations/`
|
|
732
|
+
# location`/collections/`collection`/dataStores/`data_store`/branches/`branch``.
|
|
56
733
|
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument] google_cloud_discoveryengine_v1beta_document_object
|
|
57
734
|
# @param [String] document_id
|
|
58
735
|
# Required. The ID to use for the Document, which will become the final
|
|
@@ -96,10 +773,11 @@ module Google
|
|
|
96
773
|
# Deletes a Document.
|
|
97
774
|
# @param [String] name
|
|
98
775
|
# Required. Full resource name of Document, such as `projects/`project`/
|
|
99
|
-
# locations/`location`/dataStores/`data_store`/branches
|
|
100
|
-
# document``. If the caller does not have permission to
|
|
101
|
-
# regardless of whether or not it exists, a
|
|
102
|
-
# If the Document to delete does not exist,
|
|
776
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
|
777
|
+
# `branch`/documents/`document``. If the caller does not have permission to
|
|
778
|
+
# delete the Document, regardless of whether or not it exists, a
|
|
779
|
+
# PERMISSION_DENIED error is returned. If the Document to delete does not exist,
|
|
780
|
+
# a NOT_FOUND error is returned.
|
|
103
781
|
# @param [String] fields
|
|
104
782
|
# Selector specifying which fields to include in a partial response.
|
|
105
783
|
# @param [String] quota_user
|
|
@@ -130,10 +808,11 @@ module Google
|
|
|
130
808
|
# Gets a Document.
|
|
131
809
|
# @param [String] name
|
|
132
810
|
# Required. Full resource name of Document, such as `projects/`project`/
|
|
133
|
-
# locations/`location`/dataStores/`data_store`/branches
|
|
134
|
-
# document``. If the caller does not have permission to
|
|
135
|
-
# regardless of whether or not it exists, a
|
|
136
|
-
# If the requested Document does not exist,
|
|
811
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
|
812
|
+
# `branch`/documents/`document``. If the caller does not have permission to
|
|
813
|
+
# access the Document, regardless of whether or not it exists, a
|
|
814
|
+
# PERMISSION_DENIED error is returned. If the requested Document does not exist,
|
|
815
|
+
# a NOT_FOUND error is returned.
|
|
137
816
|
# @param [String] fields
|
|
138
817
|
# Selector specifying which fields to include in a partial response.
|
|
139
818
|
# @param [String] quota_user
|
|
@@ -166,8 +845,8 @@ module Google
|
|
|
166
845
|
# Documents to be successfully updated.
|
|
167
846
|
# @param [String] parent
|
|
168
847
|
# Required. The parent branch resource name, such as `projects/`project`/
|
|
169
|
-
# locations/`location`/dataStores/`data_store`/branches
|
|
170
|
-
# create/update permission.
|
|
848
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
|
849
|
+
# `branch``. Requires create/update permission.
|
|
171
850
|
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportDocumentsRequest] google_cloud_discoveryengine_v1beta_import_documents_request_object
|
|
172
851
|
# @param [String] fields
|
|
173
852
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -201,11 +880,11 @@ module Google
|
|
|
201
880
|
# Gets a list of Documents.
|
|
202
881
|
# @param [String] parent
|
|
203
882
|
# Required. The parent branch resource name, such as `projects/`project`/
|
|
204
|
-
# locations/`location`/dataStores/`data_store`/branches
|
|
205
|
-
# default_branch` as the branch ID, to list documents under the
|
|
206
|
-
# If the caller does not have permission to list Documentss
|
|
207
|
-
# regardless of whether or not this branch exists, a
|
|
208
|
-
# returned.
|
|
883
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
|
884
|
+
# `branch``. Use `default_branch` as the branch ID, to list documents under the
|
|
885
|
+
# default branch. If the caller does not have permission to list Documentss
|
|
886
|
+
# under this branch, regardless of whether or not this branch exists, a
|
|
887
|
+
# PERMISSION_DENIED error is returned.
|
|
209
888
|
# @param [Fixnum] page_size
|
|
210
889
|
# Maximum number of Documents to return. If unspecified, defaults to 100. The
|
|
211
890
|
# maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If
|
|
@@ -248,9 +927,9 @@ module Google
|
|
|
248
927
|
# Updates a Document.
|
|
249
928
|
# @param [String] name
|
|
250
929
|
# Immutable. The full resource name of the document. Format: `projects/`project`/
|
|
251
|
-
# locations/`location`/dataStores/`data_store`/branches
|
|
252
|
-
# document_id``. This field must be a UTF-8 encoded string
|
|
253
|
-
# of 1024 characters.
|
|
930
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
|
931
|
+
# `branch`/documents/`document_id``. This field must be a UTF-8 encoded string
|
|
932
|
+
# with a length limit of 1024 characters.
|
|
254
933
|
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument] google_cloud_discoveryengine_v1beta_document_object
|
|
255
934
|
# @param [Boolean] allow_missing
|
|
256
935
|
# If set to true, and the Document is not found, a new Document will be created.
|
|
@@ -316,13 +995,7 @@ module Google
|
|
|
316
995
|
end
|
|
317
996
|
|
|
318
997
|
# Lists operations that match the specified filter in the request. If the server
|
|
319
|
-
# doesn't support this method, it returns `UNIMPLEMENTED`.
|
|
320
|
-
# binding allows API services to override the binding to use different resource
|
|
321
|
-
# name schemes, such as `users/*/operations`. To override the binding, API
|
|
322
|
-
# services can add a binding such as `"/v1/`name=users/*`/operations"` to their
|
|
323
|
-
# service configuration. For backwards compatibility, the default name includes
|
|
324
|
-
# the operations collection id, however overriding users must ensure the name
|
|
325
|
-
# binding is the parent resource, without the operations collection id.
|
|
998
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`.
|
|
326
999
|
# @param [String] name
|
|
327
1000
|
# The name of the operation's parent resource.
|
|
328
1001
|
# @param [String] filter
|
|
@@ -393,13 +1066,7 @@ module Google
|
|
|
393
1066
|
end
|
|
394
1067
|
|
|
395
1068
|
# Lists operations that match the specified filter in the request. If the server
|
|
396
|
-
# doesn't support this method, it returns `UNIMPLEMENTED`.
|
|
397
|
-
# binding allows API services to override the binding to use different resource
|
|
398
|
-
# name schemes, such as `users/*/operations`. To override the binding, API
|
|
399
|
-
# services can add a binding such as `"/v1/`name=users/*`/operations"` to their
|
|
400
|
-
# service configuration. For backwards compatibility, the default name includes
|
|
401
|
-
# the operations collection id, however overriding users must ensure the name
|
|
402
|
-
# binding is the parent resource, without the operations collection id.
|
|
1069
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`.
|
|
403
1070
|
# @param [String] name
|
|
404
1071
|
# The name of the operation's parent resource.
|
|
405
1072
|
# @param [String] filter
|
|
@@ -470,13 +1137,7 @@ module Google
|
|
|
470
1137
|
end
|
|
471
1138
|
|
|
472
1139
|
# Lists operations that match the specified filter in the request. If the server
|
|
473
|
-
# doesn't support this method, it returns `UNIMPLEMENTED`.
|
|
474
|
-
# binding allows API services to override the binding to use different resource
|
|
475
|
-
# name schemes, such as `users/*/operations`. To override the binding, API
|
|
476
|
-
# services can add a binding such as `"/v1/`name=users/*`/operations"` to their
|
|
477
|
-
# service configuration. For backwards compatibility, the default name includes
|
|
478
|
-
# the operations collection id, however overriding users must ensure the name
|
|
479
|
-
# binding is the parent resource, without the operations collection id.
|
|
1140
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`.
|
|
480
1141
|
# @param [String] name
|
|
481
1142
|
# The name of the operation's parent resource.
|
|
482
1143
|
# @param [String] filter
|
|
@@ -518,8 +1179,9 @@ module Google
|
|
|
518
1179
|
# Makes a recommendation, which requires a contextual user event.
|
|
519
1180
|
# @param [String] serving_config
|
|
520
1181
|
# Required. Full resource name of the format: projects/*/locations/global/
|
|
521
|
-
# dataStores/*/servingConfigs/* Before you can request
|
|
522
|
-
# model, you must create at least one serving config
|
|
1182
|
+
# collections/*/dataStores/*/servingConfigs/* Before you can request
|
|
1183
|
+
# recommendations from your model, you must create at least one serving config
|
|
1184
|
+
# for it.
|
|
523
1185
|
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendRequest] google_cloud_discoveryengine_v1beta_recommend_request_object
|
|
524
1186
|
# @param [String] fields
|
|
525
1187
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -556,7 +1218,7 @@ module Google
|
|
|
556
1218
|
# Users should not call this method directly.
|
|
557
1219
|
# @param [String] parent
|
|
558
1220
|
# Required. The parent DataStore resource name, such as `projects/`project`/
|
|
559
|
-
# locations/`location`/dataStores/`data_store``.
|
|
1221
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store``.
|
|
560
1222
|
# @param [Fixnum] ets
|
|
561
1223
|
# The event timestamp in milliseconds. This prevents browser caching of
|
|
562
1224
|
# otherwise identical get requests. The name is abbreviated to reduce the
|
|
@@ -605,7 +1267,7 @@ module Google
|
|
|
605
1267
|
# metadata is of type ImportMetadata.
|
|
606
1268
|
# @param [String] parent
|
|
607
1269
|
# Required. Parent DataStore resource name, of the form `projects/`project`/
|
|
608
|
-
# locations/`location`/dataStores/`data_store``
|
|
1270
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store``
|
|
609
1271
|
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportUserEventsRequest] google_cloud_discoveryengine_v1beta_import_user_events_request_object
|
|
610
1272
|
# @param [String] fields
|
|
611
1273
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -639,7 +1301,7 @@ module Google
|
|
|
639
1301
|
# Writes a single user event.
|
|
640
1302
|
# @param [String] parent
|
|
641
1303
|
# Required. The parent DataStore resource name, such as `projects/`project`/
|
|
642
|
-
# locations/`location`/dataStores/`data_store``.
|
|
1304
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store``.
|
|
643
1305
|
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent] google_cloud_discoveryengine_v1beta_user_event_object
|
|
644
1306
|
# @param [String] fields
|
|
645
1307
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -702,13 +1364,7 @@ module Google
|
|
|
702
1364
|
end
|
|
703
1365
|
|
|
704
1366
|
# Lists operations that match the specified filter in the request. If the server
|
|
705
|
-
# doesn't support this method, it returns `UNIMPLEMENTED`.
|
|
706
|
-
# binding allows API services to override the binding to use different resource
|
|
707
|
-
# name schemes, such as `users/*/operations`. To override the binding, API
|
|
708
|
-
# services can add a binding such as `"/v1/`name=users/*`/operations"` to their
|
|
709
|
-
# service configuration. For backwards compatibility, the default name includes
|
|
710
|
-
# the operations collection id, however overriding users must ensure the name
|
|
711
|
-
# binding is the parent resource, without the operations collection id.
|
|
1367
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`.
|
|
712
1368
|
# @param [String] name
|
|
713
1369
|
# The name of the operation's parent resource.
|
|
714
1370
|
# @param [String] filter
|
|
@@ -779,13 +1435,7 @@ module Google
|
|
|
779
1435
|
end
|
|
780
1436
|
|
|
781
1437
|
# Lists operations that match the specified filter in the request. If the server
|
|
782
|
-
# doesn't support this method, it returns `UNIMPLEMENTED`.
|
|
783
|
-
# binding allows API services to override the binding to use different resource
|
|
784
|
-
# name schemes, such as `users/*/operations`. To override the binding, API
|
|
785
|
-
# services can add a binding such as `"/v1/`name=users/*`/operations"` to their
|
|
786
|
-
# service configuration. For backwards compatibility, the default name includes
|
|
787
|
-
# the operations collection id, however overriding users must ensure the name
|
|
788
|
-
# binding is the parent resource, without the operations collection id.
|
|
1438
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`.
|
|
789
1439
|
# @param [String] name
|
|
790
1440
|
# The name of the operation's parent resource.
|
|
791
1441
|
# @param [String] filter
|