google-apis-discoveryengine_v1beta 0.45.0 → 0.47.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (7) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -0
  3. data/lib/google/apis/discoveryengine_v1beta/classes.rb +1780 -157
  4. data/lib/google/apis/discoveryengine_v1beta/gem_version.rb +2 -2
  5. data/lib/google/apis/discoveryengine_v1beta/representations.rb +717 -10
  6. data/lib/google/apis/discoveryengine_v1beta/service.rb +686 -7
  7. metadata +3 -3
data/lib/google/apis/discoveryengine_v1beta/service.rb CHANGED
@@ -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
@@ -850,6 +887,200 @@ module Google
850
887
  execute_or_queue_command(command, &block)
851
888
  end
852
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`` or `projects/`project_number`/locations/`location_id`/
897
+ # collections/`collection_id`/engines/`engine_id``.
898
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl] google_cloud_discoveryengine_v1beta_control_object
899
+ # @param [String] control_id
900
+ # Required. The ID to use for the Control, which will become the final component
901
+ # of the Control's resource name. This value must be within 1-63 characters.
902
+ # Valid characters are /a-z-_/.
903
+ # @param [String] fields
904
+ # Selector specifying which fields to include in a partial response.
905
+ # @param [String] quota_user
906
+ # Available to use for quota purposes for server-side applications. Can be any
907
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
908
+ # @param [Google::Apis::RequestOptions] options
909
+ # Request-specific options
910
+ #
911
+ # @yield [result, err] Result & error if block supplied
912
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl] parsed result object
913
+ # @yieldparam err [StandardError] error object if request failed
914
+ #
915
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl]
916
+ #
917
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
918
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
919
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
920
+ 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)
921
+ command = make_simple_command(:post, 'v1beta/{+parent}/controls', options)
922
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl::Representation
923
+ command.request_object = google_cloud_discoveryengine_v1beta_control_object
924
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl::Representation
925
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl
926
+ command.params['parent'] = parent unless parent.nil?
927
+ command.query['controlId'] = control_id unless control_id.nil?
928
+ command.query['fields'] = fields unless fields.nil?
929
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
930
+ execute_or_queue_command(command, &block)
931
+ end
932
+
933
+ # Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error
934
+ # is returned.
935
+ # @param [String] name
936
+ # Required. The resource name of the Control to delete. Format: `projects/`
937
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
938
+ # `data_store_id`/controls/`control_id``
939
+ # @param [String] fields
940
+ # Selector specifying which fields to include in a partial response.
941
+ # @param [String] quota_user
942
+ # Available to use for quota purposes for server-side applications. Can be any
943
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
944
+ # @param [Google::Apis::RequestOptions] options
945
+ # Request-specific options
946
+ #
947
+ # @yield [result, err] Result & error if block supplied
948
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty] parsed result object
949
+ # @yieldparam err [StandardError] error object if request failed
950
+ #
951
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty]
952
+ #
953
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
954
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
955
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
956
+ def delete_project_location_collection_data_store_control(name, fields: nil, quota_user: nil, options: nil, &block)
957
+ command = make_simple_command(:delete, 'v1beta/{+name}', options)
958
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty::Representation
959
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty
960
+ command.params['name'] = name unless name.nil?
961
+ command.query['fields'] = fields unless fields.nil?
962
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
963
+ execute_or_queue_command(command, &block)
964
+ end
965
+
966
+ # Gets a Control.
967
+ # @param [String] name
968
+ # Required. The resource name of the Control to get. Format: `projects/`
969
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
970
+ # `data_store_id`/controls/`control_id``
971
+ # @param [String] fields
972
+ # Selector specifying which fields to include in a partial response.
973
+ # @param [String] quota_user
974
+ # Available to use for quota purposes for server-side applications. Can be any
975
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
976
+ # @param [Google::Apis::RequestOptions] options
977
+ # Request-specific options
978
+ #
979
+ # @yield [result, err] Result & error if block supplied
980
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl] parsed result object
981
+ # @yieldparam err [StandardError] error object if request failed
982
+ #
983
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl]
984
+ #
985
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
986
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
987
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
988
+ def get_project_location_collection_data_store_control(name, fields: nil, quota_user: nil, options: nil, &block)
989
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
990
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl::Representation
991
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl
992
+ command.params['name'] = name unless name.nil?
993
+ command.query['fields'] = fields unless fields.nil?
994
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
995
+ execute_or_queue_command(command, &block)
996
+ end
997
+
998
+ # Lists all Controls by their parent DataStore.
999
+ # @param [String] parent
1000
+ # Required. The data store resource name. Format: `projects/`project_number`/
1001
+ # locations/`location_id`/collections/`collection_id`/dataStores/`data_store_id``
1002
+ # or `projects/`project_number`/locations/`location_id`/collections/`
1003
+ # collection_id`/engines/`engine_id``.
1004
+ # @param [String] filter
1005
+ # Optional. A filter to apply on the list results. Supported features: * List
1006
+ # all the products under the parent branch if filter is unset. Currently this
1007
+ # field is unsupported.
1008
+ # @param [Fixnum] page_size
1009
+ # Optional. Maximum number of results to return. If unspecified, defaults to 50.
1010
+ # Max allowed value is 1000.
1011
+ # @param [String] page_token
1012
+ # Optional. A page token, received from a previous `ListControls` call. Provide
1013
+ # this to retrieve the subsequent page.
1014
+ # @param [String] fields
1015
+ # Selector specifying which fields to include in a partial response.
1016
+ # @param [String] quota_user
1017
+ # Available to use for quota purposes for server-side applications. Can be any
1018
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1019
+ # @param [Google::Apis::RequestOptions] options
1020
+ # Request-specific options
1021
+ #
1022
+ # @yield [result, err] Result & error if block supplied
1023
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListControlsResponse] parsed result object
1024
+ # @yieldparam err [StandardError] error object if request failed
1025
+ #
1026
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListControlsResponse]
1027
+ #
1028
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1029
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1030
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1031
+ 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)
1032
+ command = make_simple_command(:get, 'v1beta/{+parent}/controls', options)
1033
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListControlsResponse::Representation
1034
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListControlsResponse
1035
+ command.params['parent'] = parent unless parent.nil?
1036
+ command.query['filter'] = filter unless filter.nil?
1037
+ command.query['pageSize'] = page_size unless page_size.nil?
1038
+ command.query['pageToken'] = page_token unless page_token.nil?
1039
+ command.query['fields'] = fields unless fields.nil?
1040
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1041
+ execute_or_queue_command(command, &block)
1042
+ end
1043
+
1044
+ # Updates a Control. Control action type cannot be changed. If the Control to
1045
+ # update does not exist, a NOT_FOUND error is returned.
1046
+ # @param [String] name
1047
+ # Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/
1048
+ # controls/*`
1049
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl] google_cloud_discoveryengine_v1beta_control_object
1050
+ # @param [String] update_mask
1051
+ # Optional. Indicates which fields in the provided Control to update. The
1052
+ # following are NOT supported: * Control.name * Control.solution_type If not set
1053
+ # or empty, all supported fields are updated.
1054
+ # @param [String] fields
1055
+ # Selector specifying which fields to include in a partial response.
1056
+ # @param [String] quota_user
1057
+ # Available to use for quota purposes for server-side applications. Can be any
1058
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1059
+ # @param [Google::Apis::RequestOptions] options
1060
+ # Request-specific options
1061
+ #
1062
+ # @yield [result, err] Result & error if block supplied
1063
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl] parsed result object
1064
+ # @yieldparam err [StandardError] error object if request failed
1065
+ #
1066
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl]
1067
+ #
1068
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1069
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1070
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1071
+ 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)
1072
+ command = make_simple_command(:patch, 'v1beta/{+name}', options)
1073
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl::Representation
1074
+ command.request_object = google_cloud_discoveryengine_v1beta_control_object
1075
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl::Representation
1076
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl
1077
+ command.params['name'] = name unless name.nil?
1078
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1079
+ command.query['fields'] = fields unless fields.nil?
1080
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1081
+ execute_or_queue_command(command, &block)
1082
+ end
1083
+
853
1084
  # Converses a conversation.
