google-apis-discoveryengine_v1alpha 0.5.0 → 0.6.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d7136aa86da1970091aacbc721332a7f699a922c0a66dde3f09875ed85a83313
4
- data.tar.gz: c82165a3bea960d8f093fce7cf52f006c7c4faaf8d156ff706c624ba07bf9324
3
+ metadata.gz: 72020d972f060f202e08822ec349c894298051fc77fa419f7b71ea39f9dab7a7
4
+ data.tar.gz: e20445ca485fc70e9354f08be22bafdbce4163b8a47ef35118d455911f6c0f3e
5
5
  SHA512:
6
- metadata.gz: 2233c682eaa078fd8d4011c3abde6e34c460aaff4764b4e2bc49ae0145629425775b4045d106f9c5a8005cba4b2cc7495797d19d6f0ecc2a7d5cb8dc812a826b
7
- data.tar.gz: 7de0f1d0f7818229ade6f3b8586900fd6271e27822c7b0804a27a90937208dabd0b9edf4b4832fd4aefabed5a96a6422b33c9f04819f77c8734e65c27c25eb4d
6
+ metadata.gz: b16e70b37f72562a083c4f45e292b3f2f5dfc067aeb819d6c8f5d4df56908e68ac61bfce4d04e0659a9bab0a3e4d407a881ad552bf7c86690954e7760600b03d
7
+ data.tar.gz: 574f3172fe9082cc35c5d4a290941961a6011c2b415291e6a6e426fa02a98445f843808e1e63b85cb2f003271611fbc32e73945e455b951f48cbd2e13f567242
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-discoveryengine_v1alpha
2
2
 
3
+ ### v0.6.0 (2023-03-05)
4
+
5
+ * Regenerated from discovery document revision 20230227
6
+
3
7
  ### v0.5.0 (2023-02-26)
4
8
 
5
9
  * Regenerated from discovery document revision 20230209
@@ -105,9 +105,10 @@ module Google
105
105
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineLoggingErrorContext]
106
106
  attr_accessor :context
107
107
 
108
- # The error payload that is populated on LRO import APIs. Including: "google.
109
- # cloud.discoveryengine.v1alpha.DocumentService.ImportDocuments" "google.cloud.
110
- # discoveryengine.v1alpha.UserEventService.ImportUserEvents"
108
+ # The error payload that is populated on LRO import APIs, including the
109
+ # following: * `google.cloud.discoveryengine.v1alpha.DocumentService.
110
+ # ImportDocuments` * `google.cloud.discoveryengine.v1alpha.UserEventService.
111
+ # ImportUserEvents`
111
112
  # Corresponds to the JSON property `importPayload`
112
113
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineLoggingImportErrorContext]
113
114
  attr_accessor :import_payload
@@ -117,26 +118,6 @@ module Google
117
118
  # @return [String]
118
119
  attr_accessor :message
119
120
 
120
- # The API request payload, represented as a protocol buffer. Most API request
121
- # types are supported. For example: "type.googleapis.com/google.cloud.
122
- # discoveryengine.v1alpha.DocumentService.CreateDocumentRequest" "type.
123
- # googleapis.com/google.cloud.discoveryengine.v1alpha.UserEventService.
124
- # WriteUserEventRequest"
125
- # Corresponds to the JSON property `requestPayload`
126
- # @return [Hash<String,Object>]
127
- attr_accessor :request_payload
128
-
129
- # The API response payload, represented as a protocol buffer. This is used to
130
- # log some "soft errors", where the response is valid but we consider there are
131
- # some quality issues like unjoined events. The following API responses are
132
- # supported and no PII is included: "google.cloud.discoveryengine.v1alpha.
133
- # RecommendationService.Recommend" "google.cloud.discoveryengine.v1alpha.
134
- # UserEventService.WriteUserEvent" "google.cloud.discoveryengine.v1alpha.
135
- # UserEventService.CollectUserEvent"
136
- # Corresponds to the JSON property `responsePayload`
137
- # @return [Hash<String,Object>]
138
- attr_accessor :response_payload
139
-
140
121
  # Describes a running service that sends errors.
