google-apis-discoveryengine_v1alpha 0.51.0 → 0.52.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -0
- data/lib/google/apis/discoveryengine_v1alpha/classes.rb +2873 -174
- data/lib/google/apis/discoveryengine_v1alpha/gem_version.rb +2 -2
- data/lib/google/apis/discoveryengine_v1alpha/representations.rb +1189 -36
- data/lib/google/apis/discoveryengine_v1alpha/service.rb +733 -0
- metadata +3 -3
@@ -2774,6 +2774,38 @@ module Google
|
|
2774
2774
|
execute_or_queue_command(command, &block)
|
2775
2775
|
end
|
2776
2776
|
|
2777
|
+
# Gets the URI Pattern to Document data mapping for an Advanced Site Search
|
2778
|
+
# DataStore.
|
2779
|
+
# @param [String] site_search_engine
|
2780
|
+
# Required. Full resource name of the SiteSearchEngine, such as `projects/*/
|
2781
|
+
# locations/*/collections/*/dataStores/*/siteSearchEngine`.
|
2782
|
+
# @param [String] fields
|
2783
|
+
# Selector specifying which fields to include in a partial response.
|
2784
|
+
# @param [String] quota_user
|
2785
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2786
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2787
|
+
# @param [Google::Apis::RequestOptions] options
|
2788
|
+
# Request-specific options
|
2789
|
+
#
|
2790
|
+
# @yield [result, err] Result & error if block supplied
|
2791
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse] parsed result object
|
2792
|
+
# @yieldparam err [StandardError] error object if request failed
|
2793
|
+
#
|
2794
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse]
|
2795
|
+
#
|
2796
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2797
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2798
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2799
|
+
def get_project_location_collection_data_store_site_search_engine_uri_pattern_document_data(site_search_engine, fields: nil, quota_user: nil, options: nil, &block)
|
2800
|
+
command = make_simple_command(:get, 'v1alpha/{+siteSearchEngine}:getUriPatternDocumentData', options)
|
2801
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse::Representation
|
2802
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse
|
2803
|
+
command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
|
2804
|
+
command.query['fields'] = fields unless fields.nil?
|
2805
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2806
|
+
execute_or_queue_command(command, &block)
|
2807
|
+
end
|
2808
|
+
|
2777
2809
|
# Request on-demand recrawl for a list of URIs.
|
2778
2810
|
# @param [String] site_search_engine
|
2779
2811
|
# Required. Full resource name of the SiteSearchEngine, such as `projects/*/
|
@@ -2808,6 +2840,41 @@ module Google
|
|
2808
2840
|
execute_or_queue_command(command, &block)
|
2809
2841
|
end
|
2810
2842
|
|
2843
|
+
# Sets the URI Pattern to Document data mapping for an Advanced Site Search
|
2844
|
+
# DataStore.
|
2845
|
+
# @param [String] site_search_engine
|
2846
|
+
# Required. Full resource name of the SiteSearchEngine, such as `projects/*/
|
2847
|
+
# locations/*/collections/*/dataStores/*/siteSearchEngine`.
|
2848
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataRequest] google_cloud_discoveryengine_v1alpha_set_uri_pattern_document_data_request_object
|
2849
|
+
# @param [String] fields
|
2850
|
+
# Selector specifying which fields to include in a partial response.
|
2851
|
+
# @param [String] quota_user
|
2852
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2853
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2854
|
+
# @param [Google::Apis::RequestOptions] options
|
2855
|
+
# Request-specific options
|
2856
|
+
#
|
2857
|
+
# @yield [result, err] Result & error if block supplied
|
2858
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
2859
|
+
# @yieldparam err [StandardError] error object if request failed
|
2860
|
+
#
|
2861
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
2862
|
+
#
|
2863
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2864
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2865
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2866
|
+
def set_project_location_collection_data_store_site_search_engine_uri_pattern_document_data(site_search_engine, google_cloud_discoveryengine_v1alpha_set_uri_pattern_document_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2867
|
+
command = make_simple_command(:post, 'v1alpha/{+siteSearchEngine}:setUriPatternDocumentData', options)
|
2868
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataRequest::Representation
|
2869
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_set_uri_pattern_document_data_request_object
|
2870
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
2871
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
2872
|
+
command.params['siteSearchEngine'] = site_search_engine unless site_search_engine.nil?
|
2873
|
+
command.query['fields'] = fields unless fields.nil?
|
2874
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2875
|
+
execute_or_queue_command(command, &block)
|
2876
|
+
end
|
2877
|
+
|
2811
2878
|
# Gets the latest state of a long-running operation. Clients can use this method
|
2812
2879
|
# to poll the operation result at intervals as recommended by the API service.
|
2813
2880
|
# @param [String] name
|
@@ -7429,6 +7496,165 @@ module Google
|
|
7429
7496
|
execute_or_queue_command(command, &block)
|
7430
7497
|
end
|
7431
7498
|
|
7499
|
+
# Creates a Evaluation. Upon creation, the evaluation will be automatically
|
7500
|
+
# triggered and begin execution.
|
7501
|
+
# @param [String] parent
|
7502
|
+
# Required. The parent resource name, such as `projects/`project`/locations/`
|
7503
|
+
# location``.
|
7504
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEvaluation] google_cloud_discoveryengine_v1alpha_evaluation_object
|
7505
|
+
# @param [String] fields
|
7506
|
+
# Selector specifying which fields to include in a partial response.
|
7507
|
+
# @param [String] quota_user
|
7508
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
7509
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
7510
|
+
# @param [Google::Apis::RequestOptions] options
|
7511
|
+
# Request-specific options
|
7512
|
+
#
|
7513
|
+
# @yield [result, err] Result & error if block supplied
|
7514
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
7515
|
+
# @yieldparam err [StandardError] error object if request failed
|
7516
|
+
#
|
7517
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
7518
|
+
#
|
7519
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
7520
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
7521
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
7522
|
+
def create_project_location_evaluation(parent, google_cloud_discoveryengine_v1alpha_evaluation_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
7523
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/evaluations', options)
|
7524
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEvaluation::Representation
|
7525
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_evaluation_object
|
7526
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
7527
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
7528
|
+
command.params['parent'] = parent unless parent.nil?
|
7529
|
+
command.query['fields'] = fields unless fields.nil?
|
7530
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
7531
|
+
execute_or_queue_command(command, &block)
|
7532
|
+
end
|
7533
|
+
|
7534
|
+
# Gets a Evaluation.
|
7535
|
+
# @param [String] name
|
7536
|
+
# Required. Full resource name of Evaluation, such as `projects/`project`/
|
7537
|
+
# locations/`location`/evaluations/`evaluation``. If the caller does not have
|
7538
|
+
# permission to access the Evaluation, regardless of whether or not it exists, a
|
7539
|
+
# PERMISSION_DENIED error is returned. If the requested Evaluation does not
|
7540
|
+
# exist, a NOT_FOUND error is returned.
|
7541
|
+
# @param [String] fields
|
7542
|
+
# Selector specifying which fields to include in a partial response.
|
7543
|
+
# @param [String] quota_user
|
7544
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
7545
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
7546
|
+
# @param [Google::Apis::RequestOptions] options
|
7547
|
+
# Request-specific options
|
7548
|
+
#
|
7549
|
+
# @yield [result, err] Result & error if block supplied
|
7550
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEvaluation] parsed result object
|
7551
|
+
# @yieldparam err [StandardError] error object if request failed
|
7552
|
+
#
|
7553
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEvaluation]
|
7554
|
+
#
|
7555
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
7556
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
7557
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
7558
|
+
def get_project_location_evaluation(name, fields: nil, quota_user: nil, options: nil, &block)
|
7559
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
7560
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEvaluation::Representation
|
7561
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEvaluation
|
7562
|
+
command.params['name'] = name unless name.nil?
|
7563
|
+
command.query['fields'] = fields unless fields.nil?
|
7564
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
7565
|
+
execute_or_queue_command(command, &block)
|
7566
|
+
end
|
7567
|
+
|
7568
|
+
# Gets a list of Evaluations.
|
7569
|
+
# @param [String] parent
|
7570
|
+
# Required. The parent location resource name, such as `projects/`project`/
|
7571
|
+
# locations/`location``. If the caller does not have permission to list
|
7572
|
+
# Evaluations under this location, regardless of whether or not this location
|
7573
|
+
# exists, a `PERMISSION_DENIED` error is returned.
|
7574
|
+
# @param [Fixnum] page_size
|
7575
|
+
# Maximum number of Evaluations to return. If unspecified, defaults to 100. The
|
7576
|
+
# maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If
|
7577
|
+
# this field is negative, an `INVALID_ARGUMENT` error is returned.
|
7578
|
+
# @param [String] page_token
|
7579
|
+
# A page token ListEvaluationsResponse.next_page_token, received from a previous
|
7580
|
+
# EvaluationService.ListEvaluations call. Provide this to retrieve the
|
7581
|
+
# subsequent page. When paginating, all other parameters provided to
|
7582
|
+
# EvaluationService.ListEvaluations must match the call that provided the page
|
7583
|
+
# token. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
7584
|
+
# @param [String] fields
|
7585
|
+
# Selector specifying which fields to include in a partial response.
|
7586
|
+
# @param [String] quota_user
|
7587
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
7588
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
7589
|
+
# @param [Google::Apis::RequestOptions] options
|
7590
|
+
# Request-specific options
|
7591
|
+
#
|
7592
|
+
# @yield [result, err] Result & error if block supplied
|
7593
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListEvaluationsResponse] parsed result object
|
7594
|
+
# @yieldparam err [StandardError] error object if request failed
|
7595
|
+
#
|
7596
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListEvaluationsResponse]
|
7597
|
+
#
|
7598
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
7599
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
7600
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
7601
|
+
def list_project_location_evaluations(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
7602
|
+
command = make_simple_command(:get, 'v1alpha/{+parent}/evaluations', options)
|
7603
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListEvaluationsResponse::Representation
|
7604
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListEvaluationsResponse
|
7605
|
+
command.params['parent'] = parent unless parent.nil?
|
7606
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
7607
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
7608
|
+
command.query['fields'] = fields unless fields.nil?
|
7609
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
7610
|
+
execute_or_queue_command(command, &block)
|
7611
|
+
end
|
7612
|
+
|
7613
|
+
# Gets a list of results for a given a Evaluation.
|
7614
|
+
# @param [String] evaluation
|
7615
|
+
# Required. The evaluation resource name, such as `projects/`project`/locations/`
|
7616
|
+
# location`/evaluations/`evaluation``. If the caller does not have permission to
|
7617
|
+
# list EvaluationResult under this evaluation, regardless of whether or not this
|
7618
|
+
# evaluation set exists, a `PERMISSION_DENIED` error is returned.
|
7619
|
+
# @param [Fixnum] page_size
|
7620
|
+
# Maximum number of EvaluationResult to return. If unspecified, defaults to 100.
|
7621
|
+
# The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.
|
7622
|
+
# If this field is negative, an `INVALID_ARGUMENT` error is returned.
|
7623
|
+
# @param [String] page_token
|
7624
|
+
# A page token ListEvaluationResultsResponse.next_page_token, received from a
|
7625
|
+
# previous EvaluationService.ListEvaluationResults call. Provide this to
|
7626
|
+
# retrieve the subsequent page. When paginating, all other parameters provided
|
7627
|
+
# to EvaluationService.ListEvaluationResults must match the call that provided
|
7628
|
+
# the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
7629
|
+
# @param [String] fields
|
7630
|
+
# Selector specifying which fields to include in a partial response.
|
7631
|
+
# @param [String] quota_user
|
7632
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
7633
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
7634
|
+
# @param [Google::Apis::RequestOptions] options
|
7635
|
+
# Request-specific options
|
7636
|
+
#
|
7637
|
+
# @yield [result, err] Result & error if block supplied
|
7638
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponse] parsed result object
|
7639
|
+
# @yieldparam err [StandardError] error object if request failed
|
7640
|
+
#
|
7641
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponse]
|
7642
|
+
#
|
7643
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
7644
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
7645
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
7646
|
+
def list_project_location_evaluation_results(evaluation, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
7647
|
+
command = make_simple_command(:get, 'v1alpha/{+evaluation}:listResults', options)
|
7648
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponse::Representation
|
7649
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponse
|
7650
|
+
command.params['evaluation'] = evaluation unless evaluation.nil?
|
7651
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
7652
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
7653
|
+
command.query['fields'] = fields unless fields.nil?
|
7654
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
7655
|
+
execute_or_queue_command(command, &block)
|
7656
|
+
end
|
7657
|
+
|
7432
7658
|
# Gets the latest state of a long-running operation. Clients can use this method
|
7433
7659
|
# to poll the operation result at intervals as recommended by the API service.
|
7434
7660
|
# @param [String] name
|
@@ -7494,6 +7720,77 @@ module Google
|
|
7494
7720
|
execute_or_queue_command(command, &block)
|
7495
7721
|
end
|
7496
7722
|
|
7723
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
7724
|
+
# to poll the operation result at intervals as recommended by the API service.
|
7725
|
+
# @param [String] name
|
7726
|
+
# The name of the operation resource.
|
7727
|
+
# @param [String] fields
|
7728
|
+
# Selector specifying which fields to include in a partial response.
|
7729
|
+
# @param [String] quota_user
|
7730
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
7731
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
7732
|
+
# @param [Google::Apis::RequestOptions] options
|
7733
|
+
# Request-specific options
|
7734
|
+
#
|
7735
|
+
# @yield [result, err] Result & error if block supplied
|
7736
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
7737
|
+
# @yieldparam err [StandardError] error object if request failed
|
7738
|
+
#
|
7739
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
7740
|
+
#
|
7741
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
7742
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
7743
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
7744
|
+
def get_project_location_identity_mapping_store_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
7745
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
7746
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
7747
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
7748
|
+
command.params['name'] = name unless name.nil?
|
7749
|
+
command.query['fields'] = fields unless fields.nil?
|
7750
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
7751
|
+
execute_or_queue_command(command, &block)
|
7752
|
+
end
|
7753
|
+
|
7754
|
+
# Lists operations that match the specified filter in the request. If the server
|
7755
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`.
|
7756
|
+
# @param [String] name
|
7757
|
+
# The name of the operation's parent resource.
|
7758
|
+
# @param [String] filter
|
7759
|
+
# The standard list filter.
|
7760
|
+
# @param [Fixnum] page_size
|
7761
|
+
# The standard list page size.
|
7762
|
+
# @param [String] page_token
|
7763
|
+
# The standard list page token.
|
7764
|
+
# @param [String] fields
|
7765
|
+
# Selector specifying which fields to include in a partial response.
|
7766
|
+
# @param [String] quota_user
|
7767
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
7768
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
7769
|
+
# @param [Google::Apis::RequestOptions] options
|
7770
|
+
# Request-specific options
|
7771
|
+
#
|
7772
|
+
# @yield [result, err] Result & error if block supplied
|
7773
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse] parsed result object
|
7774
|
+
# @yieldparam err [StandardError] error object if request failed
|
7775
|
+
#
|
7776
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse]
|
7777
|
+
#
|
7778
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
7779
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
7780
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
7781
|
+
def list_project_location_identity_mapping_store_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
7782
|
+
command = make_simple_command(:get, 'v1alpha/{+name}/operations', options)
|
7783
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse::Representation
|
7784
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse
|
7785
|
+
command.params['name'] = name unless name.nil?
|
7786
|
+
command.query['filter'] = filter unless filter.nil?
|
7787
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
7788
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
7789
|
+
command.query['fields'] = fields unless fields.nil?
|
7790
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
7791
|
+
execute_or_queue_command(command, &block)
|
7792
|
+
end
|
7793
|
+
|
7497
7794
|
# Gets the latest state of a long-running operation. Clients can use this method
|
7498
7795
|
# to poll the operation result at intervals as recommended by the API service.
|
7499
7796
|
# @param [String] name
|
@@ -7633,6 +7930,203 @@ module Google
|
|
7633
7930
|
execute_or_queue_command(command, &block)
|
7634
7931
|
end
|
7635
7932
|
|
7933
|
+
# Creates a SampleQuerySet
|
7934
|
+
# @param [String] parent
|
7935
|
+
# Required. The parent resource name, such as `projects/`project`/locations/`
|
7936
|
+
# location``.
|
7937
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSampleQuerySet] google_cloud_discoveryengine_v1alpha_sample_query_set_object
|
7938
|
+
# @param [String] sample_query_set_id
|
7939
|
+
# Required. The ID to use for the SampleQuerySet, which will become the final
|
7940
|
+
# component of the SampleQuerySet.name. If the caller does not have permission
|
7941
|
+
# to create the SampleQuerySet, regardless of whether or not it exists, a `
|
7942
|
+
# PERMISSION_DENIED` error is returned. This field must be unique among all
|
7943
|
+
# SampleQuerySets with the same parent. Otherwise, an `ALREADY_EXISTS` error is
|
7944
|
+
# returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/
|
7945
|
+
# rfc1034) standard with a length limit of 63 characters. Otherwise, an `
|
7946
|
+
# INVALID_ARGUMENT` error is returned.
|
7947
|
+
# @param [String] fields
|
7948
|
+
# Selector specifying which fields to include in a partial response.
|
7949
|
+
# @param [String] quota_user
|
7950
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
7951
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
7952
|
+
# @param [Google::Apis::RequestOptions] options
|
7953
|
+
# Request-specific options
|
7954
|
+
#
|
7955
|
+
# @yield [result, err] Result & error if block supplied
|
7956
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSampleQuerySet] parsed result object
|
7957
|
+
# @yieldparam err [StandardError] error object if request failed
|
7958
|
+
#
|
7959
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSampleQuerySet]
|
7960
|
+
#
|
7961
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
7962
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
7963
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
7964
|
+
def create_project_location_sample_query_set(parent, google_cloud_discoveryengine_v1alpha_sample_query_set_object = nil, sample_query_set_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
7965
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/sampleQuerySets', options)
|
7966
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSampleQuerySet::Representation
|
7967
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_sample_query_set_object
|
7968
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSampleQuerySet::Representation
|
7969
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSampleQuerySet
|
7970
|
+
command.params['parent'] = parent unless parent.nil?
|
7971
|
+
command.query['sampleQuerySetId'] = sample_query_set_id unless sample_query_set_id.nil?
|
7972
|
+
command.query['fields'] = fields unless fields.nil?
|
7973
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
7974
|
+
execute_or_queue_command(command, &block)
|
7975
|
+
end
|
7976
|
+
|
7977
|
+
# Deletes a SampleQuerySet.
|
7978
|
+
# @param [String] name
|
7979
|
+
# Required. Full resource name of SampleQuerySet, such as `projects/`project`/
|
7980
|
+
# locations/`location`/sampleQuerySets/`sampleQuerySet``. If the caller does not
|
7981
|
+
# have permission to delete the SampleQuerySet, regardless of whether or not it
|
7982
|
+
# exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to
|
7983
|
+
# delete does not exist, a `NOT_FOUND` error is returned.
|
7984
|
+
# @param [String] fields
|
7985
|
+
# Selector specifying which fields to include in a partial response.
|
7986
|
+
# @param [String] quota_user
|
7987
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
7988
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
7989
|
+
# @param [Google::Apis::RequestOptions] options
|
7990
|
+
# Request-specific options
|
7991
|
+
#
|
7992
|
+
# @yield [result, err] Result & error if block supplied
|
7993
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty] parsed result object
|
7994
|
+
# @yieldparam err [StandardError] error object if request failed
|
7995
|
+
#
|
7996
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty]
|
7997
|
+
#
|
7998
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
7999
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
8000
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
8001
|
+
def delete_project_location_sample_query_set(name, fields: nil, quota_user: nil, options: nil, &block)
|
8002
|
+
command = make_simple_command(:delete, 'v1alpha/{+name}', options)
|
8003
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty::Representation
|
8004
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty
|
8005
|
+
command.params['name'] = name unless name.nil?
|
8006
|
+
command.query['fields'] = fields unless fields.nil?
|
8007
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
8008
|
+
execute_or_queue_command(command, &block)
|
8009
|
+
end
|
8010
|
+
|
8011
|
+
# Gets a SampleQuerySet.
|
8012
|
+
# @param [String] name
|
8013
|
+
# Required. Full resource name of SampleQuerySet, such as `projects/`project`/
|
8014
|
+
# locations/`location`/sampleQuerySets/`sampleQuerySet``. If the caller does not
|
8015
|
+
# have permission to access the SampleQuerySet, regardless of whether or not it
|
8016
|
+
# exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet
|
8017
|
+
# does not exist, a NOT_FOUND error is returned.
|
8018
|
+
# @param [String] fields
|
8019
|
+
# Selector specifying which fields to include in a partial response.
|
8020
|
+
# @param [String] quota_user
|
8021
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
8022
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
8023
|
+
# @param [Google::Apis::RequestOptions] options
|
8024
|
+
# Request-specific options
|
8025
|
+
#
|
8026
|
+
# @yield [result, err] Result & error if block supplied
|
8027
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSampleQuerySet] parsed result object
|
8028
|
+
# @yieldparam err [StandardError] error object if request failed
|
8029
|
+
#
|
8030
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSampleQuerySet]
|
8031
|
+
#
|
8032
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
8033
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
8034
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
8035
|
+
def get_project_location_sample_query_set(name, fields: nil, quota_user: nil, options: nil, &block)
|
8036
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
8037
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSampleQuerySet::Representation
|
8038
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSampleQuerySet
|
8039
|
+
command.params['name'] = name unless name.nil?
|
8040
|
+
command.query['fields'] = fields unless fields.nil?
|
8041
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
8042
|
+
execute_or_queue_command(command, &block)
|
8043
|
+
end
|
8044
|
+
|
8045
|
+
# Gets a list of SampleQuerySets.
|
8046
|
+
# @param [String] parent
|
8047
|
+
# Required. The parent location resource name, such as `projects/`project`/
|
8048
|
+
# locations/`location``. If the caller does not have permission to list
|
8049
|
+
# SampleQuerySets under this location, regardless of whether or not this
|
8050
|
+
# location exists, a `PERMISSION_DENIED` error is returned.
|
8051
|
+
# @param [Fixnum] page_size
|
8052
|
+
# Maximum number of SampleQuerySets to return. If unspecified, defaults to 100.
|
8053
|
+
# The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.
|
8054
|
+
# If this field is negative, an `INVALID_ARGUMENT` error is returned.
|
8055
|
+
# @param [String] page_token
|
8056
|
+
# A page token ListSampleQuerySetsResponse.next_page_token, received from a
|
8057
|
+
# previous SampleQuerySetService.ListSampleQuerySets call. Provide this to
|
8058
|
+
# retrieve the subsequent page. When paginating, all other parameters provided
|
8059
|
+
# to SampleQuerySetService.ListSampleQuerySets must match the call that provided
|
8060
|
+
# the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
8061
|
+
# @param [String] fields
|
8062
|
+
# Selector specifying which fields to include in a partial response.
|
8063
|
+
# @param [String] quota_user
|
8064
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
8065
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
8066
|
+
# @param [Google::Apis::RequestOptions] options
|
8067
|
+
# Request-specific options
|
8068
|
+
#
|
8069
|
+
# @yield [result, err] Result & error if block supplied
|
8070
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSampleQuerySetsResponse] parsed result object
|
8071
|
+
# @yieldparam err [StandardError] error object if request failed
|
8072
|
+
#
|
8073
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSampleQuerySetsResponse]
|
8074
|
+
#
|
8075
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
8076
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
8077
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
8078
|
+
def list_project_location_sample_query_sets(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
8079
|
+
command = make_simple_command(:get, 'v1alpha/{+parent}/sampleQuerySets', options)
|
8080
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSampleQuerySetsResponse::Representation
|
8081
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSampleQuerySetsResponse
|
8082
|
+
command.params['parent'] = parent unless parent.nil?
|
8083
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
8084
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
8085
|
+
command.query['fields'] = fields unless fields.nil?
|
8086
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
8087
|
+
execute_or_queue_command(command, &block)
|
8088
|
+
end
|
8089
|
+
|
8090
|
+
# Updates a SampleQuerySet.
|
8091
|
+
# @param [String] name
|
8092
|
+
# Immutable. The full resource name of the SampleQuerySet, in the format of `
|
8093
|
+
# projects/`project`/locations/`location`/sampleQuerySets/`sampleQuerySet``.
|
8094
|
+
# This field must be a UTF-8 encoded string with a length limit of 1024
|
8095
|
+
# characters.
|
8096
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSampleQuerySet] google_cloud_discoveryengine_v1alpha_sample_query_set_object
|
8097
|
+
# @param [String] update_mask
|
8098
|
+
# Indicates which fields in the provided imported 'sample query set' to update.
|
8099
|
+
# If not set, will by default update all fields.
|
8100
|
+
# @param [String] fields
|
8101
|
+
# Selector specifying which fields to include in a partial response.
|
8102
|
+
# @param [String] quota_user
|
8103
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
8104
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
8105
|
+
# @param [Google::Apis::RequestOptions] options
|
8106
|
+
# Request-specific options
|
8107
|
+
#
|
8108
|
+
# @yield [result, err] Result & error if block supplied
|
8109
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSampleQuerySet] parsed result object
|
8110
|
+
# @yieldparam err [StandardError] error object if request failed
|
8111
|
+
#
|
8112
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSampleQuerySet]
|
8113
|
+
#
|
8114
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
8115
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
8116
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
8117
|
+
def patch_project_location_sample_query_set(name, google_cloud_discoveryengine_v1alpha_sample_query_set_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
8118
|
+
command = make_simple_command(:patch, 'v1alpha/{+name}', options)
|
8119
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSampleQuerySet::Representation
|
8120
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_sample_query_set_object
|
8121
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSampleQuerySet::Representation
|
8122
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSampleQuerySet
|
8123
|
+
command.params['name'] = name unless name.nil?
|
8124
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
8125
|
+
command.query['fields'] = fields unless fields.nil?
|
8126
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
8127
|
+
execute_or_queue_command(command, &block)
|
8128
|
+
end
|
8129
|
+
|
7636
8130
|
# Gets the latest state of a long-running operation. Clients can use this method
|
7637
8131
|
# to poll the operation result at intervals as recommended by the API service.
|
7638
8132
|
# @param [String] name
|
@@ -7664,6 +8158,245 @@ module Google
|
|
7664
8158
|
execute_or_queue_command(command, &block)
|
7665
8159
|
end
|
7666
8160
|
|
8161
|
+
# Creates a SampleQuery
|
8162
|
+
# @param [String] parent
|
8163
|
+
# Required. The parent resource name, such as `projects/`project`/locations/`
|
8164
|
+
# location`/sampleQuerySets/`sampleQuerySet``.
|
8165
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSampleQuery] google_cloud_discoveryengine_v1alpha_sample_query_object
|
8166
|
+
# @param [String] sample_query_id
|
8167
|
+
# Required. The ID to use for the SampleQuery, which will become the final
|
8168
|
+
# component of the SampleQuery.name. If the caller does not have permission to
|
8169
|
+
# create the SampleQuery, regardless of whether or not it exists, a `
|
8170
|
+
# PERMISSION_DENIED` error is returned. This field must be unique among all
|
8171
|
+
# SampleQuerys with the same parent. Otherwise, an `ALREADY_EXISTS` error is
|
8172
|
+
# returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/
|
8173
|
+
# rfc1034) standard with a length limit of 63 characters. Otherwise, an `
|
8174
|
+
# INVALID_ARGUMENT` error is returned.
|
8175
|
+
# @param [String] fields
|
8176
|
+
# Selector specifying which fields to include in a partial response.
|
8177
|
+
# @param [String] quota_user
|
8178
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
8179
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
8180
|
+
# @param [Google::Apis::RequestOptions] options
|
8181
|
+
# Request-specific options
|
8182
|
+
#
|
8183
|
+
# @yield [result, err] Result & error if block supplied
|
8184
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSampleQuery] parsed result object
|
8185
|
+
# @yieldparam err [StandardError] error object if request failed
|
8186
|
+
#
|
8187
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSampleQuery]
|
8188
|
+
#
|
8189
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
8190
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
8191
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
8192
|
+
def create_project_location_sample_query_set_sample_query(parent, google_cloud_discoveryengine_v1alpha_sample_query_object = nil, sample_query_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
8193
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/sampleQueries', options)
|
8194
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSampleQuery::Representation
|
8195
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_sample_query_object
|
8196
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSampleQuery::Representation
|
8197
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSampleQuery
|
8198
|
+
command.params['parent'] = parent unless parent.nil?
|
8199
|
+
command.query['sampleQueryId'] = sample_query_id unless sample_query_id.nil?
|
8200
|
+
command.query['fields'] = fields unless fields.nil?
|
8201
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
8202
|
+
execute_or_queue_command(command, &block)
|
8203
|
+
end
|
8204
|
+
|
8205
|
+
# Deletes a SampleQuery.
|
8206
|
+
# @param [String] name
|
8207
|
+
# Required. Full resource name of SampleQuery, such as `projects/`project`/
|
8208
|
+
# locations/`location`/sampleQuerySets/`sampleQuerySet`/sampleQueries/`
|
8209
|
+
# sampleQuery``. If the caller does not have permission to delete the
|
8210
|
+
# SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED`
|
8211
|
+
# error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND`
|
8212
|
+
# error is returned.
|
8213
|
+
# @param [String] fields
|
8214
|
+
# Selector specifying which fields to include in a partial response.
|
8215
|
+
# @param [String] quota_user
|
8216
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
8217
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
8218
|
+
# @param [Google::Apis::RequestOptions] options
|
8219
|
+
# Request-specific options
|
8220
|
+
#
|
8221
|
+
# @yield [result, err] Result & error if block supplied
|
8222
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty] parsed result object
|
8223
|
+
# @yieldparam err [StandardError] error object if request failed
|
8224
|
+
#
|
8225
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty]
|
8226
|
+
#
|
8227
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
8228
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
8229
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
8230
|
+
def delete_project_location_sample_query_set_sample_query(name, fields: nil, quota_user: nil, options: nil, &block)
|
8231
|
+
command = make_simple_command(:delete, 'v1alpha/{+name}', options)
|
8232
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty::Representation
|
8233
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleProtobufEmpty
|
8234
|
+
command.params['name'] = name unless name.nil?
|
8235
|
+
command.query['fields'] = fields unless fields.nil?
|
8236
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
8237
|
+
execute_or_queue_command(command, &block)
|
8238
|
+
end
|
8239
|
+
|
8240
|
+
# Gets a SampleQuery.
|
8241
|
+
# @param [String] name
|
8242
|
+
# Required. Full resource name of SampleQuery, such as `projects/`project`/
|
8243
|
+
# locations/`location`/sampleQuerySets/`sampleQuerySet`/sampleQueries/`
|
8244
|
+
# sampleQuery``. If the caller does not have permission to access the
|
8245
|
+
# SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error
|
8246
|
+
# is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is
|
8247
|
+
# returned.
|
8248
|
+
# @param [String] fields
|
8249
|
+
# Selector specifying which fields to include in a partial response.
|
8250
|
+
# @param [String] quota_user
|
8251
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
8252
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
8253
|
+
# @param [Google::Apis::RequestOptions] options
|
8254
|
+
# Request-specific options
|
8255
|
+
#
|
8256
|
+
# @yield [result, err] Result & error if block supplied
|
8257
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSampleQuery] parsed result object
|
8258
|
+
# @yieldparam err [StandardError] error object if request failed
|
8259
|
+
#
|
8260
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSampleQuery]
|
8261
|
+
#
|
8262
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
8263
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
8264
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
8265
|
+
def get_project_location_sample_query_set_sample_query(name, fields: nil, quota_user: nil, options: nil, &block)
|
8266
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
8267
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSampleQuery::Representation
|
8268
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSampleQuery
|
8269
|
+
command.params['name'] = name unless name.nil?
|
8270
|
+
command.query['fields'] = fields unless fields.nil?
|
8271
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
8272
|
+
execute_or_queue_command(command, &block)
|
8273
|
+
end
|
8274
|
+
|
8275
|
+
# Bulk import of multiple SampleQuerys. Sample queries that already exist may be
|
8276
|
+
# deleted. Note: It is possible for a subset of the SampleQuerys to be
|
8277
|
+
# successfully imported.
|
8278
|
+
# @param [String] parent
|
8279
|
+
# Required. The parent sample query set resource name, such as `projects/`
|
8280
|
+
# project`/locations/`location`/sampleQuerySets/`sampleQuerySet``. If the caller
|
8281
|
+
# does not have permission to list SampleQuerys under this sample query set,
|
8282
|
+
# regardless of whether or not this sample query set exists, a `
|
8283
|
+
# PERMISSION_DENIED` error is returned.
|
8284
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequest] google_cloud_discoveryengine_v1alpha_import_sample_queries_request_object
|
8285
|
+
# @param [String] fields
|
8286
|
+
# Selector specifying which fields to include in a partial response.
|
8287
|
+
# @param [String] quota_user
|
8288
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
8289
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
8290
|
+
# @param [Google::Apis::RequestOptions] options
|
8291
|
+
# Request-specific options
|
8292
|
+
#
|
8293
|
+
# @yield [result, err] Result & error if block supplied
|
8294
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
8295
|
+
# @yieldparam err [StandardError] error object if request failed
|
8296
|
+
#
|
8297
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
8298
|
+
#
|
8299
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
8300
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
8301
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
8302
|
+
def import_project_location_sample_query_set_sample_query(parent, google_cloud_discoveryengine_v1alpha_import_sample_queries_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
8303
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/sampleQueries:import', options)
|
8304
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequest::Representation
|
8305
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_import_sample_queries_request_object
|
8306
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
8307
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
8308
|
+
command.params['parent'] = parent unless parent.nil?
|
8309
|
+
command.query['fields'] = fields unless fields.nil?
|
8310
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
8311
|
+
execute_or_queue_command(command, &block)
|
8312
|
+
end
|
8313
|
+
|
8314
|
+
# Gets a list of SampleQuerys.
|
8315
|
+
# @param [String] parent
|
8316
|
+
# Required. The parent sample query set resource name, such as `projects/`
|
8317
|
+
# project`/locations/`location`/sampleQuerySets/`sampleQuerySet``. If the caller
|
8318
|
+
# does not have permission to list SampleQuerys under this sample query set,
|
8319
|
+
# regardless of whether or not this sample query set exists, a `
|
8320
|
+
# PERMISSION_DENIED` error is returned.
|
8321
|
+
# @param [Fixnum] page_size
|
8322
|
+
# Maximum number of SampleQuerys to return. If unspecified, defaults to 100. The
|
8323
|
+
# maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If
|
8324
|
+
# this field is negative, an `INVALID_ARGUMENT` error is returned.
|
8325
|
+
# @param [String] page_token
|
8326
|
+
# A page token ListSampleQueriesResponse.next_page_token, received from a
|
8327
|
+
# previous SampleQueryService.ListSampleQueries call. Provide this to retrieve
|
8328
|
+
# the subsequent page. When paginating, all other parameters provided to
|
8329
|
+
# SampleQueryService.ListSampleQueries must match the call that provided the
|
8330
|
+
# page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
8331
|
+
# @param [String] fields
|
8332
|
+
# Selector specifying which fields to include in a partial response.
|
8333
|
+
# @param [String] quota_user
|
8334
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
8335
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
8336
|
+
# @param [Google::Apis::RequestOptions] options
|
8337
|
+
# Request-specific options
|
8338
|
+
#
|
8339
|
+
# @yield [result, err] Result & error if block supplied
|
8340
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSampleQueriesResponse] parsed result object
|
8341
|
+
# @yieldparam err [StandardError] error object if request failed
|
8342
|
+
#
|
8343
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSampleQueriesResponse]
|
8344
|
+
#
|
8345
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
8346
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
8347
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
8348
|
+
def list_project_location_sample_query_set_sample_queries(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
8349
|
+
command = make_simple_command(:get, 'v1alpha/{+parent}/sampleQueries', options)
|
8350
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSampleQueriesResponse::Representation
|
8351
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSampleQueriesResponse
|
8352
|
+
command.params['parent'] = parent unless parent.nil?
|
8353
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
8354
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
8355
|
+
command.query['fields'] = fields unless fields.nil?
|
8356
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
8357
|
+
execute_or_queue_command(command, &block)
|
8358
|
+
end
|
8359
|
+
|
8360
|
+
# Updates a SampleQuery.
|
8361
|
+
# @param [String] name
|
8362
|
+
# Immutable. The full resource name of the sample query, in the format of `
|
8363
|
+
# projects/`project`/locations/`location`/sampleQuerySets/`sampleQuerySet`/
|
8364
|
+
# sampleQueries/`sampleQuery``. This field must be a UTF-8 encoded string with a
|
8365
|
+
# length limit of 1024 characters.
|
8366
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSampleQuery] google_cloud_discoveryengine_v1alpha_sample_query_object
|
8367
|
+
# @param [String] update_mask
|
8368
|
+
# Indicates which fields in the provided imported 'simple query' to update. If
|
8369
|
+
# not set, will by default update all fields.
|
8370
|
+
# @param [String] fields
|
8371
|
+
# Selector specifying which fields to include in a partial response.
|
8372
|
+
# @param [String] quota_user
|
8373
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
8374
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
8375
|
+
# @param [Google::Apis::RequestOptions] options
|
8376
|
+
# Request-specific options
|
8377
|
+
#
|
8378
|
+
# @yield [result, err] Result & error if block supplied
|
8379
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSampleQuery] parsed result object
|
8380
|
+
# @yieldparam err [StandardError] error object if request failed
|
8381
|
+
#
|
8382
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSampleQuery]
|
8383
|
+
#
|
8384
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
8385
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
8386
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
8387
|
+
def patch_project_location_sample_query_set_sample_query(name, google_cloud_discoveryengine_v1alpha_sample_query_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
8388
|
+
command = make_simple_command(:patch, 'v1alpha/{+name}', options)
|
8389
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSampleQuery::Representation
|
8390
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_sample_query_object
|
8391
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSampleQuery::Representation
|
8392
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSampleQuery
|
8393
|
+
command.params['name'] = name unless name.nil?
|
8394
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
8395
|
+
command.query['fields'] = fields unless fields.nil?
|
8396
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
8397
|
+
execute_or_queue_command(command, &block)
|
8398
|
+
end
|
8399
|
+
|
7667
8400
|
# Writes a single user event from the browser. This uses a GET request to due to
|
7668
8401
|
# browser restriction of POST-ing to a third-party domain. This method is used
|
7669
8402
|
# only by the Discovery Engine API JavaScript pixel and Google Tag Manager.
|