854
1085
  # @param [String] name
855
1086
  # Required. The resource name of the Conversation to get. Format: `projects/`
@@ -2670,6 +2901,9 @@ module Google
2670
2901
  # across multiple DataStore, the format is: `projects/`project`/locations/`
2671
2902
  # location``.
2672
2903
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent] google_cloud_discoveryengine_v1beta_user_event_object
2904
+ # @param [Boolean] write_async
2905
+ # If set to true, the user event is written asynchronously after validation, and
2906
+ # the API responds without waiting for the write.
2673
2907
  # @param [String] fields
2674
2908
  # Selector specifying which fields to include in a partial response.
2675
2909
  # @param [String] quota_user
@@ -2687,13 +2921,14 @@ module Google
2687
2921
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2688
2922
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2689
2923
  # @raise [Google::Apis::AuthorizationError] Authorization is required
2690
- 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)
2924
+ 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)
2691
2925
  command = make_simple_command(:post, 'v1beta/{+parent}/userEvents:write', options)
2692
2926
  command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent::Representation
2693
2927
  command.request_object = google_cloud_discoveryengine_v1beta_user_event_object
2694
2928
  command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent::Representation
2695
2929
  command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent
2696
2930
  command.params['parent'] = parent unless parent.nil?
2931
+ command.query['writeAsync'] = write_async unless write_async.nil?
2697
2932
  command.query['fields'] = fields unless fields.nil?
