google-apis-discoveryengine_v1beta 0.12.0 → 0.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/lib/google/apis/discoveryengine_v1beta/classes.rb +609 -56
- data/lib/google/apis/discoveryengine_v1beta/gem_version.rb +2 -2
- data/lib/google/apis/discoveryengine_v1beta/representations.rb +233 -0
- data/lib/google/apis/discoveryengine_v1beta/service.rb +258 -38
- metadata +3 -3
@@ -57,12 +57,12 @@ module Google
|
|
57
57
|
# @param [String] document_id
|
58
58
|
# Required. The ID to use for the Document, which will become the final
|
59
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
|
63
|
-
# This field must conform to [RFC-1034](https://tools.ietf.org/html/
|
64
|
-
# standard with a length limit of 63 characters. Otherwise, an
|
65
|
-
# error is returned.
|
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
|
63
|
+
# returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/
|
64
|
+
# rfc1034) standard with a length limit of 63 characters. Otherwise, an `
|
65
|
+
# INVALID_ARGUMENT` error is returned.
|
66
66
|
# @param [String] fields
|
67
67
|
# Selector specifying which fields to include in a partial response.
|
68
68
|
# @param [String] quota_user
|
@@ -98,9 +98,9 @@ module Google
|
|
98
98
|
# Required. Full resource name of Document, such as `projects/`project`/
|
99
99
|
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
100
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.
|
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
104
|
# @param [String] fields
|
105
105
|
# Selector specifying which fields to include in a partial response.
|
106
106
|
# @param [String] quota_user
|
@@ -133,9 +133,9 @@ module Google
|
|
133
133
|
# Required. Full resource name of Document, such as `projects/`project`/
|
134
134
|
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
135
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.
|
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
139
|
# @param [String] fields
|
140
140
|
# Selector specifying which fields to include in a partial response.
|
141
141
|
# @param [String] quota_user
|
@@ -206,18 +206,18 @@ module Google
|
|
206
206
|
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
207
207
|
# `branch``. Use `default_branch` as the branch ID, to list documents under the
|
208
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.
|
209
|
+
# under this branch, regardless of whether or not this branch exists, a `
|
210
|
+
# PERMISSION_DENIED` error is returned.
|
211
211
|
# @param [Fixnum] page_size
|
212
212
|
# Maximum number of Documents to return. If unspecified, defaults to 100. The
|
213
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.
|
214
|
+
# this field is negative, an `INVALID_ARGUMENT` error is returned.
|
215
215
|
# @param [String] page_token
|
216
216
|
# A page token ListDocumentsResponse.next_page_token, received from a previous
|
217
217
|
# DocumentService.ListDocuments call. Provide this to retrieve the subsequent
|
218
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.
|
219
|
+
# ListDocuments must match the call that provided the page token. Otherwise, an `
|
220
|
+
# INVALID_ARGUMENT` error is returned.
|
221
221
|
# @param [String] fields
|
222
222
|
# Selector specifying which fields to include in a partial response.
|
223
223
|
# @param [String] quota_user
|
@@ -286,6 +286,45 @@ module Google
|
|
286
286
|
execute_or_queue_command(command, &block)
|
287
287
|
end
|
288
288
|
|
289
|
+
# Permanently deletes all selected Documents in a branch. This process is
|
290
|
+
# asynchronous. Depending on the number of Documents to be deleted, this
|
291
|
+
# operation can take hours to complete. Before the delete operation completes,
|
292
|
+
# some Documents might still be returned by DocumentService.GetDocument or
|
293
|
+
# DocumentService.ListDocuments. To get a list of the Documents to be deleted,
|
294
|
+
# set PurgeDocumentsRequest.force to false.
|
295
|
+
# @param [String] parent
|
296
|
+
# Required. The parent resource name, such as `projects/`project`/locations/`
|
297
|
+
# location`/collections/`collection`/dataStores/`data_store`/branches/`branch``.
|
298
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest] google_cloud_discoveryengine_v1beta_purge_documents_request_object
|
299
|
+
# @param [String] fields
|
300
|
+
# Selector specifying which fields to include in a partial response.
|
301
|
+
# @param [String] quota_user
|
302
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
303
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
304
|
+
# @param [Google::Apis::RequestOptions] options
|
305
|
+
# Request-specific options
|
306
|
+
#
|
307
|
+
# @yield [result, err] Result & error if block supplied
|
308
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
309
|
+
# @yieldparam err [StandardError] error object if request failed
|
310
|
+
#
|
311
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
312
|
+
#
|
313
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
314
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
315
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
316
|
+
def purge_project_location_collection_data_store_branch_document(parent, google_cloud_discoveryengine_v1beta_purge_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
317
|
+
command = make_simple_command(:post, 'v1beta/{+parent}/documents:purge', options)
|
318
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest::Representation
|
319
|
+
command.request_object = google_cloud_discoveryengine_v1beta_purge_documents_request_object
|
320
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
321
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
322
|
+
command.params['parent'] = parent unless parent.nil?
|
323
|
+
command.query['fields'] = fields unless fields.nil?
|
324
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
325
|
+
execute_or_queue_command(command, &block)
|
326
|
+
end
|
327
|
+
|
289
328
|
# Gets the latest state of a long-running operation. Clients can use this method
|
290
329
|
# to poll the operation result at intervals as recommended by the API service.
|
291
330
|
# @param [String] name
|
@@ -499,10 +538,81 @@ module Google
|
|
499
538
|
execute_or_queue_command(command, &block)
|
500
539
|
end
|
501
540
|
|
541
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
542
|
+
# to poll the operation result at intervals as recommended by the API service.
|
543
|
+
# @param [String] name
|
544
|
+
# The name of the operation resource.
|
545
|
+
# @param [String] fields
|
546
|
+
# Selector specifying which fields to include in a partial response.
|
547
|
+
# @param [String] quota_user
|
548
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
549
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
550
|
+
# @param [Google::Apis::RequestOptions] options
|
551
|
+
# Request-specific options
|
552
|
+
#
|
553
|
+
# @yield [result, err] Result & error if block supplied
|
554
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
555
|
+
# @yieldparam err [StandardError] error object if request failed
|
556
|
+
#
|
557
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
558
|
+
#
|
559
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
560
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
561
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
562
|
+
def get_project_location_collection_data_store_schema_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
563
|
+
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
564
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
565
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
566
|
+
command.params['name'] = name unless name.nil?
|
567
|
+
command.query['fields'] = fields unless fields.nil?
|
568
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
569
|
+
execute_or_queue_command(command, &block)
|
570
|
+
end
|
571
|
+
|
572
|
+
# Lists operations that match the specified filter in the request. If the server
|
573
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`.
|
574
|
+
# @param [String] name
|
575
|
+
# The name of the operation's parent resource.
|
576
|
+
# @param [String] filter
|
577
|
+
# The standard list filter.
|
578
|
+
# @param [Fixnum] page_size
|
579
|
+
# The standard list page size.
|
580
|
+
# @param [String] page_token
|
581
|
+
# The standard list page token.
|
582
|
+
# @param [String] fields
|
583
|
+
# Selector specifying which fields to include in a partial response.
|
584
|
+
# @param [String] quota_user
|
585
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
586
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
587
|
+
# @param [Google::Apis::RequestOptions] options
|
588
|
+
# Request-specific options
|
589
|
+
#
|
590
|
+
# @yield [result, err] Result & error if block supplied
|
591
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse] parsed result object
|
592
|
+
# @yieldparam err [StandardError] error object if request failed
|
593
|
+
#
|
594
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse]
|
595
|
+
#
|
596
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
597
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
598
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
599
|
+
def list_project_location_collection_data_store_schema_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
600
|
+
command = make_simple_command(:get, 'v1beta/{+name}/operations', options)
|
601
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse::Representation
|
602
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse
|
603
|
+
command.params['name'] = name unless name.nil?
|
604
|
+
command.query['filter'] = filter unless filter.nil?
|
605
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
606
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
607
|
+
command.query['fields'] = fields unless fields.nil?
|
608
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
609
|
+
execute_or_queue_command(command, &block)
|
610
|
+
end
|
611
|
+
|
502
612
|
# Makes a recommendation, which requires a contextual user event.
|
503
613
|
# @param [String] serving_config
|
504
|
-
# Required. Full resource name of the format: projects/*/locations/global/
|
505
|
-
# collections/*/dataStores/*/servingConfigs
|
614
|
+
# Required. Full resource name of the format: `projects/*/locations/global/
|
615
|
+
# collections/*/dataStores/*/servingConfigs/*` Before you can request
|
506
616
|
# recommendations from your model, you must create at least one serving config
|
507
617
|
# for it.
|
508
618
|
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendRequest] google_cloud_discoveryengine_v1beta_recommend_request_object
|
@@ -655,6 +765,77 @@ module Google
|
|
655
765
|
execute_or_queue_command(command, &block)
|
656
766
|
end
|
657
767
|
|
768
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
769
|
+
# to poll the operation result at intervals as recommended by the API service.
|
770
|
+
# @param [String] name
|
771
|
+
# The name of the operation resource.
|
772
|
+
# @param [String] fields
|
773
|
+
# Selector specifying which fields to include in a partial response.
|
774
|
+
# @param [String] quota_user
|
775
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
776
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
777
|
+
# @param [Google::Apis::RequestOptions] options
|
778
|
+
# Request-specific options
|
779
|
+
#
|
780
|
+
# @yield [result, err] Result & error if block supplied
|
781
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
782
|
+
# @yieldparam err [StandardError] error object if request failed
|
783
|
+
#
|
784
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
785
|
+
#
|
786
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
787
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
788
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
789
|
+
def get_project_location_collection_engine_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
790
|
+
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
791
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
792
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
793
|
+
command.params['name'] = name unless name.nil?
|
794
|
+
command.query['fields'] = fields unless fields.nil?
|
795
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
796
|
+
execute_or_queue_command(command, &block)
|
797
|
+
end
|
798
|
+
|
799
|
+
# Lists operations that match the specified filter in the request. If the server
|
800
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`.
|
801
|
+
# @param [String] name
|
802
|
+
# The name of the operation's parent resource.
|
803
|
+
# @param [String] filter
|
804
|
+
# The standard list filter.
|
805
|
+
# @param [Fixnum] page_size
|
806
|
+
# The standard list page size.
|
807
|
+
# @param [String] page_token
|
808
|
+
# The standard list page token.
|
809
|
+
# @param [String] fields
|
810
|
+
# Selector specifying which fields to include in a partial response.
|
811
|
+
# @param [String] quota_user
|
812
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
813
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
814
|
+
# @param [Google::Apis::RequestOptions] options
|
815
|
+
# Request-specific options
|
816
|
+
#
|
817
|
+
# @yield [result, err] Result & error if block supplied
|
818
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse] parsed result object
|
819
|
+
# @yieldparam err [StandardError] error object if request failed
|
820
|
+
#
|
821
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse]
|
822
|
+
#
|
823
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
824
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
825
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
826
|
+
def list_project_location_collection_engine_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
827
|
+
command = make_simple_command(:get, 'v1beta/{+name}/operations', options)
|
828
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse::Representation
|
829
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse
|
830
|
+
command.params['name'] = name unless name.nil?
|
831
|
+
command.query['filter'] = filter unless filter.nil?
|
832
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
833
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
834
|
+
command.query['fields'] = fields unless fields.nil?
|
835
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
836
|
+
execute_or_queue_command(command, &block)
|
837
|
+
end
|
838
|
+
|
658
839
|
# Gets the latest state of a long-running operation. Clients can use this method
|
659
840
|
# to poll the operation result at intervals as recommended by the API service.
|
660
841
|
# @param [String] name
|
@@ -734,12 +915,12 @@ module Google
|
|
734
915
|
# @param [String] document_id
|
735
916
|
# Required. The ID to use for the Document, which will become the final
|
736
917
|
# component of the Document.name. If the caller does not have permission to
|
737
|
-
# create the Document, regardless of whether or not it exists, a
|
738
|
-
# PERMISSION_DENIED error is returned. This field must be unique among all
|
739
|
-
# Documents with the same parent. Otherwise, an ALREADY_EXISTS error is
|
740
|
-
# This field must conform to [RFC-1034](https://tools.ietf.org/html/
|
741
|
-
# standard with a length limit of 63 characters. Otherwise, an
|
742
|
-
# error is returned.
|
918
|
+
# create the Document, regardless of whether or not it exists, a `
|
919
|
+
# PERMISSION_DENIED` error is returned. This field must be unique among all
|
920
|
+
# Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is
|
921
|
+
# returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/
|
922
|
+
# rfc1034) standard with a length limit of 63 characters. Otherwise, an `
|
923
|
+
# INVALID_ARGUMENT` error is returned.
|
743
924
|
# @param [String] fields
|
744
925
|
# Selector specifying which fields to include in a partial response.
|
745
926
|
# @param [String] quota_user
|
@@ -775,9 +956,9 @@ module Google
|
|
775
956
|
# Required. Full resource name of Document, such as `projects/`project`/
|
776
957
|
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
777
958
|
# `branch`/documents/`document``. If the caller does not have permission to
|
778
|
-
# delete the Document, regardless of whether or not it exists, a
|
779
|
-
# PERMISSION_DENIED error is returned. If the Document to delete does not exist,
|
780
|
-
# a NOT_FOUND error is returned.
|
959
|
+
# delete the Document, regardless of whether or not it exists, a `
|
960
|
+
# PERMISSION_DENIED` error is returned. If the Document to delete does not exist,
|
961
|
+
# a `NOT_FOUND` error is returned.
|
781
962
|
# @param [String] fields
|
782
963
|
# Selector specifying which fields to include in a partial response.
|
783
964
|
# @param [String] quota_user
|
@@ -810,9 +991,9 @@ module Google
|
|
810
991
|
# Required. Full resource name of Document, such as `projects/`project`/
|
811
992
|
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
812
993
|
# `branch`/documents/`document``. If the caller does not have permission to
|
813
|
-
# access the Document, regardless of whether or not it exists, a
|
814
|
-
# PERMISSION_DENIED error is returned. If the requested Document does not exist,
|
815
|
-
# a NOT_FOUND error is returned.
|
994
|
+
# access the Document, regardless of whether or not it exists, a `
|
995
|
+
# PERMISSION_DENIED` error is returned. If the requested Document does not exist,
|
996
|
+
# a `NOT_FOUND` error is returned.
|
816
997
|
# @param [String] fields
|
817
998
|
# Selector specifying which fields to include in a partial response.
|
818
999
|
# @param [String] quota_user
|
@@ -883,18 +1064,18 @@ module Google
|
|
883
1064
|
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
884
1065
|
# `branch``. Use `default_branch` as the branch ID, to list documents under the
|
885
1066
|
# default branch. If the caller does not have permission to list Documentss
|
886
|
-
# under this branch, regardless of whether or not this branch exists, a
|
887
|
-
# PERMISSION_DENIED error is returned.
|
1067
|
+
# under this branch, regardless of whether or not this branch exists, a `
|
1068
|
+
# PERMISSION_DENIED` error is returned.
|
888
1069
|
# @param [Fixnum] page_size
|
889
1070
|
# Maximum number of Documents to return. If unspecified, defaults to 100. The
|
890
1071
|
# maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If
|
891
|
-
# this field is negative, an INVALID_ARGUMENT error is returned.
|
1072
|
+
# this field is negative, an `INVALID_ARGUMENT` error is returned.
|
892
1073
|
# @param [String] page_token
|
893
1074
|
# A page token ListDocumentsResponse.next_page_token, received from a previous
|
894
1075
|
# DocumentService.ListDocuments call. Provide this to retrieve the subsequent
|
895
1076
|
# page. When paginating, all other parameters provided to DocumentService.
|
896
|
-
# ListDocuments must match the call that provided the page token. Otherwise, an
|
897
|
-
# INVALID_ARGUMENT error is returned.
|
1077
|
+
# ListDocuments must match the call that provided the page token. Otherwise, an `
|
1078
|
+
# INVALID_ARGUMENT` error is returned.
|
898
1079
|
# @param [String] fields
|
899
1080
|
# Selector specifying which fields to include in a partial response.
|
900
1081
|
# @param [String] quota_user
|
@@ -963,6 +1144,45 @@ module Google
|
|
963
1144
|
execute_or_queue_command(command, &block)
|
964
1145
|
end
|
965
1146
|
|
1147
|
+
# Permanently deletes all selected Documents in a branch. This process is
|
1148
|
+
# asynchronous. Depending on the number of Documents to be deleted, this
|
1149
|
+
# operation can take hours to complete. Before the delete operation completes,
|
1150
|
+
# some Documents might still be returned by DocumentService.GetDocument or
|
1151
|
+
# DocumentService.ListDocuments. To get a list of the Documents to be deleted,
|
1152
|
+
# set PurgeDocumentsRequest.force to false.
|
1153
|
+
# @param [String] parent
|
1154
|
+
# Required. The parent resource name, such as `projects/`project`/locations/`
|
1155
|
+
# location`/collections/`collection`/dataStores/`data_store`/branches/`branch``.
|
1156
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest] google_cloud_discoveryengine_v1beta_purge_documents_request_object
|
1157
|
+
# @param [String] fields
|
1158
|
+
# Selector specifying which fields to include in a partial response.
|
1159
|
+
# @param [String] quota_user
|
1160
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1161
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1162
|
+
# @param [Google::Apis::RequestOptions] options
|
1163
|
+
# Request-specific options
|
1164
|
+
#
|
1165
|
+
# @yield [result, err] Result & error if block supplied
|
1166
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
1167
|
+
# @yieldparam err [StandardError] error object if request failed
|
1168
|
+
#
|
1169
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
1170
|
+
#
|
1171
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1172
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1173
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1174
|
+
def purge_project_location_data_store_branch_document(parent, google_cloud_discoveryengine_v1beta_purge_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1175
|
+
command = make_simple_command(:post, 'v1beta/{+parent}/documents:purge', options)
|
1176
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest::Representation
|
1177
|
+
command.request_object = google_cloud_discoveryengine_v1beta_purge_documents_request_object
|
1178
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
1179
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
1180
|
+
command.params['parent'] = parent unless parent.nil?
|
1181
|
+
command.query['fields'] = fields unless fields.nil?
|
1182
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1183
|
+
execute_or_queue_command(command, &block)
|
1184
|
+
end
|
1185
|
+
|
966
1186
|
# Gets the latest state of a long-running operation. Clients can use this method
|
967
1187
|
# to poll the operation result at intervals as recommended by the API service.
|
968
1188
|
# @param [String] name
|
@@ -1178,8 +1398,8 @@ module Google
|
|
1178
1398
|
|
1179
1399
|
# Makes a recommendation, which requires a contextual user event.
|
1180
1400
|
# @param [String] serving_config
|
1181
|
-
# Required. Full resource name of the format: projects/*/locations/global/
|
1182
|
-
# collections/*/dataStores/*/servingConfigs
|
1401
|
+
# Required. Full resource name of the format: `projects/*/locations/global/
|
1402
|
+
# collections/*/dataStores/*/servingConfigs/*` Before you can request
|
1183
1403
|
# recommendations from your model, you must create at least one serving config
|
1184
1404
|
# for it.
|
1185
1405
|
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendRequest] google_cloud_discoveryengine_v1beta_recommend_request_object
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-discoveryengine_v1beta
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.14.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-
|
11
|
+
date: 2023-05-28 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_v1beta/CHANGELOG.md
|
61
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1beta/v0.
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1beta/v0.14.0
|
62
62
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1beta
|
63
63
|
post_install_message:
|
64
64
|
rdoc_options: []
|