141
122
  # Corresponds to the JSON property `serviceContext`
142
123
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineLoggingServiceContext]
@@ -161,8 +142,6 @@ module Google
161
142
  @context = args[:context] if args.key?(:context)
162
143
  @import_payload = args[:import_payload] if args.key?(:import_payload)
163
144
  @message = args[:message] if args.key?(:message)
164
- @request_payload = args[:request_payload] if args.key?(:request_payload)
165
- @response_payload = args[:response_payload] if args.key?(:response_payload)
166
145
  @service_context = args[:service_context] if args.key?(:service_context)
167
146
  @status = args[:status] if args.key?(:status)
168
147
  end
@@ -187,9 +166,10 @@ module Google
187
166
  end
188
167
  end
189
168
 
190
- # The error payload that is populated on LRO import APIs. Including: "google.
191
- # cloud.discoveryengine.v1alpha.DocumentService.ImportDocuments" "google.cloud.
192
- # discoveryengine.v1alpha.UserEventService.ImportUserEvents"
169
+ # The error payload that is populated on LRO import APIs, including the
170
+ # following: * `google.cloud.discoveryengine.v1alpha.DocumentService.
171
+ # ImportDocuments` * `google.cloud.discoveryengine.v1alpha.UserEventService.
172
+ # ImportUserEvents`
193
173
  class GoogleCloudDiscoveryengineLoggingImportErrorContext
194
174
  include Google::Apis::Core::Hashable
195
175
 
@@ -238,7 +218,7 @@ module Google
238
218
  class GoogleCloudDiscoveryengineLoggingServiceContext
239
219
  include Google::Apis::Core::Hashable
240
220
 
241
- # An identifier of the service. For example, "discoveryengine.googleapis.com".
221
+ # An identifier of the service—for example, `discoveryengine.googleapis.com`.
242
222
  # Corresponds to the JSON property `service`
243
223
  # @return [String]
244
224
  attr_accessor :service
@@ -258,8 +238,8 @@ module Google
258
238
  class GoogleCloudDiscoveryengineLoggingSourceLocation
259
239
  include Google::Apis::Core::Hashable
260
240
 
261
- # Human-readable name of a function or method. For example, " google.cloud.
262
- # discoveryengine.v1alpha.RecommendationService.Recommend".
241
+ # Human-readable name of a function or method—for example, `google.cloud.
242
+ # discoveryengine.v1alpha.RecommendationService.Recommend`.
263
243
  # Corresponds to the JSON property `functionName`
264
244
  # @return [String]
265
245
  attr_accessor :function_name
@@ -416,9 +396,9 @@ module Google
416
396
  attr_accessor :json_data
417
397
 
418
398
  # Immutable. The full resource name of the document. Format: `projects/`project`/
419
- # locations/`location`/dataStores/`data_store`/branches/`branch`/documents/`
420
- # document_id``. This field must be a UTF-8 encoded string with a length limit
421
- # of 1024 characters.
399
+ # locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
400
+ # `branch`/documents/`document_id``. This field must be a UTF-8 encoded string
401
+ # with a length limit of 1024 characters.
422
402
  # Corresponds to the JSON property `name`
423
403
  # @return [String]
424
404
  attr_accessor :name
@@ -466,8 +446,8 @@ module Google
466
446
  attr_accessor :id
467
447
 
468
448
  # Required. The Document resource full name, of the form: projects/`project\_id`/
469
- # locations/`location`/dataStores/`data\_store\_id`/branches/`branch\_id`/
470
- # documents/`document\_id`
449
+ # locations/`location`/collections/`collection\_id`/dataStores/`data\_store\_id`/
450
+ # branches/`branch\_id`/documents/`document\_id`
471
451
  # Corresponds to the JSON property `name`