2698
2933
  command.query['quotaUser'] = quota_user unless quota_user.nil?
2699
2934
  execute_or_queue_command(command, &block)
@@ -2992,6 +3227,200 @@ module Google
2992
3227
  execute_or_queue_command(command, &block)
2993
3228
  end
2994
3229
 
3230
+ # Creates a Control. By default 1000 controls are allowed for a data store. A
3231
+ # request can be submitted to adjust this limit. If the Control to create
3232
+ # already exists, an ALREADY_EXISTS error is returned.
3233
+ # @param [String] parent
3234
+ # Required. Full resource name of parent data store. Format: `projects/`
3235
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
3236
+ # `data_store_id`` or `projects/`project_number`/locations/`location_id`/
3237
+ # collections/`collection_id`/engines/`engine_id``.
3238
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl] google_cloud_discoveryengine_v1beta_control_object
3239
+ # @param [String] control_id
3240
+ # Required. The ID to use for the Control, which will become the final component
3241
+ # of the Control's resource name. This value must be within 1-63 characters.
3242
+ # Valid characters are /a-z-_/.
3243
+ # @param [String] fields
3244
+ # Selector specifying which fields to include in a partial response.
3245
+ # @param [String] quota_user
3246
+ # Available to use for quota purposes for server-side applications. Can be any
3247
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3248
+ # @param [Google::Apis::RequestOptions] options
3249
+ # Request-specific options
3250
+ #
3251
+ # @yield [result, err] Result & error if block supplied
3252
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl] parsed result object
3253
+ # @yieldparam err [StandardError] error object if request failed
3254
+ #
3255
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl]
3256
+ #
3257
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3258
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3259
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3260
+ 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)
3261
+ command = make_simple_command(:post, 'v1beta/{+parent}/controls', options)
3262
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl::Representation
3263
+ command.request_object = google_cloud_discoveryengine_v1beta_control_object
3264
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl::Representation
3265
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl
3266
+ command.params['parent'] = parent unless parent.nil?
3267
+ command.query['controlId'] = control_id unless control_id.nil?
3268
+ command.query['fields'] = fields unless fields.nil?
3269
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3270
+ execute_or_queue_command(command, &block)
3271
+ end
3272
+
3273
+ # Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error
3274
+ # is returned.
3275
+ # @param [String] name
3276
+ # Required. The resource name of the Control to delete. Format: `projects/`
3277
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
3278
+ # `data_store_id`/controls/`control_id``
3279
+ # @param [String] fields
3280
+ # Selector specifying which fields to include in a partial response.
3281
+ # @param [String] quota_user
3282
+ # Available to use for quota purposes for server-side applications. Can be any
3283
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3284
+ # @param [Google::Apis::RequestOptions] options
3285
+ # Request-specific options
3286
+ #
3287
+ # @yield [result, err] Result & error if block supplied
3288
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty] parsed result object
3289
+ # @yieldparam err [StandardError] error object if request failed
3290
+ #
3291
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty]
3292
+ #
3293
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3294
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3295
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3296
+ def delete_project_location_collection_engine_control(name, fields: nil, quota_user: nil, options: nil, &block)
3297
+ command = make_simple_command(:delete, 'v1beta/{+name}', options)
3298
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty::Representation
3299
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty
3300
+ command.params['name'] = name unless name.nil?
3301
+ command.query['fields'] = fields unless fields.nil?
3302
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3303
+ execute_or_queue_command(command, &block)
3304
+ end
3305
+
3306
+ # Gets a Control.
3307
+ # @param [String] name
3308
+ # Required. The resource name of the Control to get. Format: `projects/`
3309
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
3310
+ # `data_store_id`/controls/`control_id``
3311
+ # @param [String] fields
3312
+ # Selector specifying which fields to include in a partial response.
3313
+ # @param [String] quota_user
3314
+ # Available to use for quota purposes for server-side applications. Can be any
3315
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3316
+ # @param [Google::Apis::RequestOptions] options
3317
+ # Request-specific options
3318
+ #
3319
+ # @yield [result, err] Result & error if block supplied
3320
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl] parsed result object
3321
+ # @yieldparam err [StandardError] error object if request failed
3322
+ #
3323
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl]
3324
+ #
3325
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3326
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3327
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3328
+ def get_project_location_collection_engine_control(name, fields: nil, quota_user: nil, options: nil, &block)
3329
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
3330
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl::Representation
3331
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl
3332
+ command.params['name'] = name unless name.nil?
3333
+ command.query['fields'] = fields unless fields.nil?
3334
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3335
+ execute_or_queue_command(command, &block)
3336
+ end
3337
+
3338
+ # Lists all Controls by their parent DataStore.
3339
+ # @param [String] parent
3340
+ # Required. The data store resource name. Format: `projects/`project_number`/
3341
+ # locations/`location_id`/collections/`collection_id`/dataStores/`data_store_id``
3342
+ # or `projects/`project_number`/locations/`location_id`/collections/`
3343
+ # collection_id`/engines/`engine_id``.
3344
+ # @param [String] filter
3345
+ # Optional. A filter to apply on the list results. Supported features: * List
3346
+ # all the products under the parent branch if filter is unset. Currently this
3347
+ # field is unsupported.
3348
+ # @param [Fixnum] page_size
3349
+ # Optional. Maximum number of results to return. If unspecified, defaults to 50.
3350
+ # Max allowed value is 1000.
3351
+ # @param [String] page_token
3352
+ # Optional. A page token, received from a previous `ListControls` call. Provide
3353
+ # this to retrieve the subsequent page.
3354
+ # @param [String] fields
3355
+ # Selector specifying which fields to include in a partial response.
3356
+ # @param [String] quota_user
3357
+ # Available to use for quota purposes for server-side applications. Can be any
3358
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3359
+ # @param [Google::Apis::RequestOptions] options
3360
+ # Request-specific options
3361
+ #
3362
+ # @yield [result, err] Result & error if block supplied
3363
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListControlsResponse] parsed result object
3364
+ # @yieldparam err [StandardError] error object if request failed
3365
+ #
3366
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListControlsResponse]
3367
+ #
3368
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3369
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3370
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3371
+ def list_project_location_collection_engine_controls(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
3372
+ command = make_simple_command(:get, 'v1beta/{+parent}/controls', options)
3373
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListControlsResponse::Representation
3374
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListControlsResponse
3375
+ command.params['parent'] = parent unless parent.nil?
3376
+ command.query['filter'] = filter unless filter.nil?
3377
+ command.query['pageSize'] = page_size unless page_size.nil?
3378
+ command.query['pageToken'] = page_token unless page_token.nil?
3379
+ command.query['fields'] = fields unless fields.nil?
3380
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3381
+ execute_or_queue_command(command, &block)
3382
+ end
3383
+
3384
+ # Updates a Control. Control action type cannot be changed. If the Control to
3385
+ # update does not exist, a NOT_FOUND error is returned.
3386
+ # @param [String] name
3387
+ # Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/
3388
+ # controls/*`
3389
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl] google_cloud_discoveryengine_v1beta_control_object
3390
+ # @param [String] update_mask
3391
+ # Optional. Indicates which fields in the provided Control to update. The
3392
+ # following are NOT supported: * Control.name * Control.solution_type If not set
3393
+ # or empty, all supported fields are updated.
3394
+ # @param [String] fields
3395
+ # Selector specifying which fields to include in a partial response.
3396
+ # @param [String] quota_user
3397
+ # Available to use for quota purposes for server-side applications. Can be any
3398
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3399
+ # @param [Google::Apis::RequestOptions] options
3400
+ # Request-specific options
3401
+ #
3402
+ # @yield [result, err] Result & error if block supplied
3403
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl] parsed result object
3404
+ # @yieldparam err [StandardError] error object if request failed
3405
+ #
3406
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl]
3407
+ #
3408
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3409
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3410
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3411
+ 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)
3412
+ command = make_simple_command(:patch, 'v1beta/{+name}', options)
3413
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl::Representation
3414
+ command.request_object = google_cloud_discoveryengine_v1beta_control_object
3415
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl::Representation
3416
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl
3417
+ command.params['name'] = name unless name.nil?
3418
+ command.query['updateMask'] = update_mask unless update_mask.nil?
3419
+ command.query['fields'] = fields unless fields.nil?
3420
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3421
+ execute_or_queue_command(command, &block)
3422
+ end
3423
+
2995
3424
  # Converses a conversation.
