google-apis-discoveryengine_v1 0.4.0 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -0
  3. data/lib/google/apis/discoveryengine_v1/classes.rb +1822 -199
  4. data/lib/google/apis/discoveryengine_v1/gem_version.rb +2 -2
  5. data/lib/google/apis/discoveryengine_v1/representations.rb +720 -13
  6. data/lib/google/apis/discoveryengine_v1/service.rb +686 -7
  7. metadata +3 -3
data/lib/google/apis/discoveryengine_v1/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::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ProvisionProjectRequest] google_cloud_discoveryengine_v1_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::DiscoveryengineV1::GoogleLongrunningOperation] parsed result object
72
+ # @yieldparam err [StandardError] error object if request failed
73
+ #
74
+ # @return [Google::Apis::DiscoveryengineV1::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_v1_provision_project_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
80
+ command = make_simple_command(:post, 'v1/{+name}:provision', options)
81
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ProvisionProjectRequest::Representation
82
+ command.request_object = google_cloud_discoveryengine_v1_provision_project_request_object
83
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
84
+ command.response_class = Google::Apis::DiscoveryengineV1::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
@@ -815,6 +852,200 @@ module Google
815
852
  execute_or_queue_command(command, &block)
816
853
  end
817
854
 
855
+ # Creates a Control. By default 1000 controls are allowed for a data store. A
856
+ # request can be submitted to adjust this limit. If the Control to create
857
+ # already exists, an ALREADY_EXISTS error is returned.
858
+ # @param [String] parent
859
+ # Required. Full resource name of parent data store. Format: `projects/`
860
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
861
+ # `data_store_id`` or `projects/`project_number`/locations/`location_id`/
862
+ # collections/`collection_id`/engines/`engine_id``.
863
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control] google_cloud_discoveryengine_v1_control_object
864
+ # @param [String] control_id
865
+ # Required. The ID to use for the Control, which will become the final component
866
+ # of the Control's resource name. This value must be within 1-63 characters.
867
+ # Valid characters are /a-z-_/.
868
+ # @param [String] fields
869
+ # Selector specifying which fields to include in a partial response.
870
+ # @param [String] quota_user
871
+ # Available to use for quota purposes for server-side applications. Can be any
872
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
873
+ # @param [Google::Apis::RequestOptions] options
874
+ # Request-specific options
875
+ #
876
+ # @yield [result, err] Result & error if block supplied
877
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control] parsed result object
878
+ # @yieldparam err [StandardError] error object if request failed
879
+ #
880
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control]
881
+ #
882
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
883
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
884
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
885
+ def create_project_location_collection_data_store_control(parent, google_cloud_discoveryengine_v1_control_object = nil, control_id: nil, fields: nil, quota_user: nil, options: nil, &block)
886
+ command = make_simple_command(:post, 'v1/{+parent}/controls', options)
887
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
888
+ command.request_object = google_cloud_discoveryengine_v1_control_object
889
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
890
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control
891
+ command.params['parent'] = parent unless parent.nil?
892
+ command.query['controlId'] = control_id unless control_id.nil?
893
+ command.query['fields'] = fields unless fields.nil?
894
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
895
+ execute_or_queue_command(command, &block)
896
+ end
897
+
898
+ # Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error
899
+ # is returned.
900
+ # @param [String] name
901
+ # Required. The resource name of the Control to delete. Format: `projects/`
902
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
903
+ # `data_store_id`/controls/`control_id``
904
+ # @param [String] fields
905
+ # Selector specifying which fields to include in a partial response.
906
+ # @param [String] quota_user
907
+ # Available to use for quota purposes for server-side applications. Can be any
908
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
909
+ # @param [Google::Apis::RequestOptions] options
910
+ # Request-specific options
911
+ #
912
+ # @yield [result, err] Result & error if block supplied
913
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty] parsed result object
914
+ # @yieldparam err [StandardError] error object if request failed
915
+ #
916
+ # @return [Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty]
917
+ #
918
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
919
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
920
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
921
+ def delete_project_location_collection_data_store_control(name, fields: nil, quota_user: nil, options: nil, &block)
922
+ command = make_simple_command(:delete, 'v1/{+name}', options)
923
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty::Representation
924
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty
925
+ command.params['name'] = name unless name.nil?
926
+ command.query['fields'] = fields unless fields.nil?
927
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
928
+ execute_or_queue_command(command, &block)
929
+ end
930
+
931
+ # Gets a Control.
932
+ # @param [String] name
933
+ # Required. The resource name of the Control to get. Format: `projects/`
934
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
935
+ # `data_store_id`/controls/`control_id``
936
+ # @param [String] fields
937
+ # Selector specifying which fields to include in a partial response.
938
+ # @param [String] quota_user
939
+ # Available to use for quota purposes for server-side applications. Can be any
940
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
941
+ # @param [Google::Apis::RequestOptions] options
942
+ # Request-specific options
943
+ #
944
+ # @yield [result, err] Result & error if block supplied
945
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control] parsed result object
946
+ # @yieldparam err [StandardError] error object if request failed
947
+ #
948
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control]
949
+ #
950
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
951
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
952
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
953
+ def get_project_location_collection_data_store_control(name, fields: nil, quota_user: nil, options: nil, &block)
954
+ command = make_simple_command(:get, 'v1/{+name}', options)
955
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
956
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control
957
+ command.params['name'] = name unless name.nil?
958
+ command.query['fields'] = fields unless fields.nil?
959
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
960
+ execute_or_queue_command(command, &block)
961
+ end
962
+
963
+ # Lists all Controls by their parent DataStore.
964
+ # @param [String] parent
965
+ # Required. The data store resource name. Format: `projects/`project_number`/
966
+ # locations/`location_id`/collections/`collection_id`/dataStores/`data_store_id``
967
+ # or `projects/`project_number`/locations/`location_id`/collections/`
968
+ # collection_id`/engines/`engine_id``.
969
+ # @param [String] filter
970
+ # Optional. A filter to apply on the list results. Supported features: * List
971
+ # all the products under the parent branch if filter is unset. Currently this
972
+ # field is unsupported.
973
+ # @param [Fixnum] page_size
974
+ # Optional. Maximum number of results to return. If unspecified, defaults to 50.
975
+ # Max allowed value is 1000.
976
+ # @param [String] page_token
977
+ # Optional. A page token, received from a previous `ListControls` call. Provide
978
+ # this to retrieve the subsequent page.
979
+ # @param [String] fields
980
+ # Selector specifying which fields to include in a partial response.
981
+ # @param [String] quota_user
982
+ # Available to use for quota purposes for server-side applications. Can be any
983
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
984
+ # @param [Google::Apis::RequestOptions] options
985
+ # Request-specific options
986
+ #
987
+ # @yield [result, err] Result & error if block supplied
988
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListControlsResponse] parsed result object
989
+ # @yieldparam err [StandardError] error object if request failed
990
+ #
991
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListControlsResponse]
992
+ #
993
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
994
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
995
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
996
+ 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)
997
+ command = make_simple_command(:get, 'v1/{+parent}/controls', options)
998
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListControlsResponse::Representation
999
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListControlsResponse
1000
+ command.params['parent'] = parent unless parent.nil?
1001
+ command.query['filter'] = filter unless filter.nil?
1002
+ command.query['pageSize'] = page_size unless page_size.nil?
1003
+ command.query['pageToken'] = page_token unless page_token.nil?
1004
+ command.query['fields'] = fields unless fields.nil?
1005
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1006
+ execute_or_queue_command(command, &block)
1007
+ end
1008
+
1009
+ # Updates a Control. Control action type cannot be changed. If the Control to
1010
+ # update does not exist, a NOT_FOUND error is returned.
1011
+ # @param [String] name
1012
+ # Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/
1013
+ # controls/*`
1014
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control] google_cloud_discoveryengine_v1_control_object
1015
+ # @param [String] update_mask
1016
+ # Optional. Indicates which fields in the provided Control to update. The
1017
+ # following are NOT supported: * Control.name * Control.solution_type If not set
1018
+ # or empty, all supported fields are updated.
1019
+ # @param [String] fields
1020
+ # Selector specifying which fields to include in a partial response.
1021
+ # @param [String] quota_user
1022
+ # Available to use for quota purposes for server-side applications. Can be any
1023
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1024
+ # @param [Google::Apis::RequestOptions] options
1025
+ # Request-specific options
1026
+ #
1027
+ # @yield [result, err] Result & error if block supplied
1028
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control] parsed result object
1029
+ # @yieldparam err [StandardError] error object if request failed
1030
+ #
1031
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control]
1032
+ #
1033
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1034
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1035
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1036
+ def patch_project_location_collection_data_store_control(name, google_cloud_discoveryengine_v1_control_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1037
+ command = make_simple_command(:patch, 'v1/{+name}', options)
1038
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
1039
+ command.request_object = google_cloud_discoveryengine_v1_control_object
1040
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
1041
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control
1042
+ command.params['name'] = name unless name.nil?
1043
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1044
+ command.query['fields'] = fields unless fields.nil?
1045
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1046
+ execute_or_queue_command(command, &block)
1047
+ end
1048
+
818
1049
  # Converses a conversation.
819
1050
  # @param [String] name
820
1051
  # Required. The resource name of the Conversation to get. Format: `projects/`
@@ -2490,6 +2721,9 @@ module Google
2490
2721
  # across multiple DataStore, the format is: `projects/`project`/locations/`
2491
2722
  # location``.
2492
2723
  # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent] google_cloud_discoveryengine_v1_user_event_object
2724
+ # @param [Boolean] write_async
2725
+ # If set to true, the user event is written asynchronously after validation, and
2726
+ # the API responds without waiting for the write.
2493
2727
  # @param [String] fields
2494
2728
  # Selector specifying which fields to include in a partial response.
2495
2729
  # @param [String] quota_user
@@ -2507,13 +2741,14 @@ module Google
2507
2741
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2508
2742
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2509
2743
  # @raise [Google::Apis::AuthorizationError] Authorization is required
2510
- def write_project_location_collection_data_store_user_event(parent, google_cloud_discoveryengine_v1_user_event_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2744
+ def write_project_location_collection_data_store_user_event(parent, google_cloud_discoveryengine_v1_user_event_object = nil, write_async: nil, fields: nil, quota_user: nil, options: nil, &block)
2511
2745
  command = make_simple_command(:post, 'v1/{+parent}/userEvents:write', options)
2512
2746
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent::Representation
2513
2747
  command.request_object = google_cloud_discoveryengine_v1_user_event_object
2514
2748
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent::Representation
2515
2749
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent
2516
2750
  command.params['parent'] = parent unless parent.nil?
2751
+ command.query['writeAsync'] = write_async unless write_async.nil?
2517
2752
  command.query['fields'] = fields unless fields.nil?
2518
2753
  command.query['quotaUser'] = quota_user unless quota_user.nil?
2519
2754
  execute_or_queue_command(command, &block)
@@ -2706,6 +2941,200 @@ module Google
2706
2941
  execute_or_queue_command(command, &block)
2707
2942
  end
2708
2943
 
2944
+ # Creates a Control. By default 1000 controls are allowed for a data store. A
2945
+ # request can be submitted to adjust this limit. If the Control to create
2946
+ # already exists, an ALREADY_EXISTS error is returned.
2947
+ # @param [String] parent
2948
+ # Required. Full resource name of parent data store. Format: `projects/`
2949
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
2950
+ # `data_store_id`` or `projects/`project_number`/locations/`location_id`/
2951
+ # collections/`collection_id`/engines/`engine_id``.
2952
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control] google_cloud_discoveryengine_v1_control_object
2953
+ # @param [String] control_id
2954
+ # Required. The ID to use for the Control, which will become the final component
2955
+ # of the Control's resource name. This value must be within 1-63 characters.
2956
+ # Valid characters are /a-z-_/.
2957
+ # @param [String] fields
2958
+ # Selector specifying which fields to include in a partial response.
2959
+ # @param [String] quota_user
2960
+ # Available to use for quota purposes for server-side applications. Can be any
2961
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2962
+ # @param [Google::Apis::RequestOptions] options
2963
+ # Request-specific options
2964
+ #
2965
+ # @yield [result, err] Result & error if block supplied
2966
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control] parsed result object
2967
+ # @yieldparam err [StandardError] error object if request failed
2968
+ #
2969
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control]
2970
+ #
2971
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2972
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2973
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2974
+ def create_project_location_collection_engine_control(parent, google_cloud_discoveryengine_v1_control_object = nil, control_id: nil, fields: nil, quota_user: nil, options: nil, &block)
2975
+ command = make_simple_command(:post, 'v1/{+parent}/controls', options)
2976
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
2977
+ command.request_object = google_cloud_discoveryengine_v1_control_object
2978
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
2979
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control
2980
+ command.params['parent'] = parent unless parent.nil?
2981
+ command.query['controlId'] = control_id unless control_id.nil?
2982
+ command.query['fields'] = fields unless fields.nil?
2983
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2984
+ execute_or_queue_command(command, &block)
2985
+ end
2986
+
2987
+ # Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error
2988
+ # is returned.
2989
+ # @param [String] name
2990
+ # Required. The resource name of the Control to delete. Format: `projects/`
2991
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
2992
+ # `data_store_id`/controls/`control_id``
2993
+ # @param [String] fields
2994
+ # Selector specifying which fields to include in a partial response.
2995
+ # @param [String] quota_user
2996
+ # Available to use for quota purposes for server-side applications. Can be any
2997
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2998
+ # @param [Google::Apis::RequestOptions] options
2999
+ # Request-specific options
3000
+ #
3001
+ # @yield [result, err] Result & error if block supplied
3002
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty] parsed result object
3003
+ # @yieldparam err [StandardError] error object if request failed
3004
+ #
3005
+ # @return [Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty]
3006
+ #
3007
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3008
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3009
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3010
+ def delete_project_location_collection_engine_control(name, fields: nil, quota_user: nil, options: nil, &block)
3011
+ command = make_simple_command(:delete, 'v1/{+name}', options)
3012
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty::Representation
3013
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty
3014
+ command.params['name'] = name unless name.nil?
3015
+ command.query['fields'] = fields unless fields.nil?
3016
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3017
+ execute_or_queue_command(command, &block)
3018
+ end
3019
+
3020
+ # Gets a Control.
3021
+ # @param [String] name
3022
+ # Required. The resource name of the Control to get. Format: `projects/`
3023
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
3024
+ # `data_store_id`/controls/`control_id``
3025
+ # @param [String] fields
3026
+ # Selector specifying which fields to include in a partial response.
3027
+ # @param [String] quota_user
3028
+ # Available to use for quota purposes for server-side applications. Can be any
3029
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3030
+ # @param [Google::Apis::RequestOptions] options
3031
+ # Request-specific options
3032
+ #
3033
+ # @yield [result, err] Result & error if block supplied
3034
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control] parsed result object
3035
+ # @yieldparam err [StandardError] error object if request failed
3036
+ #
3037
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control]
3038
+ #
3039
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3040
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3041
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3042
+ def get_project_location_collection_engine_control(name, fields: nil, quota_user: nil, options: nil, &block)
3043
+ command = make_simple_command(:get, 'v1/{+name}', options)
3044
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
3045
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control
3046
+ command.params['name'] = name unless name.nil?
3047
+ command.query['fields'] = fields unless fields.nil?
3048
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3049
+ execute_or_queue_command(command, &block)
3050
+ end
3051
+
3052
+ # Lists all Controls by their parent DataStore.
3053
+ # @param [String] parent
3054
+ # Required. The data store resource name. Format: `projects/`project_number`/
3055
+ # locations/`location_id`/collections/`collection_id`/dataStores/`data_store_id``
3056
+ # or `projects/`project_number`/locations/`location_id`/collections/`
3057
+ # collection_id`/engines/`engine_id``.
3058
+ # @param [String] filter
3059
+ # Optional. A filter to apply on the list results. Supported features: * List
3060
+ # all the products under the parent branch if filter is unset. Currently this
3061
+ # field is unsupported.
3062
+ # @param [Fixnum] page_size
3063
+ # Optional. Maximum number of results to return. If unspecified, defaults to 50.
3064
+ # Max allowed value is 1000.
3065
+ # @param [String] page_token
3066
+ # Optional. A page token, received from a previous `ListControls` call. Provide
3067
+ # this to retrieve the subsequent page.
3068
+ # @param [String] fields
3069
+ # Selector specifying which fields to include in a partial response.
3070
+ # @param [String] quota_user
3071
+ # Available to use for quota purposes for server-side applications. Can be any
3072
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3073
+ # @param [Google::Apis::RequestOptions] options
3074
+ # Request-specific options
3075
+ #
3076
+ # @yield [result, err] Result & error if block supplied
3077
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListControlsResponse] parsed result object
3078
+ # @yieldparam err [StandardError] error object if request failed
3079
+ #
3080
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListControlsResponse]
3081
+ #
3082
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3083
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3084
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3085
+ def list_project_location_collection_engine_controls(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
3086
+ command = make_simple_command(:get, 'v1/{+parent}/controls', options)
3087
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListControlsResponse::Representation
3088
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListControlsResponse
3089
+ command.params['parent'] = parent unless parent.nil?
3090
+ command.query['filter'] = filter unless filter.nil?
3091
+ command.query['pageSize'] = page_size unless page_size.nil?
3092
+ command.query['pageToken'] = page_token unless page_token.nil?
3093
+ command.query['fields'] = fields unless fields.nil?
3094
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3095
+ execute_or_queue_command(command, &block)
3096
+ end
3097
+
3098
+ # Updates a Control. Control action type cannot be changed. If the Control to
3099
+ # update does not exist, a NOT_FOUND error is returned.
3100
+ # @param [String] name
3101
+ # Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/
3102
+ # controls/*`
3103
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control] google_cloud_discoveryengine_v1_control_object
3104
+ # @param [String] update_mask
3105
+ # Optional. Indicates which fields in the provided Control to update. The
3106
+ # following are NOT supported: * Control.name * Control.solution_type If not set
3107
+ # or empty, all supported fields are updated.
3108
+ # @param [String] fields
3109
+ # Selector specifying which fields to include in a partial response.
3110
+ # @param [String] quota_user
3111
+ # Available to use for quota purposes for server-side applications. Can be any
3112
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3113
+ # @param [Google::Apis::RequestOptions] options
3114
+ # Request-specific options
3115
+ #
3116
+ # @yield [result, err] Result & error if block supplied
3117
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control] parsed result object
3118
+ # @yieldparam err [StandardError] error object if request failed
3119
+ #
3120
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control]
3121
+ #
3122
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3123
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3124
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3125
+ def patch_project_location_collection_engine_control(name, google_cloud_discoveryengine_v1_control_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
3126
+ command = make_simple_command(:patch, 'v1/{+name}', options)
3127
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
3128
+ command.request_object = google_cloud_discoveryengine_v1_control_object
3129
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
3130
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control
3131
+ command.params['name'] = name unless name.nil?
3132
+ command.query['updateMask'] = update_mask unless update_mask.nil?
3133
+ command.query['fields'] = fields unless fields.nil?
3134
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3135
+ execute_or_queue_command(command, &block)
3136
+ end
3137
+
2709
3138
  # Converses a conversation.
2710
3139
  # @param [String] name
2711
3140
  # Required. The resource name of the Conversation to get. Format: `projects/`
@@ -3633,8 +4062,8 @@ module Google
3633
4062
  # permission to list DataStores under this location, regardless of whether or
3634
4063
  # not this data store exists, a PERMISSION_DENIED error is returned.
3635
4064
  # @param [String] filter
3636
- # Filter by solution type . For example: filter = 'solution_type:
3637
- # SOLUTION_TYPE_SEARCH'
4065
+ # Filter by solution type . For example: `filter = 'solution_type:
4066
+ # SOLUTION_TYPE_SEARCH'`
3638
4067
  # @param [Fixnum] page_size
3639
4068
  # Maximum number of DataStores to return. If unspecified, defaults to 10. The
3640
4069
  # maximum allowed value is 50. Values above 50 will be coerced to 50. If this
@@ -4106,6 +4535,200 @@ module Google
4106
4535
  execute_or_queue_command(command, &block)
4107
4536
  end
4108
4537
 
4538
+ # Creates a Control. By default 1000 controls are allowed for a data store. A
4539
+ # request can be submitted to adjust this limit. If the Control to create
4540
+ # already exists, an ALREADY_EXISTS error is returned.
4541
+ # @param [String] parent
4542
+ # Required. Full resource name of parent data store. Format: `projects/`
4543
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
4544
+ # `data_store_id`` or `projects/`project_number`/locations/`location_id`/
4545
+ # collections/`collection_id`/engines/`engine_id``.
4546
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control] google_cloud_discoveryengine_v1_control_object
4547
+ # @param [String] control_id
4548
+ # Required. The ID to use for the Control, which will become the final component
4549
+ # of the Control's resource name. This value must be within 1-63 characters.
4550
+ # Valid characters are /a-z-_/.
4551
+ # @param [String] fields
4552
+ # Selector specifying which fields to include in a partial response.
4553
+ # @param [String] quota_user
4554
+ # Available to use for quota purposes for server-side applications. Can be any
4555
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4556
+ # @param [Google::Apis::RequestOptions] options
4557
+ # Request-specific options
4558
+ #
4559
+ # @yield [result, err] Result & error if block supplied
4560
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control] parsed result object
4561
+ # @yieldparam err [StandardError] error object if request failed
4562
+ #
4563
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control]
4564
+ #
4565
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4566
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4567
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4568
+ def create_project_location_data_store_control(parent, google_cloud_discoveryengine_v1_control_object = nil, control_id: nil, fields: nil, quota_user: nil, options: nil, &block)
4569
+ command = make_simple_command(:post, 'v1/{+parent}/controls', options)
4570
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
4571
+ command.request_object = google_cloud_discoveryengine_v1_control_object
4572
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
4573
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control
4574
+ command.params['parent'] = parent unless parent.nil?
4575
+ command.query['controlId'] = control_id unless control_id.nil?
4576
+ command.query['fields'] = fields unless fields.nil?
4577
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4578
+ execute_or_queue_command(command, &block)
4579
+ end
4580
+
4581
+ # Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error
4582
+ # is returned.
4583
+ # @param [String] name
4584
+ # Required. The resource name of the Control to delete. Format: `projects/`
4585
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
4586
+ # `data_store_id`/controls/`control_id``
4587
+ # @param [String] fields
4588
+ # Selector specifying which fields to include in a partial response.
4589
+ # @param [String] quota_user
4590
+ # Available to use for quota purposes for server-side applications. Can be any
4591
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4592
+ # @param [Google::Apis::RequestOptions] options
4593
+ # Request-specific options
4594
+ #
4595
+ # @yield [result, err] Result & error if block supplied
4596
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty] parsed result object
4597
+ # @yieldparam err [StandardError] error object if request failed
4598
+ #
4599
+ # @return [Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty]
4600
+ #
4601
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4602
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4603
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4604
+ def delete_project_location_data_store_control(name, fields: nil, quota_user: nil, options: nil, &block)
4605
+ command = make_simple_command(:delete, 'v1/{+name}', options)
4606
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty::Representation
4607
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty
4608
+ command.params['name'] = name unless name.nil?
4609
+ command.query['fields'] = fields unless fields.nil?
4610
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4611
+ execute_or_queue_command(command, &block)
4612
+ end
4613
+
4614
+ # Gets a Control.
4615
+ # @param [String] name
4616
+ # Required. The resource name of the Control to get. Format: `projects/`
4617
+ # project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
4618
+ # `data_store_id`/controls/`control_id``
4619
+ # @param [String] fields
4620
+ # Selector specifying which fields to include in a partial response.
4621
+ # @param [String] quota_user
4622
+ # Available to use for quota purposes for server-side applications. Can be any
4623
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4624
+ # @param [Google::Apis::RequestOptions] options
4625
+ # Request-specific options
4626
+ #
4627
+ # @yield [result, err] Result & error if block supplied
4628
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control] parsed result object
4629
+ # @yieldparam err [StandardError] error object if request failed
4630
+ #
4631
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control]
4632
+ #
4633
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4634
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4635
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4636
+ def get_project_location_data_store_control(name, fields: nil, quota_user: nil, options: nil, &block)
4637
+ command = make_simple_command(:get, 'v1/{+name}', options)
4638
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
4639
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control
4640
+ command.params['name'] = name unless name.nil?
4641
+ command.query['fields'] = fields unless fields.nil?
4642
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4643
+ execute_or_queue_command(command, &block)
4644
+ end
4645
+
4646
+ # Lists all Controls by their parent DataStore.
4647
+ # @param [String] parent
4648
+ # Required. The data store resource name. Format: `projects/`project_number`/
4649
+ # locations/`location_id`/collections/`collection_id`/dataStores/`data_store_id``
4650
+ # or `projects/`project_number`/locations/`location_id`/collections/`
4651
+ # collection_id`/engines/`engine_id``.
4652
+ # @param [String] filter
4653
+ # Optional. A filter to apply on the list results. Supported features: * List
4654
+ # all the products under the parent branch if filter is unset. Currently this
4655
+ # field is unsupported.
4656
+ # @param [Fixnum] page_size
4657
+ # Optional. Maximum number of results to return. If unspecified, defaults to 50.
4658
+ # Max allowed value is 1000.
4659
+ # @param [String] page_token
4660
+ # Optional. A page token, received from a previous `ListControls` call. Provide
4661
+ # this to retrieve the subsequent page.
4662
+ # @param [String] fields
4663
+ # Selector specifying which fields to include in a partial response.
4664
+ # @param [String] quota_user
4665
+ # Available to use for quota purposes for server-side applications. Can be any
4666
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4667
+ # @param [Google::Apis::RequestOptions] options
4668
+ # Request-specific options
4669
+ #
4670
+ # @yield [result, err] Result & error if block supplied
4671
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListControlsResponse] parsed result object
4672
+ # @yieldparam err [StandardError] error object if request failed
4673
+ #
4674
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListControlsResponse]
4675
+ #
4676
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4677
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4678
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4679
+ def list_project_location_data_store_controls(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
4680
+ command = make_simple_command(:get, 'v1/{+parent}/controls', options)
4681
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListControlsResponse::Representation
4682
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListControlsResponse
4683
+ command.params['parent'] = parent unless parent.nil?
4684
+ command.query['filter'] = filter unless filter.nil?
4685
+ command.query['pageSize'] = page_size unless page_size.nil?
4686
+ command.query['pageToken'] = page_token unless page_token.nil?
4687
+ command.query['fields'] = fields unless fields.nil?
4688
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4689
+ execute_or_queue_command(command, &block)
4690
+ end
4691
+
4692
+ # Updates a Control. Control action type cannot be changed. If the Control to
4693
+ # update does not exist, a NOT_FOUND error is returned.
4694
+ # @param [String] name
4695
+ # Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/
4696
+ # controls/*`
4697
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control] google_cloud_discoveryengine_v1_control_object
4698
+ # @param [String] update_mask
4699
+ # Optional. Indicates which fields in the provided Control to update. The
4700
+ # following are NOT supported: * Control.name * Control.solution_type If not set
4701
+ # or empty, all supported fields are updated.
4702
+ # @param [String] fields
4703
+ # Selector specifying which fields to include in a partial response.
4704
+ # @param [String] quota_user
4705
+ # Available to use for quota purposes for server-side applications. Can be any
4706
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4707
+ # @param [Google::Apis::RequestOptions] options
4708
+ # Request-specific options
4709
+ #
4710
+ # @yield [result, err] Result & error if block supplied
4711
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control] parsed result object
4712
+ # @yieldparam err [StandardError] error object if request failed
4713
+ #
4714
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control]
4715
+ #
4716
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4717
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4718
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4719
+ def patch_project_location_data_store_control(name, google_cloud_discoveryengine_v1_control_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
4720
+ command = make_simple_command(:patch, 'v1/{+name}', options)
4721
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
4722
+ command.request_object = google_cloud_discoveryengine_v1_control_object
4723
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control::Representation
4724
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control
4725
+ command.params['name'] = name unless name.nil?
4726
+ command.query['updateMask'] = update_mask unless update_mask.nil?
4727
+ command.query['fields'] = fields unless fields.nil?
4728
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4729
+ execute_or_queue_command(command, &block)
4730
+ end
4731
+
4109
4732
  # Converses a conversation.
4110
4733
  # @param [String] name
4111
4734
  # Required. The resource name of the Conversation to get. Format: `projects/`
@@ -5487,6 +6110,9 @@ module Google
5487
6110
  # across multiple DataStore, the format is: `projects/`project`/locations/`
5488
6111
  # location``.
5489
6112
  # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent] google_cloud_discoveryengine_v1_user_event_object
6113
+ # @param [Boolean] write_async
6114
+ # If set to true, the user event is written asynchronously after validation, and
6115
+ # the API responds without waiting for the write.
5490
6116
  # @param [String] fields
5491
6117
  # Selector specifying which fields to include in a partial response.
5492
6118
  # @param [String] quota_user
@@ -5504,13 +6130,14 @@ module Google
5504
6130
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5505
6131
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5506
6132
  # @raise [Google::Apis::AuthorizationError] Authorization is required
5507
- def write_project_location_data_store_user_event(parent, google_cloud_discoveryengine_v1_user_event_object = nil, fields: nil, quota_user: nil, options: nil, &block)
6133
+ def write_project_location_data_store_user_event(parent, google_cloud_discoveryengine_v1_user_event_object = nil, write_async: nil, fields: nil, quota_user: nil, options: nil, &block)
5508
6134
  command = make_simple_command(:post, 'v1/{+parent}/userEvents:write', options)
5509
6135
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent::Representation
5510
6136
  command.request_object = google_cloud_discoveryengine_v1_user_event_object
5511
6137
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent::Representation
5512
6138
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent
5513
6139
  command.params['parent'] = parent unless parent.nil?
6140
+ command.query['writeAsync'] = write_async unless write_async.nil?
5514
6141
  command.query['fields'] = fields unless fields.nil?
5515
6142
  command.query['quotaUser'] = quota_user unless quota_user.nil?
5516
6143
  execute_or_queue_command(command, &block)
@@ -5655,6 +6282,54 @@ module Google
5655
6282
  execute_or_queue_command(command, &block)
5656
6283
  end
5657
6284
 
6285
+ # Writes a single user event from the browser. This uses a GET request to due to
6286
+ # browser restriction of POST-ing to a third-party domain. This method is used
6287
+ # only by the Discovery Engine API JavaScript pixel and Google Tag Manager.
6288
+ # Users should not call this method directly.
6289
+ # @param [String] parent
6290
+ # Required. The parent DataStore resource name, such as `projects/`project`/
6291
+ # locations/`location`/collections/`collection`/dataStores/`data_store``.
6292
+ # @param [Fixnum] ets
6293
+ # The event timestamp in milliseconds. This prevents browser caching of
6294
+ # otherwise identical get requests. The name is abbreviated to reduce the
6295
+ # payload bytes.
6296
+ # @param [String] uri
6297
+ # The URL including cgi-parameters but excluding the hash fragment with a length
6298
+ # limit of 5,000 characters. This is often more useful than the referer URL,
6299
+ # because many browsers only send the domain for third-party requests.
6300
+ # @param [String] user_event
6301
+ # Required. URL encoded UserEvent proto with a length limit of 2,000,000
6302
+ # characters.
6303
+ # @param [String] fields
6304
+ # Selector specifying which fields to include in a partial response.
6305
+ # @param [String] quota_user
6306
+ # Available to use for quota purposes for server-side applications. Can be any
6307
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
6308
+ # @param [Google::Apis::RequestOptions] options
6309
+ # Request-specific options
6310
+ #
6311
+ # @yield [result, err] Result & error if block supplied
6312
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleApiHttpBody] parsed result object
6313
+ # @yieldparam err [StandardError] error object if request failed
6314
+ #
6315
+ # @return [Google::Apis::DiscoveryengineV1::GoogleApiHttpBody]
6316
+ #
6317
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6318
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6319
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
6320
+ def collect_project_location_user_event(parent, ets: nil, uri: nil, user_event: nil, fields: nil, quota_user: nil, options: nil, &block)
6321
+ command = make_simple_command(:get, 'v1/{+parent}/userEvents:collect', options)
6322
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleApiHttpBody::Representation
6323
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleApiHttpBody
6324
+ command.params['parent'] = parent unless parent.nil?
6325
+ command.query['ets'] = ets unless ets.nil?
6326
+ command.query['uri'] = uri unless uri.nil?
6327
+ command.query['userEvent'] = user_event unless user_event.nil?
6328
+ command.query['fields'] = fields unless fields.nil?
6329
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
6330
+ execute_or_queue_command(command, &block)
6331
+ end
6332
+
5658
6333
  # Writes a single user event.