472
452
  # @return [String]
473
453
  attr_accessor :name
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module DiscoveryengineV1alpha
18
18
  # Version of the google-apis-discoveryengine_v1alpha gem
19
- GEM_VERSION = "0.5.0"
19
+ GEM_VERSION = "0.6.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.12.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20230209"
25
+ REVISION = "20230227"
26
26
  end
27
27
  end
28
28
  end
@@ -307,8 +307,6 @@ module Google
307
307
  property :import_payload, as: 'importPayload', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineLoggingImportErrorContext, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineLoggingImportErrorContext::Representation
308
308
 
309
309
  property :message, as: 'message'
310
- hash :request_payload, as: 'requestPayload'
311
- hash :response_payload, as: 'responsePayload'
312
310
  property :service_context, as: 'serviceContext', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineLoggingServiceContext, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineLoggingServiceContext::Representation
313
311
 
314
312
  property :status, as: 'status', class: Google::Apis::DiscoveryengineV1alpha::GoogleRpcStatus, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleRpcStatus::Representation
@@ -52,7 +52,400 @@ 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::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_collection_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`/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::DiscoveryengineV1alpha::GoogleProtobufEmpty] parsed result object
114
+ # @yieldparam err [StandardError] error object if request failed
115
+ #
116
+ # @return [Google::Apis::DiscoveryengineV1alpha::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, 'v1alpha/{+name}', options)
123
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty::Representation
124
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::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::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument] parsed result object
149
+ # @yieldparam err [StandardError] error object if request failed
150
+ #
151
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument]
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, 'v1alpha/{+name}', options)
158
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument::Representation
159
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument
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::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest] google_cloud_discoveryengine_v1alpha_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::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
184
+ # @yieldparam err [StandardError] error object if request failed
185
+ #
186
+ # @return [Google::Apis::DiscoveryengineV1alpha::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_v1alpha_import_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
192
+ command = make_simple_command(:post, 'v1alpha/{+parent}/documents:import', options)
193
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest::Representation
194
+ command.request_object = google_cloud_discoveryengine_v1alpha_import_documents_request_object
195
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
196
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::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::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListDocumentsResponse] parsed result object
231
+ # @yieldparam err [StandardError] error object if request failed
232
+ #
233
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListDocumentsResponse]
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, 'v1alpha/{+parent}/documents', options)
240
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListDocumentsResponse::Representation
241
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListDocumentsResponse
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::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument] google_cloud_discoveryengine_v1alpha_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::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument] parsed result object
269
+ # @yieldparam err [StandardError] error object if request failed
270
+ #
271
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument]
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_v1alpha_document_object = nil, allow_missing: nil, fields: nil, quota_user: nil, options: nil, &block)
277
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
278
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument::Representation
279
+ command.request_object = google_cloud_discoveryengine_v1alpha_document_object
280
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument::Representation
281
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument
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
+ # Makes a recommendation, which requires a contextual user event.
290
+ # @param [String] serving_config
291
+ # Required. Full resource name of the format: projects/*/locations/global/
292
+ # collections/*/dataStores/*/servingConfigs/* Before you can request
293
+ # recommendations from your model, you must create at least one serving config
294
+ # for it.
295
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendRequest] google_cloud_discoveryengine_v1alpha_recommend_request_object
296
+ # @param [String] fields
297
+ # Selector specifying which fields to include in a partial response.
298
+ # @param [String] quota_user
299
+ # Available to use for quota purposes for server-side applications. Can be any
300
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
301
+ # @param [Google::Apis::RequestOptions] options
302
+ # Request-specific options
303
+ #
304
+ # @yield [result, err] Result & error if block supplied
305
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendResponse] parsed result object
306
+ # @yieldparam err [StandardError] error object if request failed
307
+ #
308
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendResponse]
309
+ #
310
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
311
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
312
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
313
+ def recommend_project_location_collection_data_store_serving_config(serving_config, google_cloud_discoveryengine_v1alpha_recommend_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
314
+ command = make_simple_command(:post, 'v1alpha/{+servingConfig}:recommend', options)
315
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendRequest::Representation
316
+ command.request_object = google_cloud_discoveryengine_v1alpha_recommend_request_object
317
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendResponse::Representation
318
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendResponse
319
+ command.params['servingConfig'] = serving_config unless serving_config.nil?
320
+ command.query['fields'] = fields unless fields.nil?
321
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
322
+ execute_or_queue_command(command, &block)
323
+ end
324
+
325
+ # Writes a single user event from the browser. This uses a GET request to due to
326
+ # browser restriction of POST-ing to a 3rd party domain. This method is used
327
+ # only by the Discovery Engine API JavaScript pixel and Google Tag Manager.
328
+ # Users should not call this method directly.
329
+ # @param [String] parent
330
+ # Required. The parent DataStore resource name, such as `projects/`project`/
331
+ # locations/`location`/collections/`collection`/dataStores/`data_store``.
332
+ # @param [Fixnum] ets
333
+ # The event timestamp in milliseconds. This prevents browser caching of
334
+ # otherwise identical get requests. The name is abbreviated to reduce the
335
+ # payload bytes.
336
+ # @param [String] uri
337
+ # The URL including cgi-parameters but excluding the hash fragment with a length
338
+ # limit of 5,000 characters. This is often more useful than the referer URL,
339
+ # because many browsers only send the domain for 3rd party requests.
340
+ # @param [String] user_event
341
+ # Required. URL encoded UserEvent proto with a length limit of 2,000,000
342
+ # characters.
343
+ # @param [String] fields
344
+ # Selector specifying which fields to include in a partial response.
345
+ # @param [String] quota_user
346
+ # Available to use for quota purposes for server-side applications. Can be any
347
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
348
+ # @param [Google::Apis::RequestOptions] options
349
+ # Request-specific options
350
+ #
351
+ # @yield [result, err] Result & error if block supplied
352
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleApiHttpBody] parsed result object
353
+ # @yieldparam err [StandardError] error object if request failed
354
+ #
355
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleApiHttpBody]
356
+ #
357
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
358
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
359
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
360
+ 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)
361
+ command = make_simple_command(:get, 'v1alpha/{+parent}/userEvents:collect', options)
362
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleApiHttpBody::Representation
363
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleApiHttpBody
364
+ command.params['parent'] = parent unless parent.nil?
365
+ command.query['ets'] = ets unless ets.nil?
366
+ command.query['uri'] = uri unless uri.nil?
367
+ command.query['userEvent'] = user_event unless user_event.nil?
368
+ command.query['fields'] = fields unless fields.nil?
369
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
370
+ execute_or_queue_command(command, &block)
371
+ end
372
+
373
+ # Bulk import of User events. Request processing might be synchronous. Events
374
+ # that already exist are skipped. Use this method for backfilling historical
375
+ # user events. Operation.response is of type ImportResponse. Note that it is
376
+ # possible for a subset of the items to be successfully inserted. Operation.
377
+ # metadata is of type ImportMetadata.
378
+ # @param [String] parent
379
+ # Required. Parent DataStore resource name, of the form `projects/`project`/
380
+ # locations/`location`/collections/`collection`/dataStores/`data_store``
381
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest] google_cloud_discoveryengine_v1alpha_import_user_events_request_object
382
+ # @param [String] fields
383
+ # Selector specifying which fields to include in a partial response.
384
+ # @param [String] quota_user
385
+ # Available to use for quota purposes for server-side applications. Can be any
386
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
387
+ # @param [Google::Apis::RequestOptions] options
388
+ # Request-specific options
389
+ #
390
+ # @yield [result, err] Result & error if block supplied
391
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
392
+ # @yieldparam err [StandardError] error object if request failed
393
+ #
394
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
395
+ #
396
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
397
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
398
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
399
+ def import_project_location_collection_data_store_user_event(parent, google_cloud_discoveryengine_v1alpha_import_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
400
+ command = make_simple_command(:post, 'v1alpha/{+parent}/userEvents:import', options)
401
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest::Representation
402
+ command.request_object = google_cloud_discoveryengine_v1alpha_import_user_events_request_object
403
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
404
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
405
+ command.params['parent'] = parent unless parent.nil?
406
+ command.query['fields'] = fields unless fields.nil?
407
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
408
+ execute_or_queue_command(command, &block)
409
+ end
410
+
411
+ # Writes a single user event.
412
+ # @param [String] parent
413
+ # Required. The parent DataStore resource name, such as `projects/`project`/
414
+ # locations/`location`/collections/`collection`/dataStores/`data_store``.
415
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent] google_cloud_discoveryengine_v1alpha_user_event_object
416
+ # @param [String] fields
417
+ # Selector specifying which fields to include in a partial response.
418
+ # @param [String] quota_user
419
+ # Available to use for quota purposes for server-side applications. Can be any
420
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
421
+ # @param [Google::Apis::RequestOptions] options
422
+ # Request-specific options
423
+ #
424
+ # @yield [result, err] Result & error if block supplied
425
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent] parsed result object
426
+ # @yieldparam err [StandardError] error object if request failed
427
+ #
428
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent]
429
+ #
430
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
431
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
432
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
433
+ def write_project_location_collection_data_store_user_event(parent, google_cloud_discoveryengine_v1alpha_user_event_object = nil, fields: nil, quota_user: nil, options: nil, &block)
434
+ command = make_simple_command(:post, 'v1alpha/{+parent}/userEvents:write', options)
435
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent::Representation
436
+ command.request_object = google_cloud_discoveryengine_v1alpha_user_event_object
437
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent::Representation
438
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent
439
+ command.params['parent'] = parent unless parent.nil?
440
+ command.query['fields'] = fields unless fields.nil?
441
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
442
+ execute_or_queue_command(command, &block)
443
+ end
444
+
445
+ # Creates a Document.
446
+ # @param [String] parent
447
+ # Required. The parent resource name, such as `projects/`project`/locations/`
448
+ # location`/collections/`collection`/dataStores/`data_store`/branches/`branch``.
56
449
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument] google_cloud_discoveryengine_v1alpha_document_object
57
450
  # @param [String] document_id