2996
3425
  # @param [String] name
2997
3426
  # Required. The resource name of the Conversation to get. Format: `projects/`
@@ -4032,8 +4461,8 @@ module Google
4032
4461
  # permission to list DataStores under this location, regardless of whether or
4033
4462
  # not this data store exists, a PERMISSION_DENIED error is returned.
4034
4463
  # @param [String] filter
4035
- # Filter by solution type . For example: filter = 'solution_type:
4036
- # SOLUTION_TYPE_SEARCH'
4464
+ # Filter by solution type . For example: `filter = 'solution_type:
4465
+ # SOLUTION_TYPE_SEARCH'`
4037
4466
  # @param [Fixnum] page_size
4038
4467
  # Maximum number of DataStores to return. If unspecified, defaults to 10. The
4039
4468
  # maximum allowed value is 50. Values above 50 will be coerced to 50. If this
@@ -4505,6 +4934,200 @@ module Google
4505
4934
  execute_or_queue_command(command, &block)
4506
4935
  end
4507
4936
 
4937
+ # Creates a Control. By default 1000 controls are allowed for a data store. A
4938
+ # request can be submitted to adjust this limit. If the Control to create
4939
+ # already exists, an ALREADY_EXISTS error is returned.
4940
+ # @param [String] parent
4941
+ # Required. Full resource name of parent data store. Format: `projects/`
4942
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
4943
+ # `data_store_id`` or `projects/`project_number`/locations/`location_id`/
4944
+ # collections/`collection_id`/engines/`engine_id``.
4945
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl] google_cloud_discoveryengine_v1beta_control_object
4946
+ # @param [String] control_id
4947
+ # Required. The ID to use for the Control, which will become the final component
4948
+ # of the Control's resource name. This value must be within 1-63 characters.
4949
+ # Valid characters are /a-z-_/.
4950
+ # @param [String] fields
4951
+ # Selector specifying which fields to include in a partial response.
4952
+ # @param [String] quota_user
4953
+ # Available to use for quota purposes for server-side applications. Can be any
4954
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4955
+ # @param [Google::Apis::RequestOptions] options
4956
+ # Request-specific options
4957
+ #
4958
+ # @yield [result, err] Result & error if block supplied
4959
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl] parsed result object
4960
+ # @yieldparam err [StandardError] error object if request failed
4961
+ #
4962
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl]
4963
+ #
4964
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4965
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4966
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4967
+ 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)
4968
+ command = make_simple_command(:post, 'v1beta/{+parent}/controls', options)
4969
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl::Representation
4970
+ command.request_object = google_cloud_discoveryengine_v1beta_control_object
4971
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl::Representation
4972
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl
4973
+ command.params['parent'] = parent unless parent.nil?
4974
+ command.query['controlId'] = control_id unless control_id.nil?
4975
+ command.query['fields'] = fields unless fields.nil?
4976
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4977
+ execute_or_queue_command(command, &block)
4978
+ end
4979
+
4980
+ # Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error
4981
+ # is returned.
4982
+ # @param [String] name
4983
+ # Required. The resource name of the Control to delete. Format: `projects/`
4984
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
4985
+ # `data_store_id`/controls/`control_id``
4986
+ # @param [String] fields
4987
+ # Selector specifying which fields to include in a partial response.
4988
+ # @param [String] quota_user
4989
+ # Available to use for quota purposes for server-side applications. Can be any
4990
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4991
+ # @param [Google::Apis::RequestOptions] options
4992
+ # Request-specific options
4993
+ #
4994
+ # @yield [result, err] Result & error if block supplied
4995
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty] parsed result object
4996
+ # @yieldparam err [StandardError] error object if request failed
4997
+ #
4998
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty]
4999
+ #
5000
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5001
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5002
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5003
+ def delete_project_location_data_store_control(name, fields: nil, quota_user: nil, options: nil, &block)
5004
+ command = make_simple_command(:delete, 'v1beta/{+name}', options)
5005
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty::Representation
5006
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty
5007
+ command.params['name'] = name unless name.nil?
5008
+ command.query['fields'] = fields unless fields.nil?
5009
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5010
+ execute_or_queue_command(command, &block)
5011
+ end
5012
+
5013
+ # Gets a Control.
5014
+ # @param [String] name
5015
+ # Required. The resource name of the Control to get. Format: `projects/`
5016
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
5017
+ # `data_store_id`/controls/`control_id``
5018
+ # @param [String] fields
5019
+ # Selector specifying which fields to include in a partial response.
5020
+ # @param [String] quota_user
5021
+ # Available to use for quota purposes for server-side applications. Can be any
5022
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5023
+ # @param [Google::Apis::RequestOptions] options
5024
+ # Request-specific options
5025
+ #
5026
+ # @yield [result, err] Result & error if block supplied
5027
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl] parsed result object
5028
+ # @yieldparam err [StandardError] error object if request failed
5029
+ #
5030
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl]
5031
+ #
5032
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5033
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5034
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5035
+ def get_project_location_data_store_control(name, fields: nil, quota_user: nil, options: nil, &block)
5036
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
5037
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl::Representation
5038
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl
5039
+ command.params['name'] = name unless name.nil?
5040
+ command.query['fields'] = fields unless fields.nil?
5041
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5042
+ execute_or_queue_command(command, &block)
5043
+ end
5044
+
5045
+ # Lists all Controls by their parent DataStore.
5046
+ # @param [String] parent
5047
+ # Required. The data store resource name. Format: `projects/`project_number`/
5048
+ # locations/`location_id`/collections/`collection_id`/dataStores/`data_store_id``
5049
+ # or `projects/`project_number`/locations/`location_id`/collections/`
5050
+ # collection_id`/engines/`engine_id``.
5051
+ # @param [String] filter
5052
+ # Optional. A filter to apply on the list results. Supported features: * List
5053
+ # all the products under the parent branch if filter is unset. Currently this
5054
+ # field is unsupported.
5055
+ # @param [Fixnum] page_size
5056
+ # Optional. Maximum number of results to return. If unspecified, defaults to 50.
5057
+ # Max allowed value is 1000.
5058
+ # @param [String] page_token
5059
+ # Optional. A page token, received from a previous `ListControls` call. Provide
5060
+ # this to retrieve the subsequent page.
5061
+ # @param [String] fields
5062
+ # Selector specifying which fields to include in a partial response.
5063
+ # @param [String] quota_user
5064
+ # Available to use for quota purposes for server-side applications. Can be any
5065
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5066
+ # @param [Google::Apis::RequestOptions] options
5067
+ # Request-specific options
5068
+ #
5069
+ # @yield [result, err] Result & error if block supplied
5070
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListControlsResponse] parsed result object
5071
+ # @yieldparam err [StandardError] error object if request failed
5072
+ #
5073
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListControlsResponse]
5074
+ #
5075
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5076
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5077
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5078
+ def list_project_location_data_store_controls(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
5079
+ command = make_simple_command(:get, 'v1beta/{+parent}/controls', options)
5080
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListControlsResponse::Representation
5081
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListControlsResponse
5082
+ command.params['parent'] = parent unless parent.nil?
5083
+ command.query['filter'] = filter unless filter.nil?
5084
+ command.query['pageSize'] = page_size unless page_size.nil?
5085
+ command.query['pageToken'] = page_token unless page_token.nil?
5086
+ command.query['fields'] = fields unless fields.nil?
5087
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5088
+ execute_or_queue_command(command, &block)
5089
+ end
5090
+
5091
+ # Updates a Control. Control action type cannot be changed. If the Control to
5092
+ # update does not exist, a NOT_FOUND error is returned.
5093
+ # @param [String] name
5094
+ # Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/
5095
+ # controls/*`
5096
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl] google_cloud_discoveryengine_v1beta_control_object
5097
+ # @param [String] update_mask
5098
+ # Optional. Indicates which fields in the provided Control to update. The
5099
+ # following are NOT supported: * Control.name * Control.solution_type If not set
5100
+ # or empty, all supported fields are updated.
5101
+ # @param [String] fields
5102
+ # Selector specifying which fields to include in a partial response.
5103
+ # @param [String] quota_user
5104
+ # Available to use for quota purposes for server-side applications. Can be any
5105
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5106
+ # @param [Google::Apis::RequestOptions] options
5107
+ # Request-specific options
5108
+ #
5109
+ # @yield [result, err] Result & error if block supplied
5110
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl] parsed result object
5111
+ # @yieldparam err [StandardError] error object if request failed
5112
+ #
5113
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl]
5114
+ #
5115
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5116
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5117
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5118
+ 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)
5119
+ command = make_simple_command(:patch, 'v1beta/{+name}', options)
5120
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl::Representation
5121
+ command.request_object = google_cloud_discoveryengine_v1beta_control_object
5122
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl::Representation
5123
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaControl
5124
+ command.params['name'] = name unless name.nil?
5125
+ command.query['updateMask'] = update_mask unless update_mask.nil?
5126
+ command.query['fields'] = fields unless fields.nil?
5127
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5128
+ execute_or_queue_command(command, &block)
5129
+ end
5130
+
4508
5131
  # Converses a conversation.
