google-apis-discoveryengine_v1 0.8.0 → 0.10.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +9 -0
- data/lib/google/apis/discoveryengine_v1/classes.rb +4815 -1302
- data/lib/google/apis/discoveryengine_v1/gem_version.rb +3 -3
- data/lib/google/apis/discoveryengine_v1/representations.rb +2767 -1440
- data/lib/google/apis/discoveryengine_v1/service.rb +163 -2
- metadata +3 -3
@@ -239,6 +239,12 @@ module Google
|
|
239
239
|
# component of the DataStore's resource name. This field must conform to [RFC-
|
240
240
|
# 1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63
|
241
241
|
# characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
242
|
+
# @param [Boolean] skip_default_schema_creation
|
243
|
+
# A boolean flag indicating whether to skip the default schema creation for the
|
244
|
+
# data store. Only enable this flag if you are certain that the default schema
|
245
|
+
# is incompatible with your use case. If set to true, you must manually create a
|
246
|
+
# schema for the data store before any documents can be ingested. This flag
|
247
|
+
# cannot be specified if `data_store.starting_schema` is specified.
|
242
248
|
# @param [String] fields
|
243
249
|
# Selector specifying which fields to include in a partial response.
|
244
250
|
# @param [String] quota_user
|
@@ -256,7 +262,7 @@ module Google
|
|
256
262
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
257
263
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
258
264
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
259
|
-
def create_project_location_collection_data_store(parent, google_cloud_discoveryengine_v1_data_store_object = nil, create_advanced_site_search: nil, data_store_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
265
|
+
def create_project_location_collection_data_store(parent, google_cloud_discoveryengine_v1_data_store_object = nil, create_advanced_site_search: nil, data_store_id: nil, skip_default_schema_creation: nil, fields: nil, quota_user: nil, options: nil, &block)
|
260
266
|
command = make_simple_command(:post, 'v1/{+parent}/dataStores', options)
|
261
267
|
command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DataStore::Representation
|
262
268
|
command.request_object = google_cloud_discoveryengine_v1_data_store_object
|
@@ -265,6 +271,7 @@ module Google
|
|
265
271
|
command.params['parent'] = parent unless parent.nil?
|
266
272
|
command.query['createAdvancedSiteSearch'] = create_advanced_site_search unless create_advanced_site_search.nil?
|
267
273
|
command.query['dataStoreId'] = data_store_id unless data_store_id.nil?
|
274
|
+
command.query['skipDefaultSchemaCreation'] = skip_default_schema_creation unless skip_default_schema_creation.nil?
|
268
275
|
command.query['fields'] = fields unless fields.nil?
|
269
276
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
270
277
|
execute_or_queue_command(command, &block)
|
@@ -2781,6 +2788,44 @@ module Google
|
|
2781
2788
|
execute_or_queue_command(command, &block)
|
2782
2789
|
end
|
2783
2790
|
|
2791
|
+
# Deletes permanently all user events specified by the filter provided.
|
2792
|
+
# Depending on the number of events specified by the filter, this operation
|
2793
|
+
# could take hours or days to complete. To test a filter, use the list command
|
2794
|
+
# first.
|
2795
|
+
# @param [String] parent
|
2796
|
+
# Required. The resource name of the catalog under which the events are created.
|
2797
|
+
# The format is `projects/$`projectId`/locations/global/collections/`$
|
2798
|
+
# collectionId`/dataStores/$`dataStoreId``
|
2799
|
+
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeUserEventsRequest] google_cloud_discoveryengine_v1_purge_user_events_request_object
|
2800
|
+
# @param [String] fields
|
2801
|
+
# Selector specifying which fields to include in a partial response.
|
2802
|
+
# @param [String] quota_user
|
2803
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2804
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2805
|
+
# @param [Google::Apis::RequestOptions] options
|
2806
|
+
# Request-specific options
|
2807
|
+
#
|
2808
|
+
# @yield [result, err] Result & error if block supplied
|
2809
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation] parsed result object
|
2810
|
+
# @yieldparam err [StandardError] error object if request failed
|
2811
|
+
#
|
2812
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation]
|
2813
|
+
#
|
2814
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2815
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2816
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2817
|
+
def purge_project_location_collection_data_store_user_event(parent, google_cloud_discoveryengine_v1_purge_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2818
|
+
command = make_simple_command(:post, 'v1/{+parent}/userEvents:purge', options)
|
2819
|
+
command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeUserEventsRequest::Representation
|
2820
|
+
command.request_object = google_cloud_discoveryengine_v1_purge_user_events_request_object
|
2821
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
|
2822
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
|
2823
|
+
command.params['parent'] = parent unless parent.nil?
|
2824
|
+
command.query['fields'] = fields unless fields.nil?
|
2825
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2826
|
+
execute_or_queue_command(command, &block)
|
2827
|
+
end
|
2828
|
+
|
2784
2829
|
# Writes a single user event.
|
2785
2830
|
# @param [String] parent
|
2786
2831
|
# Required. The parent resource name. If the write user event action is applied
|
@@ -3991,6 +4036,12 @@ module Google
|
|
3991
4036
|
# component of the DataStore's resource name. This field must conform to [RFC-
|
3992
4037
|
# 1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63
|
3993
4038
|
# characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
4039
|
+
# @param [Boolean] skip_default_schema_creation
|
4040
|
+
# A boolean flag indicating whether to skip the default schema creation for the
|
4041
|
+
# data store. Only enable this flag if you are certain that the default schema
|
4042
|
+
# is incompatible with your use case. If set to true, you must manually create a
|
4043
|
+
# schema for the data store before any documents can be ingested. This flag
|
4044
|
+
# cannot be specified if `data_store.starting_schema` is specified.
|
3994
4045
|
# @param [String] fields
|
3995
4046
|
# Selector specifying which fields to include in a partial response.
|
3996
4047
|
# @param [String] quota_user
|
@@ -4008,7 +4059,7 @@ module Google
|
|
4008
4059
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
4009
4060
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
4010
4061
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
4011
|
-
def create_project_location_data_store(parent, google_cloud_discoveryengine_v1_data_store_object = nil, create_advanced_site_search: nil, data_store_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
4062
|
+
def create_project_location_data_store(parent, google_cloud_discoveryengine_v1_data_store_object = nil, create_advanced_site_search: nil, data_store_id: nil, skip_default_schema_creation: nil, fields: nil, quota_user: nil, options: nil, &block)
|
4012
4063
|
command = make_simple_command(:post, 'v1/{+parent}/dataStores', options)
|
4013
4064
|
command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DataStore::Representation
|
4014
4065
|
command.request_object = google_cloud_discoveryengine_v1_data_store_object
|
@@ -4017,6 +4068,7 @@ module Google
|
|
4017
4068
|
command.params['parent'] = parent unless parent.nil?
|
4018
4069
|
command.query['createAdvancedSiteSearch'] = create_advanced_site_search unless create_advanced_site_search.nil?
|
4019
4070
|
command.query['dataStoreId'] = data_store_id unless data_store_id.nil?
|
4071
|
+
command.query['skipDefaultSchemaCreation'] = skip_default_schema_creation unless skip_default_schema_creation.nil?
|
4020
4072
|
command.query['fields'] = fields unless fields.nil?
|
4021
4073
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
4022
4074
|
execute_or_queue_command(command, &block)
|
@@ -6239,6 +6291,44 @@ module Google
|
|
6239
6291
|
execute_or_queue_command(command, &block)
|
6240
6292
|
end
|
6241
6293
|
|
6294
|
+
# Deletes permanently all user events specified by the filter provided.
|
6295
|
+
# Depending on the number of events specified by the filter, this operation
|
6296
|
+
# could take hours or days to complete. To test a filter, use the list command
|
6297
|
+
# first.
|
6298
|
+
# @param [String] parent
|
6299
|
+
# Required. The resource name of the catalog under which the events are created.
|
6300
|
+
# The format is `projects/$`projectId`/locations/global/collections/`$
|
6301
|
+
# collectionId`/dataStores/$`dataStoreId``
|
6302
|
+
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeUserEventsRequest] google_cloud_discoveryengine_v1_purge_user_events_request_object
|
6303
|
+
# @param [String] fields
|
6304
|
+
# Selector specifying which fields to include in a partial response.
|
6305
|
+
# @param [String] quota_user
|
6306
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
6307
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
6308
|
+
# @param [Google::Apis::RequestOptions] options
|
6309
|
+
# Request-specific options
|
6310
|
+
#
|
6311
|
+
# @yield [result, err] Result & error if block supplied
|
6312
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation] parsed result object
|
6313
|
+
# @yieldparam err [StandardError] error object if request failed
|
6314
|
+
#
|
6315
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation]
|
6316
|
+
#
|
6317
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
6318
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
6319
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
6320
|
+
def purge_project_location_data_store_user_event(parent, google_cloud_discoveryengine_v1_purge_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
6321
|
+
command = make_simple_command(:post, 'v1/{+parent}/userEvents:purge', options)
|
6322
|
+
command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeUserEventsRequest::Representation
|
6323
|
+
command.request_object = google_cloud_discoveryengine_v1_purge_user_events_request_object
|
6324
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
|
6325
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
|
6326
|
+
command.params['parent'] = parent unless parent.nil?
|
6327
|
+
command.query['fields'] = fields unless fields.nil?
|
6328
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
6329
|
+
execute_or_queue_command(command, &block)
|
6330
|
+
end
|
6331
|
+
|
6242
6332
|
# Writes a single user event.
|
6243
6333
|
# @param [String] parent
|
6244
6334
|
# Required. The parent resource name. If the write user event action is applied
|
@@ -6315,6 +6405,77 @@ module Google
|
|
6315
6405
|
execute_or_queue_command(command, &block)
|
6316
6406
|
end
|
6317
6407
|
|
6408
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
6409
|
+
# to poll the operation result at intervals as recommended by the API service.
|
6410
|
+
# @param [String] name
|
6411
|
+
# The name of the operation resource.
|
6412
|
+
# @param [String] fields
|
6413
|
+
# Selector specifying which fields to include in a partial response.
|
6414
|
+
# @param [String] quota_user
|
6415
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
6416
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
6417
|
+
# @param [Google::Apis::RequestOptions] options
|
6418
|
+
# Request-specific options
|
6419
|
+
#
|
6420
|
+
# @yield [result, err] Result & error if block supplied
|
6421
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation] parsed result object
|
6422
|
+
# @yieldparam err [StandardError] error object if request failed
|
6423
|
+
#
|
6424
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation]
|
6425
|
+
#
|
6426
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
6427
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
6428
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
6429
|
+
def get_project_location_identity_mapping_store_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
6430
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
6431
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
|
6432
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
|
6433
|
+
command.params['name'] = name unless name.nil?
|
6434
|
+
command.query['fields'] = fields unless fields.nil?
|
6435
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
6436
|
+
execute_or_queue_command(command, &block)
|
6437
|
+
end
|
6438
|
+
|
6439
|
+
# Lists operations that match the specified filter in the request. If the server
|
6440
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`.
|
6441
|
+
# @param [String] name
|
6442
|
+
# The name of the operation's parent resource.
|
6443
|
+
# @param [String] filter
|
6444
|
+
# The standard list filter.
|
6445
|
+
# @param [Fixnum] page_size
|
6446
|
+
# The standard list page size.
|
6447
|
+
# @param [String] page_token
|
6448
|
+
# The standard list page token.
|
6449
|
+
# @param [String] fields
|
6450
|
+
# Selector specifying which fields to include in a partial response.
|
6451
|
+
# @param [String] quota_user
|
6452
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
6453
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
6454
|
+
# @param [Google::Apis::RequestOptions] options
|
6455
|
+
# Request-specific options
|
6456
|
+
#
|
6457
|
+
# @yield [result, err] Result & error if block supplied
|
6458
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse] parsed result object
|
6459
|
+
# @yieldparam err [StandardError] error object if request failed
|
6460
|
+
#
|
6461
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse]
|
6462
|
+
#
|
6463
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
6464
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
6465
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
6466
|
+
def list_project_location_identity_mapping_store_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
6467
|
+
command = make_simple_command(:get, 'v1/{+name}/operations', options)
|
6468
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse::Representation
|
6469
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningListOperationsResponse
|
6470
|
+
command.params['name'] = name unless name.nil?
|
6471
|
+
command.query['filter'] = filter unless filter.nil?
|
6472
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
6473
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
6474
|
+
command.query['fields'] = fields unless fields.nil?
|
6475
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
6476
|
+
execute_or_queue_command(command, &block)
|
6477
|
+
end
|
6478
|
+
|
6318
6479
|
# Gets the latest state of a long-running operation. Clients can use this method
|
6319
6480
|
# to poll the operation result at intervals as recommended by the API service.
|
6320
6481
|
# @param [String] name
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-discoveryengine_v1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.10.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2024-
|
11
|
+
date: 2024-08-04 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_v1/CHANGELOG.md
|
61
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1/v0.
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1/v0.10.0
|
62
62
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1
|
63
63
|
post_install_message:
|
64
64
|
rdoc_options: []
|