google-apis-discoveryengine_v1beta 0.49.0 → 0.50.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.
@@ -6793,6 +6793,196 @@ module Google
6793
6793
  execute_or_queue_command(command, &block)
6794
6794
  end
6795
6795
 
6796
+ # Creates a Evaluation. Upon creation, the evaluation will be automatically
6797
+ # triggered and begin execution.
6798
+ # @param [String] parent
6799
+ # Required. The parent resource name, such as `projects/`project`/locations/`
6800
+ # location``.
6801
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEvaluation] google_cloud_discoveryengine_v1beta_evaluation_object
6802
+ # @param [String] fields
6803
+ # Selector specifying which fields to include in a partial response.
6804
+ # @param [String] quota_user
6805
+ # Available to use for quota purposes for server-side applications. Can be any
6806
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
6807
+ # @param [Google::Apis::RequestOptions] options
6808
+ # Request-specific options
6809
+ #
6810
+ # @yield [result, err] Result & error if block supplied
6811
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
6812
+ # @yieldparam err [StandardError] error object if request failed
6813
+ #
6814
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
6815
+ #
6816
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6817
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6818
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
6819
+ def create_project_location_evaluation(parent, google_cloud_discoveryengine_v1beta_evaluation_object = nil, fields: nil, quota_user: nil, options: nil, &block)
6820
+ command = make_simple_command(:post, 'v1beta/{+parent}/evaluations', options)
6821
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEvaluation::Representation
6822
+ command.request_object = google_cloud_discoveryengine_v1beta_evaluation_object
6823
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
6824
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
6825
+ command.params['parent'] = parent unless parent.nil?
6826
+ command.query['fields'] = fields unless fields.nil?
6827
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
6828
+ execute_or_queue_command(command, &block)
6829
+ end
6830
+
6831
+ # Gets a Evaluation.
6832
+ # @param [String] name
6833
+ # Required. Full resource name of Evaluation, such as `projects/`project`/
6834
+ # locations/`location`/evaluations/`evaluation``. If the caller does not have
6835
+ # permission to access the Evaluation, regardless of whether or not it exists, a
6836
+ # PERMISSION_DENIED error is returned. If the requested Evaluation does not
6837
+ # exist, a NOT_FOUND error is returned.
6838
+ # @param [String] fields
6839
+ # Selector specifying which fields to include in a partial response.
6840
+ # @param [String] quota_user
6841
+ # Available to use for quota purposes for server-side applications. Can be any
6842
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
6843
+ # @param [Google::Apis::RequestOptions] options
6844
+ # Request-specific options
6845
+ #
6846
+ # @yield [result, err] Result & error if block supplied
6847
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEvaluation] parsed result object
6848
+ # @yieldparam err [StandardError] error object if request failed
6849
+ #
6850
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEvaluation]
6851
+ #
6852
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6853
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6854
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
6855
+ def get_project_location_evaluation(name, fields: nil, quota_user: nil, options: nil, &block)
6856
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
6857
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEvaluation::Representation
6858
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEvaluation
6859
+ command.params['name'] = name unless name.nil?
6860
+ command.query['fields'] = fields unless fields.nil?
6861
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
6862
+ execute_or_queue_command(command, &block)
6863
+ end
6864
+
6865
+ # Gets a list of Evaluations.
6866
+ # @param [String] parent
6867
+ # Required. The parent location resource name, such as `projects/`project`/
6868
+ # locations/`location``. If the caller does not have permission to list
6869
+ # Evaluations under this location, regardless of whether or not this location
6870
+ # exists, a `PERMISSION_DENIED` error is returned.
6871
+ # @param [Fixnum] page_size
6872
+ # Maximum number of Evaluations to return. If unspecified, defaults to 100. The
6873
+ # maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If
6874
+ # this field is negative, an `INVALID_ARGUMENT` error is returned.
6875
+ # @param [String] page_token
6876
+ # A page token ListEvaluationsResponse.next_page_token, received from a previous
6877
+ # EvaluationService.ListEvaluations call. Provide this to retrieve the
6878
+ # subsequent page. When paginating, all other parameters provided to
6879
+ # EvaluationService.ListEvaluations must match the call that provided the page
6880
+ # token. Otherwise, an `INVALID_ARGUMENT` error is returned.
6881
+ # @param [String] fields
6882
+ # Selector specifying which fields to include in a partial response.
6883
+ # @param [String] quota_user
6884
+ # Available to use for quota purposes for server-side applications. Can be any
6885
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
6886
+ # @param [Google::Apis::RequestOptions] options
6887
+ # Request-specific options
6888
+ #
6889
+ # @yield [result, err] Result & error if block supplied
6890
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListEvaluationsResponse] parsed result object
6891
+ # @yieldparam err [StandardError] error object if request failed
6892
+ #
6893
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListEvaluationsResponse]
6894
+ #
6895
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6896
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6897
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
6898
+ def list_project_location_evaluations(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
6899
+ command = make_simple_command(:get, 'v1beta/{+parent}/evaluations', options)
6900
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListEvaluationsResponse::Representation
6901
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListEvaluationsResponse
6902
+ command.params['parent'] = parent unless parent.nil?
6903
+ command.query['pageSize'] = page_size unless page_size.nil?
6904
+ command.query['pageToken'] = page_token unless page_token.nil?
6905
+ command.query['fields'] = fields unless fields.nil?
6906
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
6907
+ execute_or_queue_command(command, &block)
6908
+ end
6909
+
6910
+ # Gets a list of results for a given a Evaluation.
6911
+ # @param [String] evaluation
6912
+ # Required. The evaluation resource name, such as `projects/`project`/locations/`
6913
+ # location`/evaluations/`evaluation``. If the caller does not have permission to
6914
+ # list EvaluationResult under this evaluation, regardless of whether or not this
6915
+ # evaluation set exists, a `PERMISSION_DENIED` error is returned.
6916
+ # @param [Fixnum] page_size
6917
+ # Maximum number of EvaluationResult to return. If unspecified, defaults to 100.
6918
+ # The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.
6919
+ # If this field is negative, an `INVALID_ARGUMENT` error is returned.
6920
+ # @param [String] page_token
6921
+ # A page token ListEvaluationResultsResponse.next_page_token, received from a
6922
+ # previous EvaluationService.ListEvaluationResults call. Provide this to
6923
+ # retrieve the subsequent page. When paginating, all other parameters provided
6924
+ # to EvaluationService.ListEvaluationResults must match the call that provided
6925
+ # the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
6926
+ # @param [String] fields
6927
+ # Selector specifying which fields to include in a partial response.
6928
+ # @param [String] quota_user
6929
+ # Available to use for quota purposes for server-side applications. Can be any
6930
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
6931
+ # @param [Google::Apis::RequestOptions] options
6932
+ # Request-specific options
6933
+ #
6934
+ # @yield [result, err] Result & error if block supplied
6935
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponse] parsed result object
6936
+ # @yieldparam err [StandardError] error object if request failed
6937
+ #
6938
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponse]
6939
+ #
6940
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6941
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6942
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
6943
+ def list_project_location_evaluation_results(evaluation, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
6944
+ command = make_simple_command(:get, 'v1beta/{+evaluation}:listResults', options)
6945
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponse::Representation
6946
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponse
6947
+ command.params['evaluation'] = evaluation unless evaluation.nil?
6948
+ command.query['pageSize'] = page_size unless page_size.nil?
6949
+ command.query['pageToken'] = page_token unless page_token.nil?
6950
+ command.query['fields'] = fields unless fields.nil?
6951
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
6952
+ execute_or_queue_command(command, &block)
6953
+ end
6954
+
6955
+ # Gets the latest state of a long-running operation. Clients can use this method
6956
+ # to poll the operation result at intervals as recommended by the API service.
6957
+ # @param [String] name
6958
+ # The name of the operation resource.
6959
+ # @param [String] fields
6960
+ # Selector specifying which fields to include in a partial response.
6961
+ # @param [String] quota_user
6962
+ # Available to use for quota purposes for server-side applications. Can be any
6963
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
6964
+ # @param [Google::Apis::RequestOptions] options
6965
+ # Request-specific options
6966
+ #
6967
+ # @yield [result, err] Result & error if block supplied
6968
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
6969
+ # @yieldparam err [StandardError] error object if request failed
6970
+ #
6971
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
6972
+ #
6973
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6974
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6975
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
6976
+ def get_project_location_evaluation_operation(name, fields: nil, quota_user: nil, options: nil, &block)
6977
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
6978
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
6979
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
6980
+ command.params['name'] = name unless name.nil?
6981
+ command.query['fields'] = fields unless fields.nil?
6982
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
6983
+ execute_or_queue_command(command, &block)
6984
+ end
6985
+
6796
6986
  # Performs a grounding check.
6797
6987
  # @param [String] grounding_config
6798
6988
  # Required. The resource name of the grounding config, such as `projects/*/
@@ -6932,6 +7122,473 @@ module Google
6932
7122
  execute_or_queue_command(command, &block)
6933
7123
  end
6934
7124
 
7125
+ # Creates a SampleQuerySet
7126
+ # @param [String] parent
7127
+ # Required. The parent resource name, such as `projects/`project`/locations/`
7128
+ # location``.
7129
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuerySet] google_cloud_discoveryengine_v1beta_sample_query_set_object
7130
+ # @param [String] sample_query_set_id
7131
+ # Required. The ID to use for the SampleQuerySet, which will become the final
7132
+ # component of the SampleQuerySet.name. If the caller does not have permission
7133
+ # to create the SampleQuerySet, regardless of whether or not it exists, a `
7134
+ # PERMISSION_DENIED` error is returned. This field must be unique among all
7135
+ # SampleQuerySets with the same parent. Otherwise, an `ALREADY_EXISTS` error is
7136
+ # returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/
7137
+ # rfc1034) standard with a length limit of 63 characters. Otherwise, an `
7138
+ # INVALID_ARGUMENT` error is returned.
7139
+ # @param [String] fields
7140
+ # Selector specifying which fields to include in a partial response.
7141
+ # @param [String] quota_user
7142
+ # Available to use for quota purposes for server-side applications. Can be any
7143
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
7144
+ # @param [Google::Apis::RequestOptions] options
7145
+ # Request-specific options
7146
+ #
7147
+ # @yield [result, err] Result & error if block supplied
7148
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuerySet] parsed result object
7149
+ # @yieldparam err [StandardError] error object if request failed
7150
+ #
7151
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuerySet]
7152
+ #
7153
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7154
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7155
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
7156
+ def create_project_location_sample_query_set(parent, google_cloud_discoveryengine_v1beta_sample_query_set_object = nil, sample_query_set_id: nil, fields: nil, quota_user: nil, options: nil, &block)
7157
+ command = make_simple_command(:post, 'v1beta/{+parent}/sampleQuerySets', options)
7158
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuerySet::Representation
7159
+ command.request_object = google_cloud_discoveryengine_v1beta_sample_query_set_object
7160
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuerySet::Representation
7161
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuerySet
7162
+ command.params['parent'] = parent unless parent.nil?
7163
+ command.query['sampleQuerySetId'] = sample_query_set_id unless sample_query_set_id.nil?
7164
+ command.query['fields'] = fields unless fields.nil?
7165
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
7166
+ execute_or_queue_command(command, &block)
7167
+ end
7168
+
7169
+ # Deletes a SampleQuerySet.
7170
+ # @param [String] name
7171
+ # Required. Full resource name of SampleQuerySet, such as `projects/`project`/
7172
+ # locations/`location`/sampleQuerySets/`sampleQuerySet``. If the caller does not
7173
+ # have permission to delete the SampleQuerySet, regardless of whether or not it
7174
+ # exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to
7175
+ # delete does not exist, a `NOT_FOUND` error is returned.
7176
+ # @param [String] fields
7177
+ # Selector specifying which fields to include in a partial response.
7178
+ # @param [String] quota_user
7179
+ # Available to use for quota purposes for server-side applications. Can be any
7180
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
7181
+ # @param [Google::Apis::RequestOptions] options
7182
+ # Request-specific options
7183
+ #
7184
+ # @yield [result, err] Result & error if block supplied
7185
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty] parsed result object
7186
+ # @yieldparam err [StandardError] error object if request failed
7187
+ #
7188
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty]
7189
+ #
7190
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7191
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7192
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
7193
+ def delete_project_location_sample_query_set(name, fields: nil, quota_user: nil, options: nil, &block)
7194
+ command = make_simple_command(:delete, 'v1beta/{+name}', options)
7195
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty::Representation
7196
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty
7197
+ command.params['name'] = name unless name.nil?
7198
+ command.query['fields'] = fields unless fields.nil?
7199
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
7200
+ execute_or_queue_command(command, &block)
7201
+ end
7202
+
7203
+ # Gets a SampleQuerySet.
7204
+ # @param [String] name
7205
+ # Required. Full resource name of SampleQuerySet, such as `projects/`project`/
7206
+ # locations/`location`/sampleQuerySets/`sampleQuerySet``. If the caller does not
7207
+ # have permission to access the SampleQuerySet, regardless of whether or not it
7208
+ # exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet
7209
+ # does not exist, a NOT_FOUND error is returned.
7210
+ # @param [String] fields
7211
+ # Selector specifying which fields to include in a partial response.
7212
+ # @param [String] quota_user
7213
+ # Available to use for quota purposes for server-side applications. Can be any
7214
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
7215
+ # @param [Google::Apis::RequestOptions] options
7216
+ # Request-specific options
7217
+ #
7218
+ # @yield [result, err] Result & error if block supplied
7219
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuerySet] parsed result object
7220
+ # @yieldparam err [StandardError] error object if request failed
7221
+ #
7222
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuerySet]
7223
+ #
7224
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7225
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7226
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
7227
+ def get_project_location_sample_query_set(name, fields: nil, quota_user: nil, options: nil, &block)
7228
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
7229
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuerySet::Representation
7230
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuerySet
7231
+ command.params['name'] = name unless name.nil?
7232
+ command.query['fields'] = fields unless fields.nil?
7233
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
7234
+ execute_or_queue_command(command, &block)
7235
+ end
7236
+
7237
+ # Gets a list of SampleQuerySets.
7238
+ # @param [String] parent
7239
+ # Required. The parent location resource name, such as `projects/`project`/
7240
+ # locations/`location``. If the caller does not have permission to list
7241
+ # SampleQuerySets under this location, regardless of whether or not this
7242
+ # location exists, a `PERMISSION_DENIED` error is returned.
7243
+ # @param [Fixnum] page_size
7244
+ # Maximum number of SampleQuerySets to return. If unspecified, defaults to 100.
7245
+ # The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.
7246
+ # If this field is negative, an `INVALID_ARGUMENT` error is returned.
7247
+ # @param [String] page_token
7248
+ # A page token ListSampleQuerySetsResponse.next_page_token, received from a
7249
+ # previous SampleQuerySetService.ListSampleQuerySets call. Provide this to
7250
+ # retrieve the subsequent page. When paginating, all other parameters provided
7251
+ # to SampleQuerySetService.ListSampleQuerySets must match the call that provided
7252
+ # the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
7253
+ # @param [String] fields
7254
+ # Selector specifying which fields to include in a partial response.
7255
+ # @param [String] quota_user
7256
+ # Available to use for quota purposes for server-side applications. Can be any
7257
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
7258
+ # @param [Google::Apis::RequestOptions] options
7259
+ # Request-specific options
7260
+ #
7261
+ # @yield [result, err] Result & error if block supplied
7262
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSampleQuerySetsResponse] parsed result object
7263
+ # @yieldparam err [StandardError] error object if request failed
7264
+ #
7265
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSampleQuerySetsResponse]
7266
+ #
7267
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7268
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7269
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
7270
+ def list_project_location_sample_query_sets(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
7271
+ command = make_simple_command(:get, 'v1beta/{+parent}/sampleQuerySets', options)
7272
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSampleQuerySetsResponse::Representation
7273
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSampleQuerySetsResponse
7274
+ command.params['parent'] = parent unless parent.nil?
7275
+ command.query['pageSize'] = page_size unless page_size.nil?
7276
+ command.query['pageToken'] = page_token unless page_token.nil?
7277
+ command.query['fields'] = fields unless fields.nil?
7278
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
7279
+ execute_or_queue_command(command, &block)
7280
+ end
7281
+
7282
+ # Updates a SampleQuerySet.
7283
+ # @param [String] name
7284
+ # Immutable. The full resource name of the SampleQuerySet, in the format of `
7285
+ # projects/`project`/locations/`location`/sampleQuerySets/`sampleQuerySet``.
7286
+ # This field must be a UTF-8 encoded string with a length limit of 1024
7287
+ # characters.
7288
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuerySet] google_cloud_discoveryengine_v1beta_sample_query_set_object
7289
+ # @param [String] update_mask
7290
+ # Indicates which fields in the provided imported 'sample query set' to update.
7291
+ # If not set, will by default update all fields.
7292
+ # @param [String] fields
7293
+ # Selector specifying which fields to include in a partial response.
7294
+ # @param [String] quota_user
7295
+ # Available to use for quota purposes for server-side applications. Can be any
7296
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
7297
+ # @param [Google::Apis::RequestOptions] options
7298
+ # Request-specific options
7299
+ #
7300
+ # @yield [result, err] Result & error if block supplied
7301
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuerySet] parsed result object
7302
+ # @yieldparam err [StandardError] error object if request failed
7303
+ #
7304
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuerySet]
7305
+ #
7306
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7307
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7308
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
7309
+ def patch_project_location_sample_query_set(name, google_cloud_discoveryengine_v1beta_sample_query_set_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
7310
+ command = make_simple_command(:patch, 'v1beta/{+name}', options)
7311
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuerySet::Representation
7312
+ command.request_object = google_cloud_discoveryengine_v1beta_sample_query_set_object
7313
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuerySet::Representation
7314
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuerySet
7315
+ command.params['name'] = name unless name.nil?
7316
+ command.query['updateMask'] = update_mask unless update_mask.nil?
7317
+ command.query['fields'] = fields unless fields.nil?
7318
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
7319
+ execute_or_queue_command(command, &block)
7320
+ end
7321
+
7322
+ # Gets the latest state of a long-running operation. Clients can use this method
7323
+ # to poll the operation result at intervals as recommended by the API service.
7324
+ # @param [String] name
7325
+ # The name of the operation resource.
7326
+ # @param [String] fields
7327
+ # Selector specifying which fields to include in a partial response.
7328
+ # @param [String] quota_user
7329
+ # Available to use for quota purposes for server-side applications. Can be any
7330
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
7331
+ # @param [Google::Apis::RequestOptions] options
7332
+ # Request-specific options
7333
+ #
7334
+ # @yield [result, err] Result & error if block supplied
7335
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
7336
+ # @yieldparam err [StandardError] error object if request failed
7337
+ #
7338
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
7339
+ #
7340
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7341
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7342
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
7343
+ def get_project_location_sample_query_set_operation(name, fields: nil, quota_user: nil, options: nil, &block)
7344
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
7345
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
7346
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
7347
+ command.params['name'] = name unless name.nil?
7348
+ command.query['fields'] = fields unless fields.nil?
7349
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
7350
+ execute_or_queue_command(command, &block)
7351
+ end
7352
+
7353
+ # Creates a SampleQuery
7354
+ # @param [String] parent
7355
+ # Required. The parent resource name, such as `projects/`project`/locations/`
7356
+ # location`/sampleQuerySets/`sampleQuerySet``.
7357
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuery] google_cloud_discoveryengine_v1beta_sample_query_object
7358
+ # @param [String] sample_query_id
7359
+ # Required. The ID to use for the SampleQuery, which will become the final
7360
+ # component of the SampleQuery.name. If the caller does not have permission to
7361
+ # create the SampleQuery, regardless of whether or not it exists, a `
7362
+ # PERMISSION_DENIED` error is returned. This field must be unique among all
7363
+ # SampleQuerys with the same parent. Otherwise, an `ALREADY_EXISTS` error is
7364
+ # returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/
7365
+ # rfc1034) standard with a length limit of 63 characters. Otherwise, an `
7366
+ # INVALID_ARGUMENT` error is returned.
7367
+ # @param [String] fields
7368
+ # Selector specifying which fields to include in a partial response.
7369
+ # @param [String] quota_user
7370
+ # Available to use for quota purposes for server-side applications. Can be any
7371
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
7372
+ # @param [Google::Apis::RequestOptions] options
7373
+ # Request-specific options
7374
+ #
7375
+ # @yield [result, err] Result & error if block supplied
7376
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuery] parsed result object
7377
+ # @yieldparam err [StandardError] error object if request failed
7378
+ #
7379
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuery]
7380
+ #
7381
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7382
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7383
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
7384
+ def create_project_location_sample_query_set_sample_query(parent, google_cloud_discoveryengine_v1beta_sample_query_object = nil, sample_query_id: nil, fields: nil, quota_user: nil, options: nil, &block)
7385
+ command = make_simple_command(:post, 'v1beta/{+parent}/sampleQueries', options)
7386
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuery::Representation
7387
+ command.request_object = google_cloud_discoveryengine_v1beta_sample_query_object
7388
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuery::Representation
7389
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuery
7390
+ command.params['parent'] = parent unless parent.nil?
7391
+ command.query['sampleQueryId'] = sample_query_id unless sample_query_id.nil?
7392
+ command.query['fields'] = fields unless fields.nil?
7393
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
7394
+ execute_or_queue_command(command, &block)
7395
+ end
7396
+
7397
+ # Deletes a SampleQuery.
7398
+ # @param [String] name
7399
+ # Required. Full resource name of SampleQuery, such as `projects/`project`/
7400
+ # locations/`location`/sampleQuerySets/`sampleQuerySet`/sampleQueries/`
7401
+ # sampleQuery``. If the caller does not have permission to delete the
7402
+ # SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED`
7403
+ # error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND`
7404
+ # error is returned.
7405
+ # @param [String] fields
7406
+ # Selector specifying which fields to include in a partial response.
7407
+ # @param [String] quota_user
7408
+ # Available to use for quota purposes for server-side applications. Can be any
7409
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
7410
+ # @param [Google::Apis::RequestOptions] options
7411
+ # Request-specific options
7412
+ #
7413
+ # @yield [result, err] Result & error if block supplied
7414
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty] parsed result object
7415
+ # @yieldparam err [StandardError] error object if request failed
7416
+ #
7417
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty]
7418
+ #
7419
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7420
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7421
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
7422
+ def delete_project_location_sample_query_set_sample_query(name, fields: nil, quota_user: nil, options: nil, &block)
7423
+ command = make_simple_command(:delete, 'v1beta/{+name}', options)
7424
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty::Representation
7425
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty
7426
+ command.params['name'] = name unless name.nil?
7427
+ command.query['fields'] = fields unless fields.nil?
7428
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
7429
+ execute_or_queue_command(command, &block)
7430
+ end
7431
+
7432
+ # Gets a SampleQuery.
7433
+ # @param [String] name
7434
+ # Required. Full resource name of SampleQuery, such as `projects/`project`/
7435
+ # locations/`location`/sampleQuerySets/`sampleQuerySet`/sampleQueries/`
7436
+ # sampleQuery``. If the caller does not have permission to access the
7437
+ # SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error
7438
+ # is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is
7439
+ # returned.
7440
+ # @param [String] fields
7441
+ # Selector specifying which fields to include in a partial response.
7442
+ # @param [String] quota_user
7443
+ # Available to use for quota purposes for server-side applications. Can be any
7444
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
7445
+ # @param [Google::Apis::RequestOptions] options
7446
+ # Request-specific options
7447
+ #
7448
+ # @yield [result, err] Result & error if block supplied
7449
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuery] parsed result object
7450
+ # @yieldparam err [StandardError] error object if request failed
7451
+ #
7452
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuery]
7453
+ #
7454
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7455
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7456
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
7457
+ def get_project_location_sample_query_set_sample_query(name, fields: nil, quota_user: nil, options: nil, &block)
7458
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
7459
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuery::Representation
7460
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuery
7461
+ command.params['name'] = name unless name.nil?
7462
+ command.query['fields'] = fields unless fields.nil?
7463
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
7464
+ execute_or_queue_command(command, &block)
7465
+ end
7466
+
7467
+ # Bulk import of multiple SampleQuerys. Sample queries that already exist may be
7468
+ # deleted. Note: It is possible for a subset of the SampleQuerys to be
7469
+ # successfully imported.
7470
+ # @param [String] parent
7471
+ # Required. The parent sample query set resource name, such as `projects/`
7472
+ # project`/locations/`location`/sampleQuerySets/`sampleQuerySet``. If the caller
7473
+ # does not have permission to list SampleQuerys under this sample query set,
7474
+ # regardless of whether or not this sample query set exists, a `
7475
+ # PERMISSION_DENIED` error is returned.
7476
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequest] google_cloud_discoveryengine_v1beta_import_sample_queries_request_object
7477
+ # @param [String] fields
7478
+ # Selector specifying which fields to include in a partial response.
7479
+ # @param [String] quota_user
7480
+ # Available to use for quota purposes for server-side applications. Can be any
7481
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
7482
+ # @param [Google::Apis::RequestOptions] options
7483
+ # Request-specific options
7484
+ #
7485
+ # @yield [result, err] Result & error if block supplied
7486
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
7487
+ # @yieldparam err [StandardError] error object if request failed
7488
+ #
7489
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
7490
+ #
7491
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7492
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7493
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
7494
+ def import_project_location_sample_query_set_sample_query(parent, google_cloud_discoveryengine_v1beta_import_sample_queries_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
7495
+ command = make_simple_command(:post, 'v1beta/{+parent}/sampleQueries:import', options)
7496
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequest::Representation
7497
+ command.request_object = google_cloud_discoveryengine_v1beta_import_sample_queries_request_object
7498
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
7499
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
7500
+ command.params['parent'] = parent unless parent.nil?
7501
+ command.query['fields'] = fields unless fields.nil?
7502
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
7503
+ execute_or_queue_command(command, &block)
7504
+ end
7505
+
7506
+ # Gets a list of SampleQuerys.
7507
+ # @param [String] parent
7508
+ # Required. The parent sample query set resource name, such as `projects/`
7509
+ # project`/locations/`location`/sampleQuerySets/`sampleQuerySet``. If the caller
7510
+ # does not have permission to list SampleQuerys under this sample query set,
7511
+ # regardless of whether or not this sample query set exists, a `
7512
+ # PERMISSION_DENIED` error is returned.
7513
+ # @param [Fixnum] page_size
7514
+ # Maximum number of SampleQuerys to return. If unspecified, defaults to 100. The
7515
+ # maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If
7516
+ # this field is negative, an `INVALID_ARGUMENT` error is returned.
7517
+ # @param [String] page_token
7518
+ # A page token ListSampleQueriesResponse.next_page_token, received from a
7519
+ # previous SampleQueryService.ListSampleQueries call. Provide this to retrieve
7520
+ # the subsequent page. When paginating, all other parameters provided to
7521
+ # SampleQueryService.ListSampleQueries must match the call that provided the
7522
+ # page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
7523
+ # @param [String] fields
7524
+ # Selector specifying which fields to include in a partial response.
7525
+ # @param [String] quota_user
7526
+ # Available to use for quota purposes for server-side applications. Can be any
7527
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
7528
+ # @param [Google::Apis::RequestOptions] options
7529
+ # Request-specific options
7530
+ #
7531
+ # @yield [result, err] Result & error if block supplied
7532
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSampleQueriesResponse] parsed result object
7533
+ # @yieldparam err [StandardError] error object if request failed
7534
+ #
7535
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSampleQueriesResponse]
7536
+ #
7537
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7538
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7539
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
7540
+ def list_project_location_sample_query_set_sample_queries(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
7541
+ command = make_simple_command(:get, 'v1beta/{+parent}/sampleQueries', options)
7542
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSampleQueriesResponse::Representation
7543
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSampleQueriesResponse
7544
+ command.params['parent'] = parent unless parent.nil?
7545
+ command.query['pageSize'] = page_size unless page_size.nil?
7546
+ command.query['pageToken'] = page_token unless page_token.nil?
7547
+ command.query['fields'] = fields unless fields.nil?
7548
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
7549
+ execute_or_queue_command(command, &block)
7550
+ end
7551
+
7552
+ # Updates a SampleQuery.
7553
+ # @param [String] name
7554
+ # Immutable. The full resource name of the sample query, in the format of `
7555
+ # projects/`project`/locations/`location`/sampleQuerySets/`sampleQuerySet`/
7556
+ # sampleQueries/`sampleQuery``. This field must be a UTF-8 encoded string with a
7557
+ # length limit of 1024 characters.
7558
+ # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuery] google_cloud_discoveryengine_v1beta_sample_query_object
7559
+ # @param [String] update_mask
7560
+ # Indicates which fields in the provided imported 'simple query' to update. If
7561
+ # not set, will by default update all fields.
7562
+ # @param [String] fields
7563
+ # Selector specifying which fields to include in a partial response.
7564
+ # @param [String] quota_user
7565
+ # Available to use for quota purposes for server-side applications. Can be any
7566
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
7567
+ # @param [Google::Apis::RequestOptions] options
7568
+ # Request-specific options
7569
+ #
7570
+ # @yield [result, err] Result & error if block supplied
7571
+ # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuery] parsed result object
7572
+ # @yieldparam err [StandardError] error object if request failed
7573
+ #
7574
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuery]
7575
+ #
7576
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
7577
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
7578
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
7579
+ def patch_project_location_sample_query_set_sample_query(name, google_cloud_discoveryengine_v1beta_sample_query_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
7580
+ command = make_simple_command(:patch, 'v1beta/{+name}', options)
7581
+ command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuery::Representation
7582
+ command.request_object = google_cloud_discoveryengine_v1beta_sample_query_object
7583
+ command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuery::Representation
7584
+ command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSampleQuery
7585
+ command.params['name'] = name unless name.nil?
7586
+ command.query['updateMask'] = update_mask unless update_mask.nil?
7587
+ command.query['fields'] = fields unless fields.nil?
7588
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
7589
+ execute_or_queue_command(command, &block)
7590
+ end
7591
+
6935
7592
  # Writes a single user event from the browser. This uses a GET request to due to
6936
7593
  # browser restriction of POST-ing to a third-party domain. This method is used
6937
7594
  # only by the Discovery Engine API JavaScript pixel and Google Tag Manager.