4509
5132
  # @param [String] name
4510
5133
  # Required. The resource name of the Conversation to get. Format: `projects/`
@@ -5999,6 +6622,9 @@ module Google
5999
6622
  # across multiple DataStore, the format is: `projects/`project`/locations/`
6000
6623
  # location``.
6001
6624
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent] google_cloud_discoveryengine_v1beta_user_event_object
6625
+ # @param [Boolean] write_async
6626
+ # If set to true, the user event is written asynchronously after validation, and
6627
+ # the API responds without waiting for the write.
6002
6628
  # @param [String] fields
6003
6629
  # Selector specifying which fields to include in a partial response.
6004
6630
  # @param [String] quota_user
@@ -6016,13 +6642,14 @@ module Google
6016
6642
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6017
6643
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6018
6644
  # @raise [Google::Apis::AuthorizationError] Authorization is required
6019
- 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)
6645
+ 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)
6020
6646
  command = make_simple_command(:post, 'v1beta/{+parent}/userEvents:write', options)
6021
6647
  command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent::Representation
6022
6648
  command.request_object = google_cloud_discoveryengine_v1beta_user_event_object
6023
6649
  command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent::Representation
6024
6650
  command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent
6025
6651
  command.params['parent'] = parent unless parent.nil?
6652
+ command.query['writeAsync'] = write_async unless write_async.nil?
6026
6653
  command.query['fields'] = fields unless fields.nil?