58
451
  # Required. The ID to use for the Document, which will become the final
@@ -96,10 +489,11 @@ module Google
96
489
  # Deletes a Document.
97
490
  # @param [String] name
98
491
  # 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.
492
+ # locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
493
+ # `branch`/documents/`document``. If the caller does not have permission to
494
+ # delete the Document, regardless of whether or not it exists, a
495
+ # PERMISSION_DENIED error is returned. If the Document to delete does not exist,
496
+ # a NOT_FOUND error is returned.
103
497
  # @param [String] fields
104
498
  # Selector specifying which fields to include in a partial response.
105
499
  # @param [String] quota_user
@@ -130,10 +524,11 @@ module Google
130
524
  # Gets a Document.
131
525
  # @param [String] name
132
526
  # 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.
527
+ # locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
528
+ # `branch`/documents/`document``. If the caller does not have permission to
529
+ # access the Document, regardless of whether or not it exists, a
530
+ # PERMISSION_DENIED error is returned. If the requested Document does not exist,
531
+ # a NOT_FOUND error is returned.
137
532
  # @param [String] fields
138
533
  # Selector specifying which fields to include in a partial response.
139
534
  # @param [String] quota_user
@@ -166,8 +561,8 @@ module Google
166
561
  # Documents to be successfully updated.
