google-apis-discoveryengine_v1beta 0.44.0 → 0.46.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_v1beta/classes.rb +1360 -167
- data/lib/google/apis/discoveryengine_v1beta/gem_version.rb +3 -3
- data/lib/google/apis/discoveryengine_v1beta/representations.rb +522 -0
- data/lib/google/apis/discoveryengine_v1beta/service.rb +766 -64
- metadata +5 -5
|
@@ -51,6 +51,43 @@ module Google
|
|
|
51
51
|
@batch_path = 'batch'
|
|
52
52
|
end
|
|
53
53
|
|
|
54
|
+
# Provisions the project resource. During the process, related systems will get
|
|
55
|
+
# prepared and initialized. Caller must read the [Terms for data use](https://
|
|
56
|
+
# cloud.google.com/retail/data-use-terms), and optionally specify in request to
|
|
57
|
+
# provide consent to that service terms.
|
|
58
|
+
# @param [String] name
|
|
59
|
+
# Required. Full resource name of a Project, such as `projects/`
|
|
60
|
+
# project_id_or_number``.
|
|
61
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaProvisionProjectRequest] google_cloud_discoveryengine_v1beta_provision_project_request_object
|
|
62
|
+
# @param [String] fields
|
|
63
|
+
# Selector specifying which fields to include in a partial response.
|
|
64
|
+
# @param [String] quota_user
|
|
65
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
66
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
67
|
+
# @param [Google::Apis::RequestOptions] options
|
|
68
|
+
# Request-specific options
|
|
69
|
+
#
|
|
70
|
+
# @yield [result, err] Result & error if block supplied
|
|
71
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
|
72
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
73
|
+
#
|
|
74
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
|
75
|
+
#
|
|
76
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
77
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
78
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
79
|
+
def provision_project(name, google_cloud_discoveryengine_v1beta_provision_project_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
80
|
+
command = make_simple_command(:post, 'v1beta/{+name}:provision', options)
|
|
81
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaProvisionProjectRequest::Representation
|
|
82
|
+
command.request_object = google_cloud_discoveryengine_v1beta_provision_project_request_object
|
|
83
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
|
84
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
|
85
|
+
command.params['name'] = name unless name.nil?
|
|
86
|
+
command.query['fields'] = fields unless fields.nil?
|
|
87
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
88
|
+
execute_or_queue_command(command, &block)
|
|
89
|
+
end
|
|
90
|
+
|
|
54
91
|
# Gets the latest state of a long-running operation. Clients can use this method
|
|
55
92
|
# to poll the operation result at intervals as recommended by the API service.
|
|
56
93
|
# @param [String] name
|
|
@@ -342,8 +379,8 @@ module Google
|
|
|
342
379
|
# permission to list DataStores under this location, regardless of whether or
|
|
343
380
|
# not this data store exists, a PERMISSION_DENIED error is returned.
|
|
344
381
|
# @param [String] filter
|
|
345
|
-
# Filter by solution type . For example: filter = 'solution_type:
|
|
346
|
-
# SOLUTION_TYPE_SEARCH'
|
|
382
|
+
# Filter by solution type . For example: `filter = 'solution_type:
|
|
383
|
+
# SOLUTION_TYPE_SEARCH'`
|
|
347
384
|
# @param [Fixnum] page_size
|
|
348
385
|
# Maximum number of DataStores to return. If unspecified, defaults to 10. The
|
|
349
386
|
# maximum allowed value is 50. Values above 50 will be coerced to 50. If this
|
|
@@ -465,14 +502,14 @@ module Google
|
|
|
465
502
|
# location`/collections/`collection`/dataStores/`data_store`/branches/`branch``.
|
|
466
503
|
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument] google_cloud_discoveryengine_v1beta_document_object
|
|
467
504
|
# @param [String] document_id
|
|
468
|
-
# Required. The ID to use for the Document, which
|
|
469
|
-
#
|
|
470
|
-
#
|
|
471
|
-
#
|
|
472
|
-
#
|
|
473
|
-
#
|
|
474
|
-
#
|
|
475
|
-
#
|
|
505
|
+
# Required. The ID to use for the Document, which becomes the final component of
|
|
506
|
+
# the Document.name. If the caller does not have permission to create the
|
|
507
|
+
# Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error
|
|
508
|
+
# is returned. This field must be unique among all Documents with the same
|
|
509
|
+
# parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must
|
|
510
|
+
# conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a
|
|
511
|
+
# length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is
|
|
512
|
+
# returned.
|
|
476
513
|
# @param [String] fields
|
|
477
514
|
# Selector specifying which fields to include in a partial response.
|
|
478
515
|
# @param [String] quota_user
|
|
@@ -574,8 +611,8 @@ module Google
|
|
|
574
611
|
end
|
|
575
612
|
|
|
576
613
|
# Bulk import of multiple Documents. Request processing may be synchronous. Non-
|
|
577
|
-
# existing items
|
|
578
|
-
#
|
|
614
|
+
# existing items are created. Note: It is possible for a subset of the Documents
|
|
615
|
+
# to be successfully updated.
|
|
579
616
|
# @param [String] parent
|
|
580
617
|
# Required. The parent branch resource name, such as `projects/`project`/
|
|
581
618
|
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
|
@@ -620,8 +657,8 @@ module Google
|
|
|
620
657
|
# PERMISSION_DENIED` error is returned.
|
|
621
658
|
# @param [Fixnum] page_size
|
|
622
659
|
# Maximum number of Documents to return. If unspecified, defaults to 100. The
|
|
623
|
-
# maximum allowed value is 1000. Values above 1000
|
|
624
|
-
#
|
|
660
|
+
# maximum allowed value is 1000. Values above 1000 are set to 1000. If this
|
|
661
|
+
# field is negative, an `INVALID_ARGUMENT` error is returned.
|
|
625
662
|
# @param [String] page_token
|
|
626
663
|
# A page token ListDocumentsResponse.next_page_token, received from a previous
|
|
627
664
|
# DocumentService.ListDocuments call. Provide this to retrieve the subsequent
|
|
@@ -665,10 +702,10 @@ module Google
|
|
|
665
702
|
# with a length limit of 1024 characters.
|
|
666
703
|
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument] google_cloud_discoveryengine_v1beta_document_object
|
|
667
704
|
# @param [Boolean] allow_missing
|
|
668
|
-
# If set to true
|
|
705
|
+
# If set to `true` and the Document is not found, a new Document is be created.
|
|
669
706
|
# @param [String] update_mask
|
|
670
707
|
# Indicates which fields in the provided imported 'document' to update. If not
|
|
671
|
-
# set,
|
|
708
|
+
# set, by default updates all fields.
|
|
672
709
|
# @param [String] fields
|
|
673
710
|
# Selector specifying which fields to include in a partial response.
|
|
674
711
|
# @param [String] quota_user
|
|
@@ -739,6 +776,46 @@ module Google
|
|
|
739
776
|
execute_or_queue_command(command, &block)
|
|
740
777
|
end
|
|
741
778
|
|
|
779
|
+
# Starts asynchronous cancellation on a long-running operation. The server makes
|
|
780
|
+
# a best effort to cancel the operation, but success is not guaranteed. If the
|
|
781
|
+
# server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
|
|
782
|
+
# Clients can use Operations.GetOperation or other methods to check whether the
|
|
783
|
+
# cancellation succeeded or whether the operation completed despite cancellation.
|
|
784
|
+
# On successful cancellation, the operation is not deleted; instead, it becomes
|
|
785
|
+
# an operation with an Operation.error value with a google.rpc.Status.code of 1,
|
|
786
|
+
# corresponding to `Code.CANCELLED`.
|
|
787
|
+
# @param [String] name
|
|
788
|
+
# The name of the operation resource to be cancelled.
|
|
789
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningCancelOperationRequest] google_longrunning_cancel_operation_request_object
|
|
790
|
+
# @param [String] fields
|
|
791
|
+
# Selector specifying which fields to include in a partial response.
|
|
792
|
+
# @param [String] quota_user
|
|
793
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
794
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
795
|
+
# @param [Google::Apis::RequestOptions] options
|
|
796
|
+
# Request-specific options
|
|
797
|
+
#
|
|
798
|
+
# @yield [result, err] Result & error if block supplied
|
|
799
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty] parsed result object
|
|
800
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
801
|
+
#
|
|
802
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty]
|
|
803
|
+
#
|
|
804
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
805
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
806
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
807
|
+
def cancel_project_location_collection_data_store_branch_operation(name, google_longrunning_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
808
|
+
command = make_simple_command(:post, 'v1beta/{+name}:cancel', options)
|
|
809
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningCancelOperationRequest::Representation
|
|
810
|
+
command.request_object = google_longrunning_cancel_operation_request_object
|
|
811
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty::Representation
|
|
812
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty
|
|
813
|
+
command.params['name'] = name unless name.nil?
|
|
814
|
+
command.query['fields'] = fields unless fields.nil?
|
|
815
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
816
|
+
execute_or_queue_command(command, &block)
|
|
817
|
+
end
|
|
818
|
+
|
|
742
819
|
# Gets the latest state of a long-running operation. Clients can use this method
|
|
743
820
|
# to poll the operation result at intervals as recommended by the API service.
|
|
744
821
|
# @param [String] name
|
|
@@ -810,6 +887,197 @@ module Google
|
|
|
810
887
|
execute_or_queue_command(command, &block)
|
|
811
888
|
end
|
|
812
889
|
|
|
890
|
+
# Creates a Control. By default 1000 controls are allowed for a data store. A
|
|
891
|
+
# request can be submitted to adjust this limit. If the Control to create
|
|
892
|
+
# already exists, an ALREADY_EXISTS error is returned.
|
|
893
|
+
# @param [String] parent
|
|
894
|
+
# Required. Full resource name of parent data store. Format: `projects/`
|
|
895
|
+
# project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
|
|
896
|
+
# `data_store_id``
|
|
897
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl] google_cloud_discoveryengine_v1beta_control_object
|
|
898
|
+
# @param [String] control_id
|
|
899
|
+
# Required. The ID to use for the Control, which will become the final component
|
|
900
|
+
# of the Control's resource name. This value must be within 1-63 characters.
|
|
901
|
+
# Valid characters are /a-z-_/.
|
|
902
|
+
# @param [String] fields
|
|
903
|
+
# Selector specifying which fields to include in a partial response.
|
|
904
|
+
# @param [String] quota_user
|
|
905
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
906
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
907
|
+
# @param [Google::Apis::RequestOptions] options
|
|
908
|
+
# Request-specific options
|
|
909
|
+
#
|
|
910
|
+
# @yield [result, err] Result & error if block supplied
|
|
911
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl] parsed result object
|
|
912
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
913
|
+
#
|
|
914
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl]
|
|
915
|
+
#
|
|
916
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
917
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
918
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
919
|
+
def create_project_location_collection_data_store_control(parent, google_cloud_discoveryengine_v1beta_control_object = nil, control_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
920
|
+
command = make_simple_command(:post, 'v1beta/{+parent}/controls', options)
|
|
921
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl::Representation
|
|
922
|
+
command.request_object = google_cloud_discoveryengine_v1beta_control_object
|
|
923
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl::Representation
|
|
924
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl
|
|
925
|
+
command.params['parent'] = parent unless parent.nil?
|
|
926
|
+
command.query['controlId'] = control_id unless control_id.nil?
|
|
927
|
+
command.query['fields'] = fields unless fields.nil?
|
|
928
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
929
|
+
execute_or_queue_command(command, &block)
|
|
930
|
+
end
|
|
931
|
+
|
|
932
|
+
# Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error
|
|
933
|
+
# is returned.
|
|
934
|
+
# @param [String] name
|
|
935
|
+
# Required. The resource name of the Control to delete. Format: `projects/`
|
|
936
|
+
# project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
|
|
937
|
+
# `data_store_id`/controls/`control_id``
|
|
938
|
+
# @param [String] fields
|
|
939
|
+
# Selector specifying which fields to include in a partial response.
|
|
940
|
+
# @param [String] quota_user
|
|
941
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
942
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
943
|
+
# @param [Google::Apis::RequestOptions] options
|
|
944
|
+
# Request-specific options
|
|
945
|
+
#
|
|
946
|
+
# @yield [result, err] Result & error if block supplied
|
|
947
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty] parsed result object
|
|
948
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
949
|
+
#
|
|
950
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty]
|
|
951
|
+
#
|
|
952
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
953
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
954
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
955
|
+
def delete_project_location_collection_data_store_control(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
956
|
+
command = make_simple_command(:delete, 'v1beta/{+name}', options)
|
|
957
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty::Representation
|
|
958
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty
|
|
959
|
+
command.params['name'] = name unless name.nil?
|
|
960
|
+
command.query['fields'] = fields unless fields.nil?
|
|
961
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
962
|
+
execute_or_queue_command(command, &block)
|
|
963
|
+
end
|
|
964
|
+
|
|
965
|
+
# Gets a Control.
|
|
966
|
+
# @param [String] name
|
|
967
|
+
# Required. The resource name of the Control to get. Format: `projects/`
|
|
968
|
+
# project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
|
|
969
|
+
# `data_store_id`/controls/`control_id``
|
|
970
|
+
# @param [String] fields
|
|
971
|
+
# Selector specifying which fields to include in a partial response.
|
|
972
|
+
# @param [String] quota_user
|
|
973
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
974
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
975
|
+
# @param [Google::Apis::RequestOptions] options
|
|
976
|
+
# Request-specific options
|
|
977
|
+
#
|
|
978
|
+
# @yield [result, err] Result & error if block supplied
|
|
979
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl] parsed result object
|
|
980
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
981
|
+
#
|
|
982
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl]
|
|
983
|
+
#
|
|
984
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
985
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
986
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
987
|
+
def get_project_location_collection_data_store_control(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
988
|
+
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
|
989
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl::Representation
|
|
990
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl
|
|
991
|
+
command.params['name'] = name unless name.nil?
|
|
992
|
+
command.query['fields'] = fields unless fields.nil?
|
|
993
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
994
|
+
execute_or_queue_command(command, &block)
|
|
995
|
+
end
|
|
996
|
+
|
|
997
|
+
# Lists all Controls by their parent DataStore.
|
|
998
|
+
# @param [String] parent
|
|
999
|
+
# Required. The data store resource name. Format: `projects/`project_number`/
|
|
1000
|
+
# locations/`location_id`/collections/`collection_id`/dataStores/`data_store_id``
|
|
1001
|
+
# @param [String] filter
|
|
1002
|
+
# Optional. A filter to apply on the list results. Supported features: * List
|
|
1003
|
+
# all the products under the parent branch if filter is unset. Currently this
|
|
1004
|
+
# field is unsupported.
|
|
1005
|
+
# @param [Fixnum] page_size
|
|
1006
|
+
# Optional. Maximum number of results to return. If unspecified, defaults to 50.
|
|
1007
|
+
# Max allowed value is 1000.
|
|
1008
|
+
# @param [String] page_token
|
|
1009
|
+
# Optional. A page token, received from a previous `ListControls` call. Provide
|
|
1010
|
+
# this to retrieve the subsequent page.
|
|
1011
|
+
# @param [String] fields
|
|
1012
|
+
# Selector specifying which fields to include in a partial response.
|
|
1013
|
+
# @param [String] quota_user
|
|
1014
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1015
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1016
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1017
|
+
# Request-specific options
|
|
1018
|
+
#
|
|
1019
|
+
# @yield [result, err] Result & error if block supplied
|
|
1020
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListControlsResponse] parsed result object
|
|
1021
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1022
|
+
#
|
|
1023
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListControlsResponse]
|
|
1024
|
+
#
|
|
1025
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1026
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1027
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1028
|
+
def list_project_location_collection_data_store_controls(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1029
|
+
command = make_simple_command(:get, 'v1beta/{+parent}/controls', options)
|
|
1030
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListControlsResponse::Representation
|
|
1031
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListControlsResponse
|
|
1032
|
+
command.params['parent'] = parent unless parent.nil?
|
|
1033
|
+
command.query['filter'] = filter unless filter.nil?
|
|
1034
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
1035
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
1036
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1037
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1038
|
+
execute_or_queue_command(command, &block)
|
|
1039
|
+
end
|
|
1040
|
+
|
|
1041
|
+
# Updates a Control. Control action type cannot be changed. If the Control to
|
|
1042
|
+
# update does not exist, a NOT_FOUND error is returned.
|
|
1043
|
+
# @param [String] name
|
|
1044
|
+
# Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/
|
|
1045
|
+
# controls/*`
|
|
1046
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl] google_cloud_discoveryengine_v1beta_control_object
|
|
1047
|
+
# @param [String] update_mask
|
|
1048
|
+
# Optional. Indicates which fields in the provided Control to update. The
|
|
1049
|
+
# following are NOT supported: * Control.name * Control.solution_type If not set
|
|
1050
|
+
# or empty, all supported fields are updated.
|
|
1051
|
+
# @param [String] fields
|
|
1052
|
+
# Selector specifying which fields to include in a partial response.
|
|
1053
|
+
# @param [String] quota_user
|
|
1054
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1055
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1056
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1057
|
+
# Request-specific options
|
|
1058
|
+
#
|
|
1059
|
+
# @yield [result, err] Result & error if block supplied
|
|
1060
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl] parsed result object
|
|
1061
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1062
|
+
#
|
|
1063
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl]
|
|
1064
|
+
#
|
|
1065
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1066
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1067
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1068
|
+
def patch_project_location_collection_data_store_control(name, google_cloud_discoveryengine_v1beta_control_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1069
|
+
command = make_simple_command(:patch, 'v1beta/{+name}', options)
|
|
1070
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl::Representation
|
|
1071
|
+
command.request_object = google_cloud_discoveryengine_v1beta_control_object
|
|
1072
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl::Representation
|
|
1073
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl
|
|
1074
|
+
command.params['name'] = name unless name.nil?
|
|
1075
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
1076
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1077
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1078
|
+
execute_or_queue_command(command, &block)
|
|
1079
|
+
end
|
|
1080
|
+
|
|
813
1081
|
# Converses a conversation.
|
|
814
1082
|
# @param [String] name
|
|
815
1083
|
# Required. The resource name of the Conversation to get. Format: `projects/`
|
|
@@ -1219,8 +1487,8 @@ module Google
|
|
|
1219
1487
|
# .
|
|
1220
1488
|
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSchema] google_cloud_discoveryengine_v1beta_schema_object
|
|
1221
1489
|
# @param [String] schema_id
|
|
1222
|
-
# Required. The ID to use for the Schema, which
|
|
1223
|
-
#
|
|
1490
|
+
# Required. The ID to use for the Schema, which becomes the final component of
|
|
1491
|
+
# the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.
|
|
1224
1492
|
# org/html/rfc1034) standard with a length limit of 63 characters.
|
|
1225
1493
|
# @param [String] fields
|
|
1226
1494
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -1323,8 +1591,8 @@ module Google
|
|
|
1323
1591
|
# .
|
|
1324
1592
|
# @param [Fixnum] page_size
|
|
1325
1593
|
# The maximum number of Schemas to return. The service may return fewer than
|
|
1326
|
-
# this value. If unspecified, at most 100 Schemas
|
|
1327
|
-
# value is 1000; values above 1000
|
|
1594
|
+
# this value. If unspecified, at most 100 Schemas are returned. The maximum
|
|
1595
|
+
# value is 1000; values above 1000 are set to 1000.
|
|
1328
1596
|
# @param [String] page_token
|
|
1329
1597
|
# A page token, received from a previous SchemaService.ListSchemas call. Provide
|
|
1330
1598
|
# this to retrieve the subsequent page. When paginating, all other parameters
|
|
@@ -1367,8 +1635,8 @@ module Google
|
|
|
1367
1635
|
# limit of 1024 characters.
|
|
1368
1636
|
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSchema] google_cloud_discoveryengine_v1beta_schema_object
|
|
1369
1637
|
# @param [Boolean] allow_missing
|
|
1370
|
-
# If set to true, and the Schema is not found, a new Schema
|
|
1371
|
-
#
|
|
1638
|
+
# If set to true, and the Schema is not found, a new Schema is created. In this
|
|
1639
|
+
# situation, `update_mask` is ignored.
|
|
1372
1640
|
# @param [String] fields
|
|
1373
1641
|
# Selector specifying which fields to include in a partial response.
|
|
1374
1642
|
# @param [String] quota_user
|
|
@@ -1626,11 +1894,11 @@ module Google
|
|
|
1626
1894
|
# Required. Full resource name of a ServingConfig: `projects/*/locations/global/
|
|
1627
1895
|
# collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/
|
|
1628
1896
|
# collections/*/dataStores/*/servingConfigs/*` One default serving config is
|
|
1629
|
-
# created along with your recommendation engine creation. The engine ID
|
|
1630
|
-
#
|
|
1631
|
-
#
|
|
1632
|
-
#
|
|
1633
|
-
#
|
|
1897
|
+
# created along with your recommendation engine creation. The engine ID is used
|
|
1898
|
+
# as the ID of the default serving config. For example, for Engine `projects/*/
|
|
1899
|
+
# locations/global/collections/*/engines/my-engine`, you can use `projects/*/
|
|
1900
|
+
# locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for
|
|
1901
|
+
# your RecommendationService.Recommend requests.
|
|
1634
1902
|
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendRequest] google_cloud_discoveryengine_v1beta_recommend_request_object
|
|
1635
1903
|
# @param [String] fields
|
|
1636
1904
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -2583,7 +2851,7 @@ module Google
|
|
|
2583
2851
|
execute_or_queue_command(command, &block)
|
|
2584
2852
|
end
|
|
2585
2853
|
|
|
2586
|
-
# Bulk import of
|
|
2854
|
+
# Bulk import of user events. Request processing might be synchronous. Events
|
|
2587
2855
|
# that already exist are skipped. Use this method for backfilling historical
|
|
2588
2856
|
# user events. Operation.response is of type ImportResponse. Note that it is
|
|
2589
2857
|
# possible for a subset of the items to be successfully inserted. Operation.
|
|
@@ -2630,6 +2898,9 @@ module Google
|
|
|
2630
2898
|
# across multiple DataStore, the format is: `projects/`project`/locations/`
|
|
2631
2899
|
# location``.
|
|
2632
2900
|
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent] google_cloud_discoveryengine_v1beta_user_event_object
|
|
2901
|
+
# @param [Boolean] write_async
|
|
2902
|
+
# If set to true, the user event is written asynchronously after validation, and
|
|
2903
|
+
# the API responds without waiting for the write.
|
|
2633
2904
|
# @param [String] fields
|
|
2634
2905
|
# Selector specifying which fields to include in a partial response.
|
|
2635
2906
|
# @param [String] quota_user
|
|
@@ -2647,13 +2918,14 @@ module Google
|
|
|
2647
2918
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
2648
2919
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
2649
2920
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
2650
|
-
def write_project_location_collection_data_store_user_event(parent, google_cloud_discoveryengine_v1beta_user_event_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
2921
|
+
def write_project_location_collection_data_store_user_event(parent, google_cloud_discoveryengine_v1beta_user_event_object = nil, write_async: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
2651
2922
|
command = make_simple_command(:post, 'v1beta/{+parent}/userEvents:write', options)
|
|
2652
2923
|
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent::Representation
|
|
2653
2924
|
command.request_object = google_cloud_discoveryengine_v1beta_user_event_object
|
|
2654
2925
|
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent::Representation
|
|
2655
2926
|
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent
|
|
2656
2927
|
command.params['parent'] = parent unless parent.nil?
|
|
2928
|
+
command.query['writeAsync'] = write_async unless write_async.nil?
|
|
2657
2929
|
command.query['fields'] = fields unless fields.nil?
|
|
2658
2930
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
2659
2931
|
execute_or_queue_command(command, &block)
|
|
@@ -2952,6 +3224,197 @@ module Google
|
|
|
2952
3224
|
execute_or_queue_command(command, &block)
|
|
2953
3225
|
end
|
|
2954
3226
|
|
|
3227
|
+
# Creates a Control. By default 1000 controls are allowed for a data store. A
|
|
3228
|
+
# request can be submitted to adjust this limit. If the Control to create
|
|
3229
|
+
# already exists, an ALREADY_EXISTS error is returned.
|
|
3230
|
+
# @param [String] parent
|
|
3231
|
+
# Required. Full resource name of parent data store. Format: `projects/`
|
|
3232
|
+
# project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
|
|
3233
|
+
# `data_store_id``
|
|
3234
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl] google_cloud_discoveryengine_v1beta_control_object
|
|
3235
|
+
# @param [String] control_id
|
|
3236
|
+
# Required. The ID to use for the Control, which will become the final component
|
|
3237
|
+
# of the Control's resource name. This value must be within 1-63 characters.
|
|
3238
|
+
# Valid characters are /a-z-_/.
|
|
3239
|
+
# @param [String] fields
|
|
3240
|
+
# Selector specifying which fields to include in a partial response.
|
|
3241
|
+
# @param [String] quota_user
|
|
3242
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
3243
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
3244
|
+
# @param [Google::Apis::RequestOptions] options
|
|
3245
|
+
# Request-specific options
|
|
3246
|
+
#
|
|
3247
|
+
# @yield [result, err] Result & error if block supplied
|
|
3248
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl] parsed result object
|
|
3249
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
3250
|
+
#
|
|
3251
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl]
|
|
3252
|
+
#
|
|
3253
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
3254
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
3255
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
3256
|
+
def create_project_location_collection_engine_control(parent, google_cloud_discoveryengine_v1beta_control_object = nil, control_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
3257
|
+
command = make_simple_command(:post, 'v1beta/{+parent}/controls', options)
|
|
3258
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl::Representation
|
|
3259
|
+
command.request_object = google_cloud_discoveryengine_v1beta_control_object
|
|
3260
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl::Representation
|
|
3261
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl
|
|
3262
|
+
command.params['parent'] = parent unless parent.nil?
|
|
3263
|
+
command.query['controlId'] = control_id unless control_id.nil?
|
|
3264
|
+
command.query['fields'] = fields unless fields.nil?
|
|
3265
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
3266
|
+
execute_or_queue_command(command, &block)
|
|
3267
|
+
end
|
|
3268
|
+
|
|
3269
|
+
# Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error
|
|
3270
|
+
# is returned.
|
|
3271
|
+
# @param [String] name
|
|
3272
|
+
# Required. The resource name of the Control to delete. Format: `projects/`
|
|
3273
|
+
# project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
|
|
3274
|
+
# `data_store_id`/controls/`control_id``
|
|
3275
|
+
# @param [String] fields
|
|
3276
|
+
# Selector specifying which fields to include in a partial response.
|
|
3277
|
+
# @param [String] quota_user
|
|
3278
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
3279
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
3280
|
+
# @param [Google::Apis::RequestOptions] options
|
|
3281
|
+
# Request-specific options
|
|
3282
|
+
#
|
|
3283
|
+
# @yield [result, err] Result & error if block supplied
|
|
3284
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty] parsed result object
|
|
3285
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
3286
|
+
#
|
|
3287
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty]
|
|
3288
|
+
#
|
|
3289
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
3290
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
3291
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
3292
|
+
def delete_project_location_collection_engine_control(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
3293
|
+
command = make_simple_command(:delete, 'v1beta/{+name}', options)
|
|
3294
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty::Representation
|
|
3295
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty
|
|
3296
|
+
command.params['name'] = name unless name.nil?
|
|
3297
|
+
command.query['fields'] = fields unless fields.nil?
|
|
3298
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
3299
|
+
execute_or_queue_command(command, &block)
|
|
3300
|
+
end
|
|
3301
|
+
|
|
3302
|
+
# Gets a Control.
|
|
3303
|
+
# @param [String] name
|
|
3304
|
+
# Required. The resource name of the Control to get. Format: `projects/`
|
|
3305
|
+
# project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
|
|
3306
|
+
# `data_store_id`/controls/`control_id``
|
|
3307
|
+
# @param [String] fields
|
|
3308
|
+
# Selector specifying which fields to include in a partial response.
|
|
3309
|
+
# @param [String] quota_user
|
|
3310
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
3311
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
3312
|
+
# @param [Google::Apis::RequestOptions] options
|
|
3313
|
+
# Request-specific options
|
|
3314
|
+
#
|
|
3315
|
+
# @yield [result, err] Result & error if block supplied
|
|
3316
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl] parsed result object
|
|
3317
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
3318
|
+
#
|
|
3319
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl]
|
|
3320
|
+
#
|
|
3321
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
3322
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
3323
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
3324
|
+
def get_project_location_collection_engine_control(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
3325
|
+
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
|
3326
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl::Representation
|
|
3327
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl
|
|
3328
|
+
command.params['name'] = name unless name.nil?
|
|
3329
|
+
command.query['fields'] = fields unless fields.nil?
|
|
3330
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
3331
|
+
execute_or_queue_command(command, &block)
|
|
3332
|
+
end
|
|
3333
|
+
|
|
3334
|
+
# Lists all Controls by their parent DataStore.
|
|
3335
|
+
# @param [String] parent
|
|
3336
|
+
# Required. The data store resource name. Format: `projects/`project_number`/
|
|
3337
|
+
# locations/`location_id`/collections/`collection_id`/dataStores/`data_store_id``
|
|
3338
|
+
# @param [String] filter
|
|
3339
|
+
# Optional. A filter to apply on the list results. Supported features: * List
|
|
3340
|
+
# all the products under the parent branch if filter is unset. Currently this
|
|
3341
|
+
# field is unsupported.
|
|
3342
|
+
# @param [Fixnum] page_size
|
|
3343
|
+
# Optional. Maximum number of results to return. If unspecified, defaults to 50.
|
|
3344
|
+
# Max allowed value is 1000.
|
|
3345
|
+
# @param [String] page_token
|
|
3346
|
+
# Optional. A page token, received from a previous `ListControls` call. Provide
|
|
3347
|
+
# this to retrieve the subsequent page.
|
|
3348
|
+
# @param [String] fields
|
|
3349
|
+
# Selector specifying which fields to include in a partial response.
|
|
3350
|
+
# @param [String] quota_user
|
|
3351
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
3352
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
3353
|
+
# @param [Google::Apis::RequestOptions] options
|
|
3354
|
+
# Request-specific options
|
|
3355
|
+
#
|
|
3356
|
+
# @yield [result, err] Result & error if block supplied
|
|
3357
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListControlsResponse] parsed result object
|
|
3358
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
3359
|
+
#
|
|
3360
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListControlsResponse]
|
|
3361
|
+
#
|
|
3362
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
3363
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
3364
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
3365
|
+
def list_project_location_collection_engine_controls(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
3366
|
+
command = make_simple_command(:get, 'v1beta/{+parent}/controls', options)
|
|
3367
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListControlsResponse::Representation
|
|
3368
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListControlsResponse
|
|
3369
|
+
command.params['parent'] = parent unless parent.nil?
|
|
3370
|
+
command.query['filter'] = filter unless filter.nil?
|
|
3371
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
3372
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
3373
|
+
command.query['fields'] = fields unless fields.nil?
|
|
3374
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
3375
|
+
execute_or_queue_command(command, &block)
|
|
3376
|
+
end
|
|
3377
|
+
|
|
3378
|
+
# Updates a Control. Control action type cannot be changed. If the Control to
|
|
3379
|
+
# update does not exist, a NOT_FOUND error is returned.
|
|
3380
|
+
# @param [String] name
|
|
3381
|
+
# Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/
|
|
3382
|
+
# controls/*`
|
|
3383
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl] google_cloud_discoveryengine_v1beta_control_object
|
|
3384
|
+
# @param [String] update_mask
|
|
3385
|
+
# Optional. Indicates which fields in the provided Control to update. The
|
|
3386
|
+
# following are NOT supported: * Control.name * Control.solution_type If not set
|
|
3387
|
+
# or empty, all supported fields are updated.
|
|
3388
|
+
# @param [String] fields
|
|
3389
|
+
# Selector specifying which fields to include in a partial response.
|
|
3390
|
+
# @param [String] quota_user
|
|
3391
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
3392
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
3393
|
+
# @param [Google::Apis::RequestOptions] options
|
|
3394
|
+
# Request-specific options
|
|
3395
|
+
#
|
|
3396
|
+
# @yield [result, err] Result & error if block supplied
|
|
3397
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl] parsed result object
|
|
3398
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
3399
|
+
#
|
|
3400
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl]
|
|
3401
|
+
#
|
|
3402
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
3403
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
3404
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
3405
|
+
def patch_project_location_collection_engine_control(name, google_cloud_discoveryengine_v1beta_control_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
3406
|
+
command = make_simple_command(:patch, 'v1beta/{+name}', options)
|
|
3407
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl::Representation
|
|
3408
|
+
command.request_object = google_cloud_discoveryengine_v1beta_control_object
|
|
3409
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl::Representation
|
|
3410
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl
|
|
3411
|
+
command.params['name'] = name unless name.nil?
|
|
3412
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
3413
|
+
command.query['fields'] = fields unless fields.nil?
|
|
3414
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
3415
|
+
execute_or_queue_command(command, &block)
|
|
3416
|
+
end
|
|
3417
|
+
|
|
2955
3418
|
# Converses a conversation.
|
|
2956
3419
|
# @param [String] name
|
|
2957
3420
|
# Required. The resource name of the Conversation to get. Format: `projects/`
|
|
@@ -3407,11 +3870,11 @@ module Google
|
|
|
3407
3870
|
# Required. Full resource name of a ServingConfig: `projects/*/locations/global/
|
|
3408
3871
|
# collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/
|
|
3409
3872
|
# collections/*/dataStores/*/servingConfigs/*` One default serving config is
|
|
3410
|
-
# created along with your recommendation engine creation. The engine ID
|
|
3411
|
-
#
|
|
3412
|
-
#
|
|
3413
|
-
#
|
|
3414
|
-
#
|
|
3873
|
+
# created along with your recommendation engine creation. The engine ID is used
|
|
3874
|
+
# as the ID of the default serving config. For example, for Engine `projects/*/
|
|
3875
|
+
# locations/global/collections/*/engines/my-engine`, you can use `projects/*/
|
|
3876
|
+
# locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for
|
|
3877
|
+
# your RecommendationService.Recommend requests.
|
|
3415
3878
|
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendRequest] google_cloud_discoveryengine_v1beta_recommend_request_object
|
|
3416
3879
|
# @param [String] fields
|
|
3417
3880
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -3992,8 +4455,8 @@ module Google
|
|
|
3992
4455
|
# permission to list DataStores under this location, regardless of whether or
|
|
3993
4456
|
# not this data store exists, a PERMISSION_DENIED error is returned.
|
|
3994
4457
|
# @param [String] filter
|
|
3995
|
-
# Filter by solution type . For example: filter = 'solution_type:
|
|
3996
|
-
# SOLUTION_TYPE_SEARCH'
|
|
4458
|
+
# Filter by solution type . For example: `filter = 'solution_type:
|
|
4459
|
+
# SOLUTION_TYPE_SEARCH'`
|
|
3997
4460
|
# @param [Fixnum] page_size
|
|
3998
4461
|
# Maximum number of DataStores to return. If unspecified, defaults to 10. The
|
|
3999
4462
|
# maximum allowed value is 50. Values above 50 will be coerced to 50. If this
|
|
@@ -4080,14 +4543,14 @@ module Google
|
|
|
4080
4543
|
# location`/collections/`collection`/dataStores/`data_store`/branches/`branch``.
|
|
4081
4544
|
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument] google_cloud_discoveryengine_v1beta_document_object
|
|
4082
4545
|
# @param [String] document_id
|
|
4083
|
-
# Required. The ID to use for the Document, which
|
|
4084
|
-
#
|
|
4085
|
-
#
|
|
4086
|
-
#
|
|
4087
|
-
#
|
|
4088
|
-
#
|
|
4089
|
-
#
|
|
4090
|
-
#
|
|
4546
|
+
# Required. The ID to use for the Document, which becomes the final component of
|
|
4547
|
+
# the Document.name. If the caller does not have permission to create the
|
|
4548
|
+
# Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error
|
|
4549
|
+
# is returned. This field must be unique among all Documents with the same
|
|
4550
|
+
# parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must
|
|
4551
|
+
# conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a
|
|
4552
|
+
# length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is
|
|
4553
|
+
# returned.
|
|
4091
4554
|
# @param [String] fields
|
|
4092
4555
|
# Selector specifying which fields to include in a partial response.
|
|
4093
4556
|
# @param [String] quota_user
|
|
@@ -4189,8 +4652,8 @@ module Google
|
|
|
4189
4652
|
end
|
|
4190
4653
|
|
|
4191
4654
|
# Bulk import of multiple Documents. Request processing may be synchronous. Non-
|
|
4192
|
-
# existing items
|
|
4193
|
-
#
|
|
4655
|
+
# existing items are created. Note: It is possible for a subset of the Documents
|
|
4656
|
+
# to be successfully updated.
|
|
4194
4657
|
# @param [String] parent
|
|
4195
4658
|
# Required. The parent branch resource name, such as `projects/`project`/
|
|
4196
4659
|
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
|
@@ -4235,8 +4698,8 @@ module Google
|
|
|
4235
4698
|
# PERMISSION_DENIED` error is returned.
|
|
4236
4699
|
# @param [Fixnum] page_size
|
|
4237
4700
|
# Maximum number of Documents to return. If unspecified, defaults to 100. The
|
|
4238
|
-
# maximum allowed value is 1000. Values above 1000
|
|
4239
|
-
#
|
|
4701
|
+
# maximum allowed value is 1000. Values above 1000 are set to 1000. If this
|
|
4702
|
+
# field is negative, an `INVALID_ARGUMENT` error is returned.
|
|
4240
4703
|
# @param [String] page_token
|
|
4241
4704
|
# A page token ListDocumentsResponse.next_page_token, received from a previous
|
|
4242
4705
|
# DocumentService.ListDocuments call. Provide this to retrieve the subsequent
|
|
@@ -4280,10 +4743,10 @@ module Google
|
|
|
4280
4743
|
# with a length limit of 1024 characters.
|
|
4281
4744
|
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument] google_cloud_discoveryengine_v1beta_document_object
|
|
4282
4745
|
# @param [Boolean] allow_missing
|
|
4283
|
-
# If set to true
|
|
4746
|
+
# If set to `true` and the Document is not found, a new Document is be created.
|
|
4284
4747
|
# @param [String] update_mask
|
|
4285
4748
|
# Indicates which fields in the provided imported 'document' to update. If not
|
|
4286
|
-
# set,
|
|
4749
|
+
# set, by default updates all fields.
|
|
4287
4750
|
# @param [String] fields
|
|
4288
4751
|
# Selector specifying which fields to include in a partial response.
|
|
4289
4752
|
# @param [String] quota_user
|
|
@@ -4354,6 +4817,46 @@ module Google
|
|
|
4354
4817
|
execute_or_queue_command(command, &block)
|
|
4355
4818
|
end
|
|
4356
4819
|
|
|
4820
|
+
# Starts asynchronous cancellation on a long-running operation. The server makes
|
|
4821
|
+
# a best effort to cancel the operation, but success is not guaranteed. If the
|
|
4822
|
+
# server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
|
|
4823
|
+
# Clients can use Operations.GetOperation or other methods to check whether the
|
|
4824
|
+
# cancellation succeeded or whether the operation completed despite cancellation.
|
|
4825
|
+
# On successful cancellation, the operation is not deleted; instead, it becomes
|
|
4826
|
+
# an operation with an Operation.error value with a google.rpc.Status.code of 1,
|
|
4827
|
+
# corresponding to `Code.CANCELLED`.
|
|
4828
|
+
# @param [String] name
|
|
4829
|
+
# The name of the operation resource to be cancelled.
|
|
4830
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningCancelOperationRequest] google_longrunning_cancel_operation_request_object
|
|
4831
|
+
# @param [String] fields
|
|
4832
|
+
# Selector specifying which fields to include in a partial response.
|
|
4833
|
+
# @param [String] quota_user
|
|
4834
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
4835
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
4836
|
+
# @param [Google::Apis::RequestOptions] options
|
|
4837
|
+
# Request-specific options
|
|
4838
|
+
#
|
|
4839
|
+
# @yield [result, err] Result & error if block supplied
|
|
4840
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty] parsed result object
|
|
4841
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
4842
|
+
#
|
|
4843
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty]
|
|
4844
|
+
#
|
|
4845
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
4846
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
4847
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
4848
|
+
def cancel_project_location_data_store_branch_operation(name, google_longrunning_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
4849
|
+
command = make_simple_command(:post, 'v1beta/{+name}:cancel', options)
|
|
4850
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningCancelOperationRequest::Representation
|
|
4851
|
+
command.request_object = google_longrunning_cancel_operation_request_object
|
|
4852
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty::Representation
|
|
4853
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty
|
|
4854
|
+
command.params['name'] = name unless name.nil?
|
|
4855
|
+
command.query['fields'] = fields unless fields.nil?
|
|
4856
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
4857
|
+
execute_or_queue_command(command, &block)
|
|
4858
|
+
end
|
|
4859
|
+
|
|
4357
4860
|
# Gets the latest state of a long-running operation. Clients can use this method
|
|
4358
4861
|
# to poll the operation result at intervals as recommended by the API service.
|
|
4359
4862
|
# @param [String] name
|
|
@@ -4425,6 +4928,197 @@ module Google
|
|
|
4425
4928
|
execute_or_queue_command(command, &block)
|
|
4426
4929
|
end
|
|
4427
4930
|
|
|
4931
|
+
# Creates a Control. By default 1000 controls are allowed for a data store. A
|
|
4932
|
+
# request can be submitted to adjust this limit. If the Control to create
|
|
4933
|
+
# already exists, an ALREADY_EXISTS error is returned.
|
|
4934
|
+
# @param [String] parent
|
|
4935
|
+
# Required. Full resource name of parent data store. Format: `projects/`
|
|
4936
|
+
# project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
|
|
4937
|
+
# `data_store_id``
|
|
4938
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl] google_cloud_discoveryengine_v1beta_control_object
|
|
4939
|
+
# @param [String] control_id
|
|
4940
|
+
# Required. The ID to use for the Control, which will become the final component
|
|
4941
|
+
# of the Control's resource name. This value must be within 1-63 characters.
|
|
4942
|
+
# Valid characters are /a-z-_/.
|
|
4943
|
+
# @param [String] fields
|
|
4944
|
+
# Selector specifying which fields to include in a partial response.
|
|
4945
|
+
# @param [String] quota_user
|
|
4946
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
4947
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
4948
|
+
# @param [Google::Apis::RequestOptions] options
|
|
4949
|
+
# Request-specific options
|
|
4950
|
+
#
|
|
4951
|
+
# @yield [result, err] Result & error if block supplied
|
|
4952
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl] parsed result object
|
|
4953
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
4954
|
+
#
|
|
4955
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl]
|
|
4956
|
+
#
|
|
4957
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
4958
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
4959
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
4960
|
+
def create_project_location_data_store_control(parent, google_cloud_discoveryengine_v1beta_control_object = nil, control_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
4961
|
+
command = make_simple_command(:post, 'v1beta/{+parent}/controls', options)
|
|
4962
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl::Representation
|
|
4963
|
+
command.request_object = google_cloud_discoveryengine_v1beta_control_object
|
|
4964
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl::Representation
|
|
4965
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl
|
|
4966
|
+
command.params['parent'] = parent unless parent.nil?
|
|
4967
|
+
command.query['controlId'] = control_id unless control_id.nil?
|
|
4968
|
+
command.query['fields'] = fields unless fields.nil?
|
|
4969
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
4970
|
+
execute_or_queue_command(command, &block)
|
|
4971
|
+
end
|
|
4972
|
+
|
|
4973
|
+
# Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error
|
|
4974
|
+
# is returned.
|
|
4975
|
+
# @param [String] name
|
|
4976
|
+
# Required. The resource name of the Control to delete. Format: `projects/`
|
|
4977
|
+
# project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
|
|
4978
|
+
# `data_store_id`/controls/`control_id``
|
|
4979
|
+
# @param [String] fields
|
|
4980
|
+
# Selector specifying which fields to include in a partial response.
|
|
4981
|
+
# @param [String] quota_user
|
|
4982
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
4983
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
4984
|
+
# @param [Google::Apis::RequestOptions] options
|
|
4985
|
+
# Request-specific options
|
|
4986
|
+
#
|
|
4987
|
+
# @yield [result, err] Result & error if block supplied
|
|
4988
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty] parsed result object
|
|
4989
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
4990
|
+
#
|
|
4991
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty]
|
|
4992
|
+
#
|
|
4993
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
4994
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
4995
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
4996
|
+
def delete_project_location_data_store_control(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
4997
|
+
command = make_simple_command(:delete, 'v1beta/{+name}', options)
|
|
4998
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty::Representation
|
|
4999
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty
|
|
5000
|
+
command.params['name'] = name unless name.nil?
|
|
5001
|
+
command.query['fields'] = fields unless fields.nil?
|
|
5002
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5003
|
+
execute_or_queue_command(command, &block)
|
|
5004
|
+
end
|
|
5005
|
+
|
|
5006
|
+
# Gets a Control.
|
|
5007
|
+
# @param [String] name
|
|
5008
|
+
# Required. The resource name of the Control to get. Format: `projects/`
|
|
5009
|
+
# project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
|
|
5010
|
+
# `data_store_id`/controls/`control_id``
|
|
5011
|
+
# @param [String] fields
|
|
5012
|
+
# Selector specifying which fields to include in a partial response.
|
|
5013
|
+
# @param [String] quota_user
|
|
5014
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
5015
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
5016
|
+
# @param [Google::Apis::RequestOptions] options
|
|
5017
|
+
# Request-specific options
|
|
5018
|
+
#
|
|
5019
|
+
# @yield [result, err] Result & error if block supplied
|
|
5020
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl] parsed result object
|
|
5021
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
5022
|
+
#
|
|
5023
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl]
|
|
5024
|
+
#
|
|
5025
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5026
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5027
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5028
|
+
def get_project_location_data_store_control(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
5029
|
+
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
|
5030
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl::Representation
|
|
5031
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl
|
|
5032
|
+
command.params['name'] = name unless name.nil?
|
|
5033
|
+
command.query['fields'] = fields unless fields.nil?
|
|
5034
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5035
|
+
execute_or_queue_command(command, &block)
|
|
5036
|
+
end
|
|
5037
|
+
|
|
5038
|
+
# Lists all Controls by their parent DataStore.
|
|
5039
|
+
# @param [String] parent
|
|
5040
|
+
# Required. The data store resource name. Format: `projects/`project_number`/
|
|
5041
|
+
# locations/`location_id`/collections/`collection_id`/dataStores/`data_store_id``
|
|
5042
|
+
# @param [String] filter
|
|
5043
|
+
# Optional. A filter to apply on the list results. Supported features: * List
|
|
5044
|
+
# all the products under the parent branch if filter is unset. Currently this
|
|
5045
|
+
# field is unsupported.
|
|
5046
|
+
# @param [Fixnum] page_size
|
|
5047
|
+
# Optional. Maximum number of results to return. If unspecified, defaults to 50.
|
|
5048
|
+
# Max allowed value is 1000.
|
|
5049
|
+
# @param [String] page_token
|
|
5050
|
+
# Optional. A page token, received from a previous `ListControls` call. Provide
|
|
5051
|
+
# this to retrieve the subsequent page.
|
|
5052
|
+
# @param [String] fields
|
|
5053
|
+
# Selector specifying which fields to include in a partial response.
|
|
5054
|
+
# @param [String] quota_user
|
|
5055
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
5056
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
5057
|
+
# @param [Google::Apis::RequestOptions] options
|
|
5058
|
+
# Request-specific options
|
|
5059
|
+
#
|
|
5060
|
+
# @yield [result, err] Result & error if block supplied
|
|
5061
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListControlsResponse] parsed result object
|
|
5062
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
5063
|
+
#
|
|
5064
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListControlsResponse]
|
|
5065
|
+
#
|
|
5066
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5067
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5068
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5069
|
+
def list_project_location_data_store_controls(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
5070
|
+
command = make_simple_command(:get, 'v1beta/{+parent}/controls', options)
|
|
5071
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListControlsResponse::Representation
|
|
5072
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListControlsResponse
|
|
5073
|
+
command.params['parent'] = parent unless parent.nil?
|
|
5074
|
+
command.query['filter'] = filter unless filter.nil?
|
|
5075
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
5076
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
5077
|
+
command.query['fields'] = fields unless fields.nil?
|
|
5078
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5079
|
+
execute_or_queue_command(command, &block)
|
|
5080
|
+
end
|
|
5081
|
+
|
|
5082
|
+
# Updates a Control. Control action type cannot be changed. If the Control to
|
|
5083
|
+
# update does not exist, a NOT_FOUND error is returned.
|
|
5084
|
+
# @param [String] name
|
|
5085
|
+
# Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/
|
|
5086
|
+
# controls/*`
|
|
5087
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl] google_cloud_discoveryengine_v1beta_control_object
|
|
5088
|
+
# @param [String] update_mask
|
|
5089
|
+
# Optional. Indicates which fields in the provided Control to update. The
|
|
5090
|
+
# following are NOT supported: * Control.name * Control.solution_type If not set
|
|
5091
|
+
# or empty, all supported fields are updated.
|
|
5092
|
+
# @param [String] fields
|
|
5093
|
+
# Selector specifying which fields to include in a partial response.
|
|
5094
|
+
# @param [String] quota_user
|
|
5095
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
5096
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
5097
|
+
# @param [Google::Apis::RequestOptions] options
|
|
5098
|
+
# Request-specific options
|
|
5099
|
+
#
|
|
5100
|
+
# @yield [result, err] Result & error if block supplied
|
|
5101
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl] parsed result object
|
|
5102
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
5103
|
+
#
|
|
5104
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl]
|
|
5105
|
+
#
|
|
5106
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5107
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5108
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5109
|
+
def patch_project_location_data_store_control(name, google_cloud_discoveryengine_v1beta_control_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
5110
|
+
command = make_simple_command(:patch, 'v1beta/{+name}', options)
|
|
5111
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl::Representation
|
|
5112
|
+
command.request_object = google_cloud_discoveryengine_v1beta_control_object
|
|
5113
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl::Representation
|
|
5114
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl
|
|
5115
|
+
command.params['name'] = name unless name.nil?
|
|
5116
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
5117
|
+
command.query['fields'] = fields unless fields.nil?
|
|
5118
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5119
|
+
execute_or_queue_command(command, &block)
|
|
5120
|
+
end
|
|
5121
|
+
|
|
4428
5122
|
# Converses a conversation.
|
|
4429
5123
|
# @param [String] name
|
|
4430
5124
|
# Required. The resource name of the Conversation to get. Format: `projects/`
|
|
@@ -4802,8 +5496,8 @@ module Google
|
|
|
4802
5496
|
# .
|
|
4803
5497
|
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSchema] google_cloud_discoveryengine_v1beta_schema_object
|
|
4804
5498
|
# @param [String] schema_id
|
|
4805
|
-
# Required. The ID to use for the Schema, which
|
|
4806
|
-
#
|
|
5499
|
+
# Required. The ID to use for the Schema, which becomes the final component of
|
|
5500
|
+
# the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.
|
|
4807
5501
|
# org/html/rfc1034) standard with a length limit of 63 characters.
|
|
4808
5502
|
# @param [String] fields
|
|
4809
5503
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -4906,8 +5600,8 @@ module Google
|
|
|
4906
5600
|
# .
|
|
4907
5601
|
# @param [Fixnum] page_size
|
|
4908
5602
|
# The maximum number of Schemas to return. The service may return fewer than
|
|
4909
|
-
# this value. If unspecified, at most 100 Schemas
|
|
4910
|
-
# value is 1000; values above 1000
|
|
5603
|
+
# this value. If unspecified, at most 100 Schemas are returned. The maximum
|
|
5604
|
+
# value is 1000; values above 1000 are set to 1000.
|
|
4911
5605
|
# @param [String] page_token
|
|
4912
5606
|
# A page token, received from a previous SchemaService.ListSchemas call. Provide
|
|
4913
5607
|
# this to retrieve the subsequent page. When paginating, all other parameters
|
|
@@ -4950,8 +5644,8 @@ module Google
|
|
|
4950
5644
|
# limit of 1024 characters.
|
|
4951
5645
|
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSchema] google_cloud_discoveryengine_v1beta_schema_object
|
|
4952
5646
|
# @param [Boolean] allow_missing
|
|
4953
|
-
# If set to true, and the Schema is not found, a new Schema
|
|
4954
|
-
#
|
|
5647
|
+
# If set to true, and the Schema is not found, a new Schema is created. In this
|
|
5648
|
+
# situation, `update_mask` is ignored.
|
|
4955
5649
|
# @param [String] fields
|
|
4956
5650
|
# Selector specifying which fields to include in a partial response.
|
|
4957
5651
|
# @param [String] quota_user
|
|
@@ -5138,11 +5832,11 @@ module Google
|
|
|
5138
5832
|
# Required. Full resource name of a ServingConfig: `projects/*/locations/global/
|
|
5139
5833
|
# collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/
|
|
5140
5834
|
# collections/*/dataStores/*/servingConfigs/*` One default serving config is
|
|
5141
|
-
# created along with your recommendation engine creation. The engine ID
|
|
5142
|
-
#
|
|
5143
|
-
#
|
|
5144
|
-
#
|
|
5145
|
-
#
|
|
5835
|
+
# created along with your recommendation engine creation. The engine ID is used
|
|
5836
|
+
# as the ID of the default serving config. For example, for Engine `projects/*/
|
|
5837
|
+
# locations/global/collections/*/engines/my-engine`, you can use `projects/*/
|
|
5838
|
+
# locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for
|
|
5839
|
+
# your RecommendationService.Recommend requests.
|
|
5146
5840
|
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendRequest] google_cloud_discoveryengine_v1beta_recommend_request_object
|
|
5147
5841
|
# @param [String] fields
|
|
5148
5842
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -5872,7 +6566,7 @@ module Google
|
|
|
5872
6566
|
execute_or_queue_command(command, &block)
|
|
5873
6567
|
end
|
|
5874
6568
|
|
|
5875
|
-
# Bulk import of
|
|
6569
|
+
# Bulk import of user events. Request processing might be synchronous. Events
|
|
5876
6570
|
# that already exist are skipped. Use this method for backfilling historical
|
|
5877
6571
|
# user events. Operation.response is of type ImportResponse. Note that it is
|
|
5878
6572
|
# possible for a subset of the items to be successfully inserted. Operation.
|
|
@@ -5919,6 +6613,9 @@ module Google
|
|
|
5919
6613
|
# across multiple DataStore, the format is: `projects/`project`/locations/`
|
|
5920
6614
|
# location``.
|
|
5921
6615
|
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent] google_cloud_discoveryengine_v1beta_user_event_object
|
|
6616
|
+
# @param [Boolean] write_async
|
|
6617
|
+
# If set to true, the user event is written asynchronously after validation, and
|
|
6618
|
+
# the API responds without waiting for the write.
|
|
5922
6619
|
# @param [String] fields
|
|
5923
6620
|
# Selector specifying which fields to include in a partial response.
|
|
5924
6621
|
# @param [String] quota_user
|
|
@@ -5936,13 +6633,14 @@ module Google
|
|
|
5936
6633
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
5937
6634
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
5938
6635
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
5939
|
-
def write_project_location_data_store_user_event(parent, google_cloud_discoveryengine_v1beta_user_event_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
6636
|
+
def write_project_location_data_store_user_event(parent, google_cloud_discoveryengine_v1beta_user_event_object = nil, write_async: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
5940
6637
|
command = make_simple_command(:post, 'v1beta/{+parent}/userEvents:write', options)
|
|
5941
6638
|
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent::Representation
|
|
5942
6639
|
command.request_object = google_cloud_discoveryengine_v1beta_user_event_object
|
|
5943
6640
|
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent::Representation
|
|
5944
6641
|
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent
|
|
5945
6642
|
command.params['parent'] = parent unless parent.nil?
|
|
6643
|
+
command.query['writeAsync'] = write_async unless write_async.nil?
|
|
5946
6644
|
command.query['fields'] = fields unless fields.nil?
|
|
5947
6645
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
5948
6646
|
execute_or_queue_command(command, &block)
|
|
@@ -6096,6 +6794,9 @@ module Google
|
|
|
6096
6794
|
# across multiple DataStore, the format is: `projects/`project`/locations/`
|
|
6097
6795
|
# location``.
|
|
6098
6796
|
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent] google_cloud_discoveryengine_v1beta_user_event_object
|
|
6797
|
+
# @param [Boolean] write_async
|
|
6798
|
+
# If set to true, the user event is written asynchronously after validation, and
|
|
6799
|
+
# the API responds without waiting for the write.
|
|
6099
6800
|
# @param [String] fields
|
|
6100
6801
|
# Selector specifying which fields to include in a partial response.
|
|
6101
6802
|
# @param [String] quota_user
|
|
@@ -6113,13 +6814,14 @@ module Google
|
|
|
6113
6814
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
6114
6815
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
6115
6816
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
6116
|
-
def write_project_location_user_event(parent, google_cloud_discoveryengine_v1beta_user_event_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
6817
|
+
def write_project_location_user_event(parent, google_cloud_discoveryengine_v1beta_user_event_object = nil, write_async: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
6117
6818
|
command = make_simple_command(:post, 'v1beta/{+parent}/userEvents:write', options)
|
|
6118
6819
|
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent::Representation
|
|
6119
6820
|
command.request_object = google_cloud_discoveryengine_v1beta_user_event_object
|
|
6120
6821
|
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent::Representation
|
|
6121
6822
|
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent
|
|
6122
6823
|
command.params['parent'] = parent unless parent.nil?
|
|
6824
|
+
command.query['writeAsync'] = write_async unless write_async.nil?
|
|
6123
6825
|
command.query['fields'] = fields unless fields.nil?
|
|
6124
6826
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
6125
6827
|
execute_or_queue_command(command, &block)
|