6027
6654
  command.query['quotaUser'] = quota_user unless quota_user.nil?
6028
6655
  execute_or_queue_command(command, &block)
@@ -6167,6 +6794,54 @@ module Google
6167
6794
  execute_or_queue_command(command, &block)
6168
6795
  end
6169
6796
 
6797
+ # Writes a single user event from the browser. This uses a GET request to due to
6798
+ # browser restriction of POST-ing to a third-party domain. This method is used
6799
+ # only by the Discovery Engine API JavaScript pixel and Google Tag Manager.
6800
+ # Users should not call this method directly.
6801
+ # @param [String] parent
6802
+ # Required. The parent DataStore resource name, such as `projects/`project`/
6803
+ # locations/`location`/collections/`collection`/dataStores/`data_store``.
6804
+ # @param [Fixnum] ets
6805
+ # The event timestamp in milliseconds. This prevents browser caching of
6806
+ # otherwise identical get requests. The name is abbreviated to reduce the
6807
+ # payload bytes.
6808
+ # @param [String] uri
6809
+ # The URL including cgi-parameters but excluding the hash fragment with a length
6810
+ # limit of 5,000 characters. This is often more useful than the referer URL,
6811
+ # because many browsers only send the domain for third-party requests.
6812
+ # @param [String] user_event
6813
+ # Required. URL encoded UserEvent proto with a length limit of 2,000,000
6814
+ # characters.
6815
+ # @param [String] fields
6816
+ # Selector specifying which fields to include in a partial response.
6817
+ # @param [String] quota_user
6818
+ # Available to use for quota purposes for server-side applications. Can be any
6819
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
6820
+ # @param [Google::Apis::RequestOptions] options
6821
+ # Request-specific options
6822
+ #
6823
+ # @yield [result, err] Result & error if block supplied
6824
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleApiHttpBody] parsed result object
6825
+ # @yieldparam err [StandardError] error object if request failed
6826
+ #
6827
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleApiHttpBody]
6828
+ #
6829
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6830
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6831
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
6832
+ def collect_project_location_user_event(parent, ets: nil, uri: nil, user_event: nil, fields: nil, quota_user: nil, options: nil, &block)
6833
+ command = make_simple_command(:get, 'v1beta/{+parent}/userEvents:collect', options)
6834
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleApiHttpBody::Representation
6835
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleApiHttpBody
6836
+ command.params['parent'] = parent unless parent.nil?
6837
+ command.query['ets'] = ets unless ets.nil?
6838
+ command.query['uri'] = uri unless uri.nil?
6839
+ command.query['userEvent'] = user_event unless user_event.nil?
6840
+ command.query['fields'] = fields unless fields.nil?
6841
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
6842
+ execute_or_queue_command(command, &block)
6843
+ end
6844
+
6170
6845
  # Writes a single user event.