167
562
  # @param [String] parent
168
563
  # Required. The parent branch resource name, such as `projects/`project`/
169
- # locations/`location`/dataStores/`data_store`/branches/`branch``. Requires
170
- # create/update permission.
564
+ # locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
565
+ # `branch``. Requires create/update permission.
171
566
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest] google_cloud_discoveryengine_v1alpha_import_documents_request_object
172
567
  # @param [String] fields
173
568
  # Selector specifying which fields to include in a partial response.
@@ -201,11 +596,11 @@ module Google
201
596
  # Gets a list of Documents.
202
597
  # @param [String] parent
203
598
  # 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.
599
+ # locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
600
+ # `branch``. Use `default_branch` as the branch ID, to list documents under the
601
+ # default branch. If the caller does not have permission to list Documentss
602
+ # under this branch, regardless of whether or not this branch exists, a
603
+ # PERMISSION_DENIED error is returned.
209
604
  # @param [Fixnum] page_size
210
605
  # Maximum number of Documents to return. If unspecified, defaults to 100. The
211
606
  # maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If
@@ -248,9 +643,9 @@ module Google
248
643
  # Updates a Document.
249
644
  # @param [String] name
250
645
  # 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.
646
+ # locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
647
+ # `branch`/documents/`document_id``. This field must be a UTF-8 encoded string
648
+ # with a length limit of 1024 characters.
254
649
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument] google_cloud_discoveryengine_v1alpha_document_object
255
650
  # @param [Boolean] allow_missing
