google-apis-discoveryengine_v1alpha 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.yardopts +13 -0
- data/CHANGELOG.md +7 -0
- data/LICENSE.md +202 -0
- data/OVERVIEW.md +96 -0
- data/lib/google/apis/discoveryengine_v1alpha/classes.rb +1614 -0
- data/lib/google/apis/discoveryengine_v1alpha/gem_version.rb +28 -0
- data/lib/google/apis/discoveryengine_v1alpha/representations.rb +637 -0
- data/lib/google/apis/discoveryengine_v1alpha/service.rb +836 -0
- data/lib/google/apis/discoveryengine_v1alpha.rb +36 -0
- data/lib/google-apis-discoveryengine_v1alpha.rb +15 -0
- metadata +82 -0
@@ -0,0 +1,836 @@
|
|
1
|
+
# Copyright 2020 Google LLC
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require 'google/apis/core/base_service'
|
16
|
+
require 'google/apis/core/json_representation'
|
17
|
+
require 'google/apis/core/hashable'
|
18
|
+
require 'google/apis/errors'
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Apis
|
22
|
+
module DiscoveryengineV1alpha
|
23
|
+
# Discovery Engine API
|
24
|
+
#
|
25
|
+
# Discovery Engine API.
|
26
|
+
#
|
27
|
+
# @example
|
28
|
+
# require 'google/apis/discoveryengine_v1alpha'
|
29
|
+
#
|
30
|
+
# Discoveryengine = Google::Apis::DiscoveryengineV1alpha # Alias the module
|
31
|
+
# service = Discoveryengine::DiscoveryEngineService.new
|
32
|
+
#
|
33
|
+
# @see https://cloud.google.com/discovery-engine/docs
|
34
|
+
class DiscoveryEngineService < Google::Apis::Core::BaseService
|
35
|
+
# @return [String]
|
36
|
+
# API key. Your API key identifies your project and provides you with API access,
|
37
|
+
# quota, and reports. Required unless you provide an OAuth 2.0 token.
|
38
|
+
attr_accessor :key
|
39
|
+
|
40
|
+
# @return [String]
|
41
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
42
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
43
|
+
attr_accessor :quota_user
|
44
|
+
|
45
|
+
def initialize
|
46
|
+
super('https://discoveryengine.googleapis.com/', '',
|
47
|
+
client_name: 'google-apis-discoveryengine_v1alpha',
|
48
|
+
client_version: Google::Apis::DiscoveryengineV1alpha::GEM_VERSION)
|
49
|
+
@batch_path = 'batch'
|
50
|
+
end
|
51
|
+
|
52
|
+
# Creates a Document.
|
53
|
+
# @param [String] parent
|
54
|
+
# Required. The parent resource name, such as `projects/`project`/locations/`
|
55
|
+
# location`/dataStores/`data_store`/branches/`branch``.
|
56
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument] google_cloud_discoveryengine_v1alpha_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::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument] parsed result object
|
76
|
+
# @yieldparam err [StandardError] error object if request failed
|
77
|
+
#
|
78
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument]
|
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_data_store_branch_document(parent, google_cloud_discoveryengine_v1alpha_document_object = nil, document_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
84
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/documents', options)
|
85
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument::Representation
|
86
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_document_object
|
87
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument::Representation
|
88
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument
|
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`/dataStores/`data_store`/branches/`branch`/documents/`
|
100
|
+
# document``. If the caller does not have permission to delete the Document,
|
101
|
+
# regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
|
102
|
+
# If the Document to delete does not exist, a NOT_FOUND error is returned.
|
103
|
+
# @param [String] fields
|
104
|
+
# Selector specifying which fields to include in a partial response.
|
105
|
+
# @param [String] quota_user
|
106
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
107
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
108
|
+
# @param [Google::Apis::RequestOptions] options
|
109
|
+
# Request-specific options
|
110
|
+
#
|
111
|
+
# @yield [result, err] Result & error if block supplied
|
112
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty] parsed result object
|
113
|
+
# @yieldparam err [StandardError] error object if request failed
|
114
|
+
#
|
115
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty]
|
116
|
+
#
|
117
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
118
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
119
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
120
|
+
def delete_project_location_data_store_branch_document(name, fields: nil, quota_user: nil, options: nil, &block)
|
121
|
+
command = make_simple_command(:delete, 'v1alpha/{+name}', options)
|
122
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty::Representation
|
123
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty
|
124
|
+
command.params['name'] = name unless name.nil?
|
125
|
+
command.query['fields'] = fields unless fields.nil?
|
126
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
127
|
+
execute_or_queue_command(command, &block)
|
128
|
+
end
|
129
|
+
|
130
|
+
# Gets a Document.
|
131
|
+
# @param [String] name
|
132
|
+
# Required. Full resource name of Document, such as `projects/`project`/
|
133
|
+
# locations/`location`/dataStores/`data_store`/branches/`branch`/documents/`
|
134
|
+
# document``. If the caller does not have permission to access the Document,
|
135
|
+
# regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
|
136
|
+
# If the requested Document does not exist, a NOT_FOUND error is returned.
|
137
|
+
# @param [String] fields
|
138
|
+
# Selector specifying which fields to include in a partial response.
|
139
|
+
# @param [String] quota_user
|
140
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
141
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
142
|
+
# @param [Google::Apis::RequestOptions] options
|
143
|
+
# Request-specific options
|
144
|
+
#
|
145
|
+
# @yield [result, err] Result & error if block supplied
|
146
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument] parsed result object
|
147
|
+
# @yieldparam err [StandardError] error object if request failed
|
148
|
+
#
|
149
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument]
|
150
|
+
#
|
151
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
152
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
153
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
154
|
+
def get_project_location_data_store_branch_document(name, fields: nil, quota_user: nil, options: nil, &block)
|
155
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
156
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument::Representation
|
157
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument
|
158
|
+
command.params['name'] = name unless name.nil?
|
159
|
+
command.query['fields'] = fields unless fields.nil?
|
160
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
161
|
+
execute_or_queue_command(command, &block)
|
162
|
+
end
|
163
|
+
|
164
|
+
# Bulk import of multiple Documents. Request processing may be synchronous. Non-
|
165
|
+
# existing items will be created. Note: It is possible for a subset of the
|
166
|
+
# Documents to be successfully updated.
|
167
|
+
# @param [String] parent
|
168
|
+
# Required. The parent branch resource name, such as `projects/`project`/
|
169
|
+
# locations/`location`/dataStores/`data_store`/branches/`branch``. Requires
|
170
|
+
# create/update permission.
|
171
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest] google_cloud_discoveryengine_v1alpha_import_documents_request_object
|
172
|
+
# @param [String] fields
|
173
|
+
# Selector specifying which fields to include in a partial response.
|
174
|
+
# @param [String] quota_user
|
175
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
176
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
177
|
+
# @param [Google::Apis::RequestOptions] options
|
178
|
+
# Request-specific options
|
179
|
+
#
|
180
|
+
# @yield [result, err] Result & error if block supplied
|
181
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
182
|
+
# @yieldparam err [StandardError] error object if request failed
|
183
|
+
#
|
184
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
185
|
+
#
|
186
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
187
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
188
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
189
|
+
def import_project_location_data_store_branch_document(parent, google_cloud_discoveryengine_v1alpha_import_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
190
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/documents:import', options)
|
191
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest::Representation
|
192
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_import_documents_request_object
|
193
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
194
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
195
|
+
command.params['parent'] = parent unless parent.nil?
|
196
|
+
command.query['fields'] = fields unless fields.nil?
|
197
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
198
|
+
execute_or_queue_command(command, &block)
|
199
|
+
end
|
200
|
+
|
201
|
+
# Gets a list of Documents.
|
202
|
+
# @param [String] parent
|
203
|
+
# Required. The parent branch resource name, such as `projects/`project`/
|
204
|
+
# locations/`location`/dataStores/`data_store`/branches/`branch``. Use `
|
205
|
+
# default_branch` as the branch ID, to list documents under the default branch.
|
206
|
+
# If the caller does not have permission to list Documentss under this branch,
|
207
|
+
# regardless of whether or not this branch exists, a PERMISSION_DENIED error is
|
208
|
+
# returned.
|
209
|
+
# @param [Fixnum] page_size
|
210
|
+
# Maximum number of Documents to return. If unspecified, defaults to 100. The
|
211
|
+
# maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If
|
212
|
+
# this field is negative, an INVALID_ARGUMENT error is returned.
|
213
|
+
# @param [String] page_token
|
214
|
+
# A page token ListDocumentsResponse.next_page_token, received from a previous
|
215
|
+
# DocumentService.ListDocuments call. Provide this to retrieve the subsequent
|
216
|
+
# page. When paginating, all other parameters provided to DocumentService.
|
217
|
+
# ListDocuments must match the call that provided the page token. Otherwise, an
|
218
|
+
# INVALID_ARGUMENT error is returned.
|
219
|
+
# @param [String] fields
|
220
|
+
# Selector specifying which fields to include in a partial response.
|
221
|
+
# @param [String] quota_user
|
222
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
223
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
224
|
+
# @param [Google::Apis::RequestOptions] options
|
225
|
+
# Request-specific options
|
226
|
+
#
|
227
|
+
# @yield [result, err] Result & error if block supplied
|
228
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListDocumentsResponse] parsed result object
|
229
|
+
# @yieldparam err [StandardError] error object if request failed
|
230
|
+
#
|
231
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListDocumentsResponse]
|
232
|
+
#
|
233
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
234
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
235
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
236
|
+
def list_project_location_data_store_branch_documents(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
237
|
+
command = make_simple_command(:get, 'v1alpha/{+parent}/documents', options)
|
238
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListDocumentsResponse::Representation
|
239
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListDocumentsResponse
|
240
|
+
command.params['parent'] = parent unless parent.nil?
|
241
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
242
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
243
|
+
command.query['fields'] = fields unless fields.nil?
|
244
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
245
|
+
execute_or_queue_command(command, &block)
|
246
|
+
end
|
247
|
+
|
248
|
+
# Updates a Document.
|
249
|
+
# @param [String] name
|
250
|
+
# Immutable. The full resource name of the document. Format: `projects/`project`/
|
251
|
+
# locations/`location`/dataStores/`data_store`/branches/`branch`/documents/`
|
252
|
+
# document_id``. This field must be a UTF-8 encoded string with a length limit
|
253
|
+
# of 1024 characters.
|
254
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument] google_cloud_discoveryengine_v1alpha_document_object
|
255
|
+
# @param [Boolean] allow_missing
|
256
|
+
# If set to true, and the Document is not found, a new Document will be created.
|
257
|
+
# @param [String] fields
|
258
|
+
# Selector specifying which fields to include in a partial response.
|
259
|
+
# @param [String] quota_user
|
260
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
261
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
262
|
+
# @param [Google::Apis::RequestOptions] options
|
263
|
+
# Request-specific options
|
264
|
+
#
|
265
|
+
# @yield [result, err] Result & error if block supplied
|
266
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument] parsed result object
|
267
|
+
# @yieldparam err [StandardError] error object if request failed
|
268
|
+
#
|
269
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument]
|
270
|
+
#
|
271
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
272
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
273
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
274
|
+
def patch_project_location_data_store_branch_document(name, google_cloud_discoveryengine_v1alpha_document_object = nil, allow_missing: nil, fields: nil, quota_user: nil, options: nil, &block)
|
275
|
+
command = make_simple_command(:patch, 'v1alpha/{+name}', options)
|
276
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument::Representation
|
277
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_document_object
|
278
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument::Representation
|
279
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument
|
280
|
+
command.params['name'] = name unless name.nil?
|
281
|
+
command.query['allowMissing'] = allow_missing unless allow_missing.nil?
|
282
|
+
command.query['fields'] = fields unless fields.nil?
|
283
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
284
|
+
execute_or_queue_command(command, &block)
|
285
|
+
end
|
286
|
+
|
287
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
288
|
+
# to poll the operation result at intervals as recommended by the API service.
|
289
|
+
# @param [String] name
|
290
|
+
# The name of the operation resource.
|
291
|
+
# @param [String] fields
|
292
|
+
# Selector specifying which fields to include in a partial response.
|
293
|
+
# @param [String] quota_user
|
294
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
295
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
296
|
+
# @param [Google::Apis::RequestOptions] options
|
297
|
+
# Request-specific options
|
298
|
+
#
|
299
|
+
# @yield [result, err] Result & error if block supplied
|
300
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
301
|
+
# @yieldparam err [StandardError] error object if request failed
|
302
|
+
#
|
303
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
304
|
+
#
|
305
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
306
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
307
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
308
|
+
def get_project_location_data_store_branch_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
309
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
310
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
311
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
312
|
+
command.params['name'] = name unless name.nil?
|
313
|
+
command.query['fields'] = fields unless fields.nil?
|
314
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
315
|
+
execute_or_queue_command(command, &block)
|
316
|
+
end
|
317
|
+
|
318
|
+
# Lists operations that match the specified filter in the request. If the server
|
319
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
|
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.
|
326
|
+
# @param [String] name
|
327
|
+
# The name of the operation's parent resource.
|
328
|
+
# @param [String] filter
|
329
|
+
# The standard list filter.
|
330
|
+
# @param [Fixnum] page_size
|
331
|
+
# The standard list page size.
|
332
|
+
# @param [String] page_token
|
333
|
+
# The standard list page token.
|
334
|
+
# @param [String] fields
|
335
|
+
# Selector specifying which fields to include in a partial response.
|
336
|
+
# @param [String] quota_user
|
337
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
338
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
339
|
+
# @param [Google::Apis::RequestOptions] options
|
340
|
+
# Request-specific options
|
341
|
+
#
|
342
|
+
# @yield [result, err] Result & error if block supplied
|
343
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse] parsed result object
|
344
|
+
# @yieldparam err [StandardError] error object if request failed
|
345
|
+
#
|
346
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse]
|
347
|
+
#
|
348
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
349
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
350
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
351
|
+
def list_project_location_data_store_branch_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
352
|
+
command = make_simple_command(:get, 'v1alpha/{+name}/operations', options)
|
353
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse::Representation
|
354
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse
|
355
|
+
command.params['name'] = name unless name.nil?
|
356
|
+
command.query['filter'] = filter unless filter.nil?
|
357
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
358
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
359
|
+
command.query['fields'] = fields unless fields.nil?
|
360
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
361
|
+
execute_or_queue_command(command, &block)
|
362
|
+
end
|
363
|
+
|
364
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
365
|
+
# to poll the operation result at intervals as recommended by the API service.
|
366
|
+
# @param [String] name
|
367
|
+
# The name of the operation resource.
|
368
|
+
# @param [String] fields
|
369
|
+
# Selector specifying which fields to include in a partial response.
|
370
|
+
# @param [String] quota_user
|
371
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
372
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
373
|
+
# @param [Google::Apis::RequestOptions] options
|
374
|
+
# Request-specific options
|
375
|
+
#
|
376
|
+
# @yield [result, err] Result & error if block supplied
|
377
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
378
|
+
# @yieldparam err [StandardError] error object if request failed
|
379
|
+
#
|
380
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
381
|
+
#
|
382
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
383
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
384
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
385
|
+
def get_project_location_data_store_model_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
386
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
387
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
388
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
389
|
+
command.params['name'] = name unless name.nil?
|
390
|
+
command.query['fields'] = fields unless fields.nil?
|
391
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
392
|
+
execute_or_queue_command(command, &block)
|
393
|
+
end
|
394
|
+
|
395
|
+
# Lists operations that match the specified filter in the request. If the server
|
396
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
|
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.
|
403
|
+
# @param [String] name
|
404
|
+
# The name of the operation's parent resource.
|
405
|
+
# @param [String] filter
|
406
|
+
# The standard list filter.
|
407
|
+
# @param [Fixnum] page_size
|
408
|
+
# The standard list page size.
|
409
|
+
# @param [String] page_token
|
410
|
+
# The standard list page token.
|
411
|
+
# @param [String] fields
|
412
|
+
# Selector specifying which fields to include in a partial response.
|
413
|
+
# @param [String] quota_user
|
414
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
415
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
416
|
+
# @param [Google::Apis::RequestOptions] options
|
417
|
+
# Request-specific options
|
418
|
+
#
|
419
|
+
# @yield [result, err] Result & error if block supplied
|
420
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse] parsed result object
|
421
|
+
# @yieldparam err [StandardError] error object if request failed
|
422
|
+
#
|
423
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse]
|
424
|
+
#
|
425
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
426
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
427
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
428
|
+
def list_project_location_data_store_model_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
429
|
+
command = make_simple_command(:get, 'v1alpha/{+name}/operations', options)
|
430
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse::Representation
|
431
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse
|
432
|
+
command.params['name'] = name unless name.nil?
|
433
|
+
command.query['filter'] = filter unless filter.nil?
|
434
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
435
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
436
|
+
command.query['fields'] = fields unless fields.nil?
|
437
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
438
|
+
execute_or_queue_command(command, &block)
|
439
|
+
end
|
440
|
+
|
441
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
442
|
+
# to poll the operation result at intervals as recommended by the API service.
|
443
|
+
# @param [String] name
|
444
|
+
# The name of the operation resource.
|
445
|
+
# @param [String] fields
|
446
|
+
# Selector specifying which fields to include in a partial response.
|
447
|
+
# @param [String] quota_user
|
448
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
449
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
450
|
+
# @param [Google::Apis::RequestOptions] options
|
451
|
+
# Request-specific options
|
452
|
+
#
|
453
|
+
# @yield [result, err] Result & error if block supplied
|
454
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
455
|
+
# @yieldparam err [StandardError] error object if request failed
|
456
|
+
#
|
457
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
458
|
+
#
|
459
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
460
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
461
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
462
|
+
def get_project_location_data_store_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
463
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
464
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
465
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
466
|
+
command.params['name'] = name unless name.nil?
|
467
|
+
command.query['fields'] = fields unless fields.nil?
|
468
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
469
|
+
execute_or_queue_command(command, &block)
|
470
|
+
end
|
471
|
+
|
472
|
+
# Lists operations that match the specified filter in the request. If the server
|
473
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
|
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.
|
480
|
+
# @param [String] name
|
481
|
+
# The name of the operation's parent resource.
|
482
|
+
# @param [String] filter
|
483
|
+
# The standard list filter.
|
484
|
+
# @param [Fixnum] page_size
|
485
|
+
# The standard list page size.
|
486
|
+
# @param [String] page_token
|
487
|
+
# The standard list page token.
|
488
|
+
# @param [String] fields
|
489
|
+
# Selector specifying which fields to include in a partial response.
|
490
|
+
# @param [String] quota_user
|
491
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
492
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
493
|
+
# @param [Google::Apis::RequestOptions] options
|
494
|
+
# Request-specific options
|
495
|
+
#
|
496
|
+
# @yield [result, err] Result & error if block supplied
|
497
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse] parsed result object
|
498
|
+
# @yieldparam err [StandardError] error object if request failed
|
499
|
+
#
|
500
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse]
|
501
|
+
#
|
502
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
503
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
504
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
505
|
+
def list_project_location_data_store_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
506
|
+
command = make_simple_command(:get, 'v1alpha/{+name}/operations', options)
|
507
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse::Representation
|
508
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse
|
509
|
+
command.params['name'] = name unless name.nil?
|
510
|
+
command.query['filter'] = filter unless filter.nil?
|
511
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
512
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
513
|
+
command.query['fields'] = fields unless fields.nil?
|
514
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
515
|
+
execute_or_queue_command(command, &block)
|
516
|
+
end
|
517
|
+
|
518
|
+
# Makes a recommendation, which requires a contextual user event.
|
519
|
+
# @param [String] serving_config
|
520
|
+
# Required. Full resource name of the format: projects/*/locations/global/
|
521
|
+
# dataStores/*/servingConfigs/* Before you can request recommendations from your
|
522
|
+
# model, you must create at least one serving config for it.
|
523
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendRequest] google_cloud_discoveryengine_v1alpha_recommend_request_object
|
524
|
+
# @param [String] fields
|
525
|
+
# Selector specifying which fields to include in a partial response.
|
526
|
+
# @param [String] quota_user
|
527
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
528
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
529
|
+
# @param [Google::Apis::RequestOptions] options
|
530
|
+
# Request-specific options
|
531
|
+
#
|
532
|
+
# @yield [result, err] Result & error if block supplied
|
533
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendResponse] parsed result object
|
534
|
+
# @yieldparam err [StandardError] error object if request failed
|
535
|
+
#
|
536
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendResponse]
|
537
|
+
#
|
538
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
539
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
540
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
541
|
+
def recommend_project_location_data_store_serving_config(serving_config, google_cloud_discoveryengine_v1alpha_recommend_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
542
|
+
command = make_simple_command(:post, 'v1alpha/{+servingConfig}:recommend', options)
|
543
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendRequest::Representation
|
544
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_recommend_request_object
|
545
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendResponse::Representation
|
546
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendResponse
|
547
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
548
|
+
command.query['fields'] = fields unless fields.nil?
|
549
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
550
|
+
execute_or_queue_command(command, &block)
|
551
|
+
end
|
552
|
+
|
553
|
+
# Writes a single user event from the browser. This uses a GET request to due to
|
554
|
+
# browser restriction of POST-ing to a 3rd party domain. This method is used
|
555
|
+
# only by the Discovery Engine API JavaScript pixel and Google Tag Manager.
|
556
|
+
# Users should not call this method directly.
|
557
|
+
# @param [String] parent
|
558
|
+
# Required. The parent DataStore resource name, such as `projects/`project`/
|
559
|
+
# locations/`location`/dataStores/`data_store``.
|
560
|
+
# @param [Fixnum] ets
|
561
|
+
# The event timestamp in milliseconds. This prevents browser caching of
|
562
|
+
# otherwise identical get requests. The name is abbreviated to reduce the
|
563
|
+
# payload bytes.
|
564
|
+
# @param [String] uri
|
565
|
+
# The URL including cgi-parameters but excluding the hash fragment with a length
|
566
|
+
# limit of 5,000 characters. This is often more useful than the referer URL,
|
567
|
+
# because many browsers only send the domain for 3rd party requests.
|
568
|
+
# @param [String] user_event
|
569
|
+
# Required. URL encoded UserEvent proto with a length limit of 2,000,000
|
570
|
+
# characters.
|
571
|
+
# @param [String] fields
|
572
|
+
# Selector specifying which fields to include in a partial response.
|
573
|
+
# @param [String] quota_user
|
574
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
575
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
576
|
+
# @param [Google::Apis::RequestOptions] options
|
577
|
+
# Request-specific options
|
578
|
+
#
|
579
|
+
# @yield [result, err] Result & error if block supplied
|
580
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleApiHttpBody] parsed result object
|
581
|
+
# @yieldparam err [StandardError] error object if request failed
|
582
|
+
#
|
583
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleApiHttpBody]
|
584
|
+
#
|
585
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
586
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
587
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
588
|
+
def collect_project_location_data_store_user_event(parent, ets: nil, uri: nil, user_event: nil, fields: nil, quota_user: nil, options: nil, &block)
|
589
|
+
command = make_simple_command(:get, 'v1alpha/{+parent}/userEvents:collect', options)
|
590
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleApiHttpBody::Representation
|
591
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleApiHttpBody
|
592
|
+
command.params['parent'] = parent unless parent.nil?
|
593
|
+
command.query['ets'] = ets unless ets.nil?
|
594
|
+
command.query['uri'] = uri unless uri.nil?
|
595
|
+
command.query['userEvent'] = user_event unless user_event.nil?
|
596
|
+
command.query['fields'] = fields unless fields.nil?
|
597
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
598
|
+
execute_or_queue_command(command, &block)
|
599
|
+
end
|
600
|
+
|
601
|
+
# Bulk import of User events. Request processing might be synchronous. Events
|
602
|
+
# that already exist are skipped. Use this method for backfilling historical
|
603
|
+
# user events. Operation.response is of type ImportResponse. Note that it is
|
604
|
+
# possible for a subset of the items to be successfully inserted. Operation.
|
605
|
+
# metadata is of type ImportMetadata.
|
606
|
+
# @param [String] parent
|
607
|
+
# Required. Parent DataStore resource name, of the form `projects/`project`/
|
608
|
+
# locations/`location`/dataStores/`data_store``
|
609
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest] google_cloud_discoveryengine_v1alpha_import_user_events_request_object
|
610
|
+
# @param [String] fields
|
611
|
+
# Selector specifying which fields to include in a partial response.
|
612
|
+
# @param [String] quota_user
|
613
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
614
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
615
|
+
# @param [Google::Apis::RequestOptions] options
|
616
|
+
# Request-specific options
|
617
|
+
#
|
618
|
+
# @yield [result, err] Result & error if block supplied
|
619
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
620
|
+
# @yieldparam err [StandardError] error object if request failed
|
621
|
+
#
|
622
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
623
|
+
#
|
624
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
625
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
626
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
627
|
+
def import_project_location_data_store_user_event(parent, google_cloud_discoveryengine_v1alpha_import_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
628
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/userEvents:import', options)
|
629
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest::Representation
|
630
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_import_user_events_request_object
|
631
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
632
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
633
|
+
command.params['parent'] = parent unless parent.nil?
|
634
|
+
command.query['fields'] = fields unless fields.nil?
|
635
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
636
|
+
execute_or_queue_command(command, &block)
|
637
|
+
end
|
638
|
+
|
639
|
+
# Writes a single user event.
|
640
|
+
# @param [String] parent
|
641
|
+
# Required. The parent DataStore resource name, such as `projects/`project`/
|
642
|
+
# locations/`location`/dataStores/`data_store``.
|
643
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent] google_cloud_discoveryengine_v1alpha_user_event_object
|
644
|
+
# @param [String] fields
|
645
|
+
# Selector specifying which fields to include in a partial response.
|
646
|
+
# @param [String] quota_user
|
647
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
648
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
649
|
+
# @param [Google::Apis::RequestOptions] options
|
650
|
+
# Request-specific options
|
651
|
+
#
|
652
|
+
# @yield [result, err] Result & error if block supplied
|
653
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent] parsed result object
|
654
|
+
# @yieldparam err [StandardError] error object if request failed
|
655
|
+
#
|
656
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent]
|
657
|
+
#
|
658
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
659
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
660
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
661
|
+
def write_project_location_data_store_user_event(parent, google_cloud_discoveryengine_v1alpha_user_event_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
662
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/userEvents:write', options)
|
663
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent::Representation
|
664
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_user_event_object
|
665
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent::Representation
|
666
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent
|
667
|
+
command.params['parent'] = parent unless parent.nil?
|
668
|
+
command.query['fields'] = fields unless fields.nil?
|
669
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
670
|
+
execute_or_queue_command(command, &block)
|
671
|
+
end
|
672
|
+
|
673
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
674
|
+
# to poll the operation result at intervals as recommended by the API service.
|
675
|
+
# @param [String] name
|
676
|
+
# The name of the operation resource.
|
677
|
+
# @param [String] fields
|
678
|
+
# Selector specifying which fields to include in a partial response.
|
679
|
+
# @param [String] quota_user
|
680
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
681
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
682
|
+
# @param [Google::Apis::RequestOptions] options
|
683
|
+
# Request-specific options
|
684
|
+
#
|
685
|
+
# @yield [result, err] Result & error if block supplied
|
686
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
687
|
+
# @yieldparam err [StandardError] error object if request failed
|
688
|
+
#
|
689
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
690
|
+
#
|
691
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
692
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
693
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
694
|
+
def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
695
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
696
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
697
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
698
|
+
command.params['name'] = name unless name.nil?
|
699
|
+
command.query['fields'] = fields unless fields.nil?
|
700
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
701
|
+
execute_or_queue_command(command, &block)
|
702
|
+
end
|
703
|
+
|
704
|
+
# Lists operations that match the specified filter in the request. If the server
|
705
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
|
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.
|
712
|
+
# @param [String] name
|
713
|
+
# The name of the operation's parent resource.
|
714
|
+
# @param [String] filter
|
715
|
+
# The standard list filter.
|
716
|
+
# @param [Fixnum] page_size
|
717
|
+
# The standard list page size.
|
718
|
+
# @param [String] page_token
|
719
|
+
# The standard list page token.
|
720
|
+
# @param [String] fields
|
721
|
+
# Selector specifying which fields to include in a partial response.
|
722
|
+
# @param [String] quota_user
|
723
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
724
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
725
|
+
# @param [Google::Apis::RequestOptions] options
|
726
|
+
# Request-specific options
|
727
|
+
#
|
728
|
+
# @yield [result, err] Result & error if block supplied
|
729
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse] parsed result object
|
730
|
+
# @yieldparam err [StandardError] error object if request failed
|
731
|
+
#
|
732
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse]
|
733
|
+
#
|
734
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
735
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
736
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
737
|
+
def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
738
|
+
command = make_simple_command(:get, 'v1alpha/{+name}/operations', options)
|
739
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse::Representation
|
740
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse
|
741
|
+
command.params['name'] = name unless name.nil?
|
742
|
+
command.query['filter'] = filter unless filter.nil?
|
743
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
744
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
745
|
+
command.query['fields'] = fields unless fields.nil?
|
746
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
747
|
+
execute_or_queue_command(command, &block)
|
748
|
+
end
|
749
|
+
|
750
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
751
|
+
# to poll the operation result at intervals as recommended by the API service.
|
752
|
+
# @param [String] name
|
753
|
+
# The name of the operation resource.
|
754
|
+
# @param [String] fields
|
755
|
+
# Selector specifying which fields to include in a partial response.
|
756
|
+
# @param [String] quota_user
|
757
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
758
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
759
|
+
# @param [Google::Apis::RequestOptions] options
|
760
|
+
# Request-specific options
|
761
|
+
#
|
762
|
+
# @yield [result, err] Result & error if block supplied
|
763
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
764
|
+
# @yieldparam err [StandardError] error object if request failed
|
765
|
+
#
|
766
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
767
|
+
#
|
768
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
769
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
770
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
771
|
+
def get_project_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
772
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
773
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
774
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
775
|
+
command.params['name'] = name unless name.nil?
|
776
|
+
command.query['fields'] = fields unless fields.nil?
|
777
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
778
|
+
execute_or_queue_command(command, &block)
|
779
|
+
end
|
780
|
+
|
781
|
+
# Lists operations that match the specified filter in the request. If the server
|
782
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
|
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.
|
789
|
+
# @param [String] name
|
790
|
+
# The name of the operation's parent resource.
|
791
|
+
# @param [String] filter
|
792
|
+
# The standard list filter.
|
793
|
+
# @param [Fixnum] page_size
|
794
|
+
# The standard list page size.
|
795
|
+
# @param [String] page_token
|
796
|
+
# The standard list page token.
|
797
|
+
# @param [String] fields
|
798
|
+
# Selector specifying which fields to include in a partial response.
|
799
|
+
# @param [String] quota_user
|
800
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
801
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
802
|
+
# @param [Google::Apis::RequestOptions] options
|
803
|
+
# Request-specific options
|
804
|
+
#
|
805
|
+
# @yield [result, err] Result & error if block supplied
|
806
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse] parsed result object
|
807
|
+
# @yieldparam err [StandardError] error object if request failed
|
808
|
+
#
|
809
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse]
|
810
|
+
#
|
811
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
812
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
813
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
814
|
+
def list_project_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
815
|
+
command = make_simple_command(:get, 'v1alpha/{+name}/operations', options)
|
816
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse::Representation
|
817
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse
|
818
|
+
command.params['name'] = name unless name.nil?
|
819
|
+
command.query['filter'] = filter unless filter.nil?
|
820
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
821
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
822
|
+
command.query['fields'] = fields unless fields.nil?
|
823
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
824
|
+
execute_or_queue_command(command, &block)
|
825
|
+
end
|
826
|
+
|
827
|
+
protected
|
828
|
+
|
829
|
+
def apply_command_defaults(command)
|
830
|
+
command.query['key'] = key unless key.nil?
|
831
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
832
|
+
end
|
833
|
+
end
|
834
|
+
end
|
835
|
+
end
|
836
|
+
end
|