6171
6846
  # @param [String] parent
6172
6847
  # Required. The parent resource name. If the write user event action is applied
@@ -6176,6 +6851,9 @@ module Google
6176
6851
  # across multiple DataStore, the format is: `projects/`project`/locations/`
6177
6852
  # location``.
6178
6853
  # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent] google_cloud_discoveryengine_v1beta_user_event_object
6854
+ # @param [Boolean] write_async
6855
+ # If set to true, the user event is written asynchronously after validation, and
6856
+ # the API responds without waiting for the write.
6179
6857
  # @param [String] fields
6180
6858
  # Selector specifying which fields to include in a partial response.
6181
6859
  # @param [String] quota_user
@@ -6193,13 +6871,14 @@ module Google
6193
6871
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6194
6872
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6195
6873
  # @raise [Google::Apis::AuthorizationError] Authorization is required
6196
- def write_project_location_user_event(parent, google_cloud_discoveryengine_v1beta_user_event_object = nil, fields: nil, quota_user: nil, options: nil, &block)
6874
+ 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)
6197
6875
  command = make_simple_command(:post, 'v1beta/{+parent}/userEvents:write', options)
6198
6876
  command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent::Representation
6199
6877
  command.request_object = google_cloud_discoveryengine_v1beta_user_event_object
6200
6878
  command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent::Representation
6201
6879
  command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent
6202
6880
  command.params['parent'] = parent unless parent.nil?
6881
+ command.query['writeAsync'] = write_async unless write_async.nil?
6203
6882
  command.query['fields'] = fields unless fields.nil?
6204
6883
  command.query['quotaUser'] = quota_user unless quota_user.nil?
6205
6884
  execute_or_queue_command(command, &block)