256
651
  # If set to true, and the Document is not found, a new Document will be created.
@@ -518,8 +913,9 @@ module Google
518
913
  # Makes a recommendation, which requires a contextual user event.
519
914
  # @param [String] serving_config
520
915
  # 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.
916
+ # collections/*/dataStores/*/servingConfigs/* Before you can request
917
+ # recommendations from your model, you must create at least one serving config
918
+ # for it.
523
919
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendRequest] google_cloud_discoveryengine_v1alpha_recommend_request_object
524
920
  # @param [String] fields
525
921
  # Selector specifying which fields to include in a partial response.
@@ -556,7 +952,7 @@ module Google
556
952
  # Users should not call this method directly.
557
953
  # @param [String] parent
558
954
  # Required. The parent DataStore resource name, such as `projects/`project`/
559
- # locations/`location`/dataStores/`data_store``.
955
+ # locations/`location`/collections/`collection`/dataStores/`data_store``.
560
956
  # @param [Fixnum] ets
561
957
  # The event timestamp in milliseconds. This prevents browser caching of
562
958
  # otherwise identical get requests. The name is abbreviated to reduce the
@@ -605,7 +1001,7 @@ module Google
605
1001
  # metadata is of type ImportMetadata.
606
1002
  # @param [String] parent
607
1003
  # Required. Parent DataStore resource name, of the form `projects/`project`/
608
- # locations/`location`/dataStores/`data_store``
1004
+ # locations/`location`/collections/`collection`/dataStores/`data_store``
609
1005
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest] google_cloud_discoveryengine_v1alpha_import_user_events_request_object
610
1006
  # @param [String] fields
611
1007
  # Selector specifying which fields to include in a partial response.
@@ -639,7 +1035,7 @@ module Google
639
1035
  # Writes a single user event.
640
1036
  # @param [String] parent
641
1037
  # Required. The parent DataStore resource name, such as `projects/`project`/
642
- # locations/`location`/dataStores/`data_store``.
1038
+ # locations/`location`/collections/`collection`/dataStores/`data_store``.
643
1039
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent] google_cloud_discoveryengine_v1alpha_user_event_object
644
1040
  # @param [String] fields
645
1041
  # Selector specifying which fields to include in a partial response.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-discoveryengine_v1alpha
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.5.0
4
+ version: 0.6.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-02-26 00:00:00.000000000 Z
11
+ date: 2023-03-05 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1alpha/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1alpha/v0.5.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1alpha/v0.6.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1alpha
63
63
  post_install_message:
64
64
  rdoc_options: []