5659
6334
  # @param [String] parent
5660
6335
  # Required. The parent resource name. If the write user event action is applied
@@ -5664,6 +6339,9 @@ module Google
5664
6339
  # across multiple DataStore, the format is: `projects/`project`/locations/`
5665
6340
  # location``.
5666
6341
  # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent] google_cloud_discoveryengine_v1_user_event_object
6342
+ # @param [Boolean] write_async
6343
+ # If set to true, the user event is written asynchronously after validation, and
6344
+ # the API responds without waiting for the write.
5667
6345
  # @param [String] fields
5668
6346
  # Selector specifying which fields to include in a partial response.
5669
6347
  # @param [String] quota_user
@@ -5681,13 +6359,14 @@ module Google
5681
6359
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5682
6360
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5683
6361
  # @raise [Google::Apis::AuthorizationError] Authorization is required
5684
- def write_project_location_user_event(parent, google_cloud_discoveryengine_v1_user_event_object = nil, fields: nil, quota_user: nil, options: nil, &block)
6362
+ def write_project_location_user_event(parent, google_cloud_discoveryengine_v1_user_event_object = nil, write_async: nil, fields: nil, quota_user: nil, options: nil, &block)
5685
6363
  command = make_simple_command(:post, 'v1/{+parent}/userEvents:write', options)
5686
6364
  command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent::Representation
5687
6365
  command.request_object = google_cloud_discoveryengine_v1_user_event_object
5688
6366
  command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent::Representation
5689
6367
  command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent
5690
6368
  command.params['parent'] = parent unless parent.nil?
6369
+ command.query['writeAsync'] = write_async unless write_async.nil?
5691
6370
  command.query['fields'] = fields unless fields.nil?
5692
6371
  command.query['quotaUser'] = quota_user unless quota_user.nil?
5693
6372
  execute_or_queue_command(command, &block)