Class: Google::Apis::CloudsearchV1::CloudSearchService
- Inherits:
-
Google::Apis::Core::BaseService
- Object
- Google::Apis::Core::BaseService
- Google::Apis::CloudsearchV1::CloudSearchService
- Defined in:
- generated/google/apis/cloudsearch_v1/service.rb
Overview
Cloud Search API
Cloud Search provides cloud-based search capabilities over G Suite data. The Cloud Search API allows indexing of non-G Suite data into Cloud Search.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Attributes inherited from Google::Apis::Core::BaseService
#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path
Instance Method Summary collapse
-
#check_debug_datasource_item_access(name, principal_object = nil, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::CheckAccessResponse
Checks whether an item is accessible by specified principal.
-
#create_setting_datasource(data_source_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::Operation
Creates a datasource.
-
#create_setting_searchapplication(search_application_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::Operation
Creates a search application.
-
#delete_indexing_datasource_item(name, connector_name: nil, debug_options_enable_debugging: nil, mode: nil, version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::Operation
Deletes Item resource for the specified resource name.
-
#delete_indexing_datasource_schema(name, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::Operation
Deletes the schema of a data source.
-
#delete_queue_items(name, delete_queue_items_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::Operation
Deletes all items in a queue.
-
#delete_setting_datasource(name, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::Operation
Deletes a datasource.
-
#delete_setting_searchapplication(name, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::Operation
Deletes a search application.
-
#get_indexing_datasource_item(name, connector_name: nil, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::Item
Gets Item resource by item name.
-
#get_indexing_datasource_schema(name, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::Schema
Gets the schema of a data source.
-
#get_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::Operation
Gets the latest state of a long-running operation.
-
#get_setting_datasource(name, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::DataSource
Gets a datasource.
-
#get_setting_searchapplication(name, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::SearchApplication
Gets the specified search application.
-
#get_stat_index(from_date_day: nil, from_date_month: nil, from_date_year: nil, to_date_day: nil, to_date_month: nil, to_date_year: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::GetCustomerIndexStatsResponse
Gets indexed item statistics aggreggated across all data sources.
-
#get_stat_index_datasource(name, from_date_day: nil, from_date_month: nil, from_date_year: nil, to_date_day: nil, to_date_month: nil, to_date_year: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::GetDataSourceIndexStatsResponse
Gets indexed item statistics for a single data source.
-
#get_stat_query(from_date_day: nil, from_date_month: nil, from_date_year: nil, to_date_day: nil, to_date_month: nil, to_date_year: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::GetCustomerQueryStatsResponse
Get the query statistics for customer.
-
#get_stat_query_searchapplication(name, from_date_day: nil, from_date_month: nil, from_date_year: nil, to_date_day: nil, to_date_month: nil, to_date_year: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::GetSearchApplicationQueryStatsResponse
Get the query statistics for search application.
-
#get_stat_session(from_date_day: nil, from_date_month: nil, from_date_year: nil, to_date_day: nil, to_date_month: nil, to_date_year: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::GetCustomerSessionStatsResponse
Get the # of search sessions, % of successful sessions with a click query statistics for customer.
-
#get_stat_session_searchapplication(name, from_date_day: nil, from_date_month: nil, from_date_year: nil, to_date_day: nil, to_date_month: nil, to_date_year: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::GetSearchApplicationSessionStatsResponse
Get the # of search sessions, % of successful sessions with a click query statistics for search application.
-
#get_stat_user(from_date_day: nil, from_date_month: nil, from_date_year: nil, to_date_day: nil, to_date_month: nil, to_date_year: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::GetCustomerUserStatsResponse
Get the users statistics for customer.
-
#get_stat_user_searchapplication(name, from_date_day: nil, from_date_month: nil, from_date_year: nil, to_date_day: nil, to_date_month: nil, to_date_year: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::GetSearchApplicationUserStatsResponse
Get the users statistics for search application.
-
#index_item(name, index_item_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::Operation
Updates Item ACL, metadata, and content.
-
#initialize ⇒ CloudSearchService
constructor
A new instance of CloudSearchService.
-
#list_debug_datasource_item_unmappedids(parent, debug_options_enable_debugging: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::ListUnmappedIdentitiesResponse
List all unmapped identities for a specific item.
-
#list_debug_identitysource_item_forunmappedidentity(parent, debug_options_enable_debugging: nil, group_resource_name: nil, page_size: nil, page_token: nil, user_resource_name: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::ListItemNamesForUnmappedIdentityResponse
Lists names of items associated with an unmapped identity.
-
#list_debug_identitysource_unmappedids(parent, debug_options_enable_debugging: nil, page_size: nil, page_token: nil, resolution_status_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::ListUnmappedIdentitiesResponse
Lists unmapped user identities for an identity source.
-
#list_indexing_datasource_items(name, brief: nil, connector_name: nil, debug_options_enable_debugging: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::ListItemsResponse
Lists all or a subset of Item resources.
-
#list_query_sources(page_token: nil, request_options_debug_options_enable_debugging: nil, request_options_language_code: nil, request_options_search_application_id: nil, request_options_time_zone: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::ListQuerySourcesResponse
Returns list of sources that user can use for Search and Suggest APIs.
-
#list_setting_datasources(debug_options_enable_debugging: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::ListDataSourceResponse
Lists datasources.
-
#list_setting_searchapplications(debug_options_enable_debugging: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::ListSearchApplicationsResponse
Lists all search applications.
-
#poll_items(name, poll_items_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::PollItemsResponse
Polls for unreserved items from the indexing queue and marks a set as reserved, starting with items that have the oldest timestamp from the highest priority ItemStatus.
-
#push_item(name, push_item_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::Item
Pushes an item onto a queue for later polling and updating.
-
#reset_searchapplication_search_application(name, reset_search_application_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::Operation
Resets a search application to default settings.
-
#search_debug_datasource_item_by_view_url(name, search_items_by_view_url_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::SearchItemsByViewUrlResponse
Fetches the item whose viewUrl exactly matches that of the URL provided in the request.
-
#search_query(search_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::SearchResponse
The Cloud Search Query API provides the search method, which returns the most relevant results from a user query.
-
#suggest_query(suggest_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::SuggestResponse
Provides suggestions for autocompleting the query.
-
#unreserve_items(name, unreserve_items_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::Operation
Unreserves all items from a queue, making them all eligible to be polled.
-
#update_datasource_data_source(name, update_data_source_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::Operation
Updates a datasource.
-
#update_datasource_schema(name, update_schema_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::Operation
Updates the schema of a data source.
-
#update_setting_searchapplication(name, search_application_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::Operation
Updates a search application.
-
#upload_indexing_datasource_item(name, start_upload_item_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::UploadItemRef
Creates an upload session for uploading item content.
-
#upload_medium(resource_name, media_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::Media
Uploads media for indexing.
Methods inherited from Google::Apis::Core::BaseService
#batch, #batch_upload, #fetch_all, #http
Methods included from Google::Apis::Core::Logging
Constructor Details
#initialize ⇒ CloudSearchService
Returns a new instance of CloudSearchService.
46 47 48 49 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 46 def initialize super('https://cloudsearch.googleapis.com/', '') @batch_path = 'batch' end |
Instance Attribute Details
#key ⇒ String
Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
39 40 41 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 39 def key @key end |
#quota_user ⇒ String
Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
44 45 46 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 44 def quota_user @quota_user end |
Instance Method Details
#check_debug_datasource_item_access(name, principal_object = nil, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::CheckAccessResponse
Checks whether an item is accessible by specified principal. Note: This API requires an admin account to execute.
77 78 79 80 81 82 83 84 85 86 87 88 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 77 def check_debug_datasource_item_access(name, principal_object = nil, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/debug/{+name}:checkAccess', ) command.request_representation = Google::Apis::CloudsearchV1::Principal::Representation command.request_object = principal_object command.response_representation = Google::Apis::CloudsearchV1::CheckAccessResponse::Representation command.response_class = Google::Apis::CloudsearchV1::CheckAccessResponse command.params['name'] = name unless name.nil? command.query['debugOptions.enableDebugging'] = unless .nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#create_setting_datasource(data_source_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::Operation
Creates a datasource. Note: This API requires an admin account to execute.
1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 1033 def create_setting_datasource(data_source_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/settings/datasources', ) command.request_representation = Google::Apis::CloudsearchV1::DataSource::Representation command.request_object = data_source_object command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation command.response_class = Google::Apis::CloudsearchV1::Operation command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#create_setting_searchapplication(search_application_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::Operation
Creates a search application. Note: This API requires an admin account to execute.
1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 1212 def create_setting_searchapplication(search_application_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/settings/searchapplications', ) command.request_representation = Google::Apis::CloudsearchV1::SearchApplication::Representation command.request_object = search_application_object command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation command.response_class = Google::Apis::CloudsearchV1::Operation command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_indexing_datasource_item(name, connector_name: nil, debug_options_enable_debugging: nil, mode: nil, version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::Operation
Deletes Item resource for the specified resource name. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.
413 414 415 416 417 418 419 420 421 422 423 424 425 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 413 def delete_indexing_datasource_item(name, connector_name: nil, debug_options_enable_debugging: nil, mode: nil, version: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/indexing/{+name}', ) command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation command.response_class = Google::Apis::CloudsearchV1::Operation command.params['name'] = name unless name.nil? command.query['connectorName'] = connector_name unless connector_name.nil? command.query['debugOptions.enableDebugging'] = unless .nil? command.query['mode'] = mode unless mode.nil? command.query['version'] = version unless version.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_indexing_datasource_schema(name, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::Operation
Deletes the schema of a data source. Note: This API requires an admin or service account to execute.
287 288 289 290 291 292 293 294 295 296 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 287 def delete_indexing_datasource_schema(name, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/indexing/{+name}/schema', ) command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation command.response_class = Google::Apis::CloudsearchV1::Operation command.params['name'] = name unless name.nil? command.query['debugOptions.enableDebugging'] = unless .nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_queue_items(name, delete_queue_items_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::Operation
Deletes all items in a queue. This method is useful for deleting stale items. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.
452 453 454 455 456 457 458 459 460 461 462 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 452 def delete_queue_items(name, delete_queue_items_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/indexing/{+name}/items:deleteQueueItems', ) command.request_representation = Google::Apis::CloudsearchV1::DeleteQueueItemsRequest::Representation command.request_object = delete_queue_items_request_object command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation command.response_class = Google::Apis::CloudsearchV1::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_setting_datasource(name, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::Operation
Deletes a datasource. Note: This API requires an admin account to execute.
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 1069 def delete_setting_datasource(name, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/settings/{+name}', ) command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation command.response_class = Google::Apis::CloudsearchV1::Operation command.params['name'] = name unless name.nil? command.query['debugOptions.enableDebugging'] = unless .nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_setting_searchapplication(name, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::Operation
Deletes a search application. Note: This API requires an admin account to execute.
1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 1248 def delete_setting_searchapplication(name, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/settings/{+name}', ) command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation command.response_class = Google::Apis::CloudsearchV1::Operation command.params['name'] = name unless name.nil? command.query['debugOptions.enableDebugging'] = unless .nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_indexing_datasource_item(name, connector_name: nil, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::Item
Gets Item resource by item name. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.
493 494 495 496 497 498 499 500 501 502 503 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 493 def get_indexing_datasource_item(name, connector_name: nil, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/indexing/{+name}', ) command.response_representation = Google::Apis::CloudsearchV1::Item::Representation command.response_class = Google::Apis::CloudsearchV1::Item command.params['name'] = name unless name.nil? command.query['connectorName'] = connector_name unless connector_name.nil? command.query['debugOptions.enableDebugging'] = unless .nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_indexing_datasource_schema(name, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::Schema
Gets the schema of a data source. Note: This API requires an admin or service account to execute.
323 324 325 326 327 328 329 330 331 332 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 323 def get_indexing_datasource_schema(name, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/indexing/{+name}/schema', ) command.response_representation = Google::Apis::CloudsearchV1::Schema::Representation command.response_class = Google::Apis::CloudsearchV1::Schema command.params['name'] = name unless name.nil? command.query['debugOptions.enableDebugging'] = unless .nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::Operation
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
878 879 880 881 882 883 884 885 886 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 878 def get_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation command.response_class = Google::Apis::CloudsearchV1::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_setting_datasource(name, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::DataSource
Gets a datasource. Note: This API requires an admin account to execute.
1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 1105 def get_setting_datasource(name, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/settings/{+name}', ) command.response_representation = Google::Apis::CloudsearchV1::DataSource::Representation command.response_class = Google::Apis::CloudsearchV1::DataSource command.params['name'] = name unless name.nil? command.query['debugOptions.enableDebugging'] = unless .nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_setting_searchapplication(name, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::SearchApplication
Gets the specified search application. Note: This API requires an admin account to execute.
1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 1284 def get_setting_searchapplication(name, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/settings/{+name}', ) command.response_representation = Google::Apis::CloudsearchV1::SearchApplication::Representation command.response_class = Google::Apis::CloudsearchV1::SearchApplication command.params['name'] = name unless name.nil? command.query['debugOptions.enableDebugging'] = unless .nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_stat_index(from_date_day: nil, from_date_month: nil, from_date_year: nil, to_date_day: nil, to_date_month: nil, to_date_year: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::GetCustomerIndexStatsResponse
Gets indexed item statistics aggreggated across all data sources. This API only returns statistics for previous dates; it doesn't return statistics for the current day. Note: This API requires a standard end user account to execute.
1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 1438 def get_stat_index(from_date_day: nil, from_date_month: nil, from_date_year: nil, to_date_day: nil, to_date_month: nil, to_date_year: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/stats/index', ) command.response_representation = Google::Apis::CloudsearchV1::GetCustomerIndexStatsResponse::Representation command.response_class = Google::Apis::CloudsearchV1::GetCustomerIndexStatsResponse command.query['fromDate.day'] = from_date_day unless from_date_day.nil? command.query['fromDate.month'] = from_date_month unless from_date_month.nil? command.query['fromDate.year'] = from_date_year unless from_date_year.nil? command.query['toDate.day'] = to_date_day unless to_date_day.nil? command.query['toDate.month'] = to_date_month unless to_date_month.nil? command.query['toDate.year'] = to_date_year unless to_date_year.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_stat_index_datasource(name, from_date_day: nil, from_date_month: nil, from_date_year: nil, to_date_day: nil, to_date_month: nil, to_date_year: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::GetDataSourceIndexStatsResponse
Gets indexed item statistics for a single data source. Note: This API requires a standard end user account to execute.
1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 1626 def get_stat_index_datasource(name, from_date_day: nil, from_date_month: nil, from_date_year: nil, to_date_day: nil, to_date_month: nil, to_date_year: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/stats/index/{+name}', ) command.response_representation = Google::Apis::CloudsearchV1::GetDataSourceIndexStatsResponse::Representation command.response_class = Google::Apis::CloudsearchV1::GetDataSourceIndexStatsResponse command.params['name'] = name unless name.nil? command.query['fromDate.day'] = from_date_day unless from_date_day.nil? command.query['fromDate.month'] = from_date_month unless from_date_month.nil? command.query['fromDate.year'] = from_date_year unless from_date_year.nil? command.query['toDate.day'] = to_date_day unless to_date_day.nil? command.query['toDate.month'] = to_date_month unless to_date_month.nil? command.query['toDate.year'] = to_date_year unless to_date_year.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_stat_query(from_date_day: nil, from_date_month: nil, from_date_year: nil, to_date_day: nil, to_date_month: nil, to_date_year: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::GetCustomerQueryStatsResponse
Get the query statistics for customer. Note: This API requires a standard end user account to execute.
1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 1484 def get_stat_query(from_date_day: nil, from_date_month: nil, from_date_year: nil, to_date_day: nil, to_date_month: nil, to_date_year: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/stats/query', ) command.response_representation = Google::Apis::CloudsearchV1::GetCustomerQueryStatsResponse::Representation command.response_class = Google::Apis::CloudsearchV1::GetCustomerQueryStatsResponse command.query['fromDate.day'] = from_date_day unless from_date_day.nil? command.query['fromDate.month'] = from_date_month unless from_date_month.nil? command.query['fromDate.year'] = from_date_year unless from_date_year.nil? command.query['toDate.day'] = to_date_day unless to_date_day.nil? command.query['toDate.month'] = to_date_month unless to_date_month.nil? command.query['toDate.year'] = to_date_year unless to_date_year.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_stat_query_searchapplication(name, from_date_day: nil, from_date_month: nil, from_date_year: nil, to_date_day: nil, to_date_month: nil, to_date_year: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::GetSearchApplicationQueryStatsResponse
Get the query statistics for search application. Note: This API requires a standard end user account to execute.
1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 1676 def get_stat_query_searchapplication(name, from_date_day: nil, from_date_month: nil, from_date_year: nil, to_date_day: nil, to_date_month: nil, to_date_year: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/stats/query/{+name}', ) command.response_representation = Google::Apis::CloudsearchV1::GetSearchApplicationQueryStatsResponse::Representation command.response_class = Google::Apis::CloudsearchV1::GetSearchApplicationQueryStatsResponse command.params['name'] = name unless name.nil? command.query['fromDate.day'] = from_date_day unless from_date_day.nil? command.query['fromDate.month'] = from_date_month unless from_date_month.nil? command.query['fromDate.year'] = from_date_year unless from_date_year.nil? command.query['toDate.day'] = to_date_day unless to_date_day.nil? command.query['toDate.month'] = to_date_month unless to_date_month.nil? command.query['toDate.year'] = to_date_year unless to_date_year.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_stat_session(from_date_day: nil, from_date_month: nil, from_date_year: nil, to_date_day: nil, to_date_month: nil, to_date_year: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::GetCustomerSessionStatsResponse
Get the # of search sessions, % of successful sessions with a click query statistics for customer. Note: This API requires a standard end user account to execute.
1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 1531 def get_stat_session(from_date_day: nil, from_date_month: nil, from_date_year: nil, to_date_day: nil, to_date_month: nil, to_date_year: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/stats/session', ) command.response_representation = Google::Apis::CloudsearchV1::GetCustomerSessionStatsResponse::Representation command.response_class = Google::Apis::CloudsearchV1::GetCustomerSessionStatsResponse command.query['fromDate.day'] = from_date_day unless from_date_day.nil? command.query['fromDate.month'] = from_date_month unless from_date_month.nil? command.query['fromDate.year'] = from_date_year unless from_date_year.nil? command.query['toDate.day'] = to_date_day unless to_date_day.nil? command.query['toDate.month'] = to_date_month unless to_date_month.nil? command.query['toDate.year'] = to_date_year unless to_date_year.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_stat_session_searchapplication(name, from_date_day: nil, from_date_month: nil, from_date_year: nil, to_date_day: nil, to_date_month: nil, to_date_year: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::GetSearchApplicationSessionStatsResponse
Get the # of search sessions, % of successful sessions with a click query statistics for search application. Note: This API requires a standard end user account to execute.
1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 1727 def get_stat_session_searchapplication(name, from_date_day: nil, from_date_month: nil, from_date_year: nil, to_date_day: nil, to_date_month: nil, to_date_year: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/stats/session/{+name}', ) command.response_representation = Google::Apis::CloudsearchV1::GetSearchApplicationSessionStatsResponse::Representation command.response_class = Google::Apis::CloudsearchV1::GetSearchApplicationSessionStatsResponse command.params['name'] = name unless name.nil? command.query['fromDate.day'] = from_date_day unless from_date_day.nil? command.query['fromDate.month'] = from_date_month unless from_date_month.nil? command.query['fromDate.year'] = from_date_year unless from_date_year.nil? command.query['toDate.day'] = to_date_day unless to_date_day.nil? command.query['toDate.month'] = to_date_month unless to_date_month.nil? command.query['toDate.year'] = to_date_year unless to_date_year.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_stat_user(from_date_day: nil, from_date_month: nil, from_date_year: nil, to_date_day: nil, to_date_month: nil, to_date_year: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::GetCustomerUserStatsResponse
Get the users statistics for customer. Note: This API requires a standard end user account to execute.
1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 1577 def get_stat_user(from_date_day: nil, from_date_month: nil, from_date_year: nil, to_date_day: nil, to_date_month: nil, to_date_year: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/stats/user', ) command.response_representation = Google::Apis::CloudsearchV1::GetCustomerUserStatsResponse::Representation command.response_class = Google::Apis::CloudsearchV1::GetCustomerUserStatsResponse command.query['fromDate.day'] = from_date_day unless from_date_day.nil? command.query['fromDate.month'] = from_date_month unless from_date_month.nil? command.query['fromDate.year'] = from_date_year unless from_date_year.nil? command.query['toDate.day'] = to_date_day unless to_date_day.nil? command.query['toDate.month'] = to_date_month unless to_date_month.nil? command.query['toDate.year'] = to_date_year unless to_date_year.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_stat_user_searchapplication(name, from_date_day: nil, from_date_month: nil, from_date_year: nil, to_date_day: nil, to_date_month: nil, to_date_year: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::GetSearchApplicationUserStatsResponse
Get the users statistics for search application. Note: This API requires a standard end user account to execute.
1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 1777 def get_stat_user_searchapplication(name, from_date_day: nil, from_date_month: nil, from_date_year: nil, to_date_day: nil, to_date_month: nil, to_date_year: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/stats/user/{+name}', ) command.response_representation = Google::Apis::CloudsearchV1::GetSearchApplicationUserStatsResponse::Representation command.response_class = Google::Apis::CloudsearchV1::GetSearchApplicationUserStatsResponse command.params['name'] = name unless name.nil? command.query['fromDate.day'] = from_date_day unless from_date_day.nil? command.query['fromDate.month'] = from_date_month unless from_date_month.nil? command.query['fromDate.year'] = from_date_year unless from_date_year.nil? command.query['toDate.day'] = to_date_day unless to_date_day.nil? command.query['toDate.month'] = to_date_month unless to_date_month.nil? command.query['toDate.year'] = to_date_year unless to_date_year.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#index_item(name, index_item_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::Operation
Updates Item ACL, metadata, and content. It will insert the Item if it does not exist. This method does not support partial updates. Fields with no provided values are cleared out in the Cloud Search index. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.
535 536 537 538 539 540 541 542 543 544 545 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 535 def index_item(name, index_item_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/indexing/{+name}:index', ) command.request_representation = Google::Apis::CloudsearchV1::IndexItemRequest::Representation command.request_object = index_item_request_object command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation command.response_class = Google::Apis::CloudsearchV1::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_debug_datasource_item_unmappedids(parent, debug_options_enable_debugging: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::ListUnmappedIdentitiesResponse
List all unmapped identities for a specific item. Note: This API requires an admin account to execute.
156 157 158 159 160 161 162 163 164 165 166 167 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 156 def list_debug_datasource_item_unmappedids(parent, debug_options_enable_debugging: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/debug/{+parent}/unmappedids', ) command.response_representation = Google::Apis::CloudsearchV1::ListUnmappedIdentitiesResponse::Representation command.response_class = Google::Apis::CloudsearchV1::ListUnmappedIdentitiesResponse command.params['parent'] = parent unless parent.nil? command.query['debugOptions.enableDebugging'] = unless .nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_debug_identitysource_item_forunmappedidentity(parent, debug_options_enable_debugging: nil, group_resource_name: nil, page_size: nil, page_token: nil, user_resource_name: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::ListItemNamesForUnmappedIdentityResponse
Lists names of items associated with an unmapped identity. Note: This API requires an admin account to execute.
201 202 203 204 205 206 207 208 209 210 211 212 213 214 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 201 def list_debug_identitysource_item_forunmappedidentity(parent, debug_options_enable_debugging: nil, group_resource_name: nil, page_size: nil, page_token: nil, user_resource_name: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/debug/{+parent}/items:forunmappedidentity', ) command.response_representation = Google::Apis::CloudsearchV1::ListItemNamesForUnmappedIdentityResponse::Representation command.response_class = Google::Apis::CloudsearchV1::ListItemNamesForUnmappedIdentityResponse command.params['parent'] = parent unless parent.nil? command.query['debugOptions.enableDebugging'] = unless .nil? command.query['groupResourceName'] = group_resource_name unless group_resource_name.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['userResourceName'] = user_resource_name unless user_resource_name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_debug_identitysource_unmappedids(parent, debug_options_enable_debugging: nil, page_size: nil, page_token: nil, resolution_status_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::ListUnmappedIdentitiesResponse
Lists unmapped user identities for an identity source. Note: This API requires an admin account to execute.
248 249 250 251 252 253 254 255 256 257 258 259 260 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 248 def list_debug_identitysource_unmappedids(parent, debug_options_enable_debugging: nil, page_size: nil, page_token: nil, resolution_status_code: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/debug/{+parent}/unmappedids', ) command.response_representation = Google::Apis::CloudsearchV1::ListUnmappedIdentitiesResponse::Representation command.response_class = Google::Apis::CloudsearchV1::ListUnmappedIdentitiesResponse command.params['parent'] = parent unless parent.nil? command.query['debugOptions.enableDebugging'] = unless .nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['resolutionStatusCode'] = resolution_status_code unless resolution_status_code.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_indexing_datasource_items(name, brief: nil, connector_name: nil, debug_options_enable_debugging: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::ListItemsResponse
Lists all or a subset of Item resources. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.
603 604 605 606 607 608 609 610 611 612 613 614 615 616 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 603 def list_indexing_datasource_items(name, brief: nil, connector_name: nil, debug_options_enable_debugging: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/indexing/{+name}/items', ) command.response_representation = Google::Apis::CloudsearchV1::ListItemsResponse::Representation command.response_class = Google::Apis::CloudsearchV1::ListItemsResponse command.params['name'] = name unless name.nil? command.query['brief'] = brief unless brief.nil? command.query['connectorName'] = connector_name unless connector_name.nil? command.query['debugOptions.enableDebugging'] = unless .nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_query_sources(page_token: nil, request_options_debug_options_enable_debugging: nil, request_options_language_code: nil, request_options_search_application_id: nil, request_options_time_zone: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::ListQuerySourcesResponse
Returns list of sources that user can use for Search and Suggest APIs. Note: This API requires a standard end user account to execute.
999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 999 def list_query_sources(page_token: nil, request_options_debug_options_enable_debugging: nil, request_options_language_code: nil, request_options_search_application_id: nil, request_options_time_zone: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/query/sources', ) command.response_representation = Google::Apis::CloudsearchV1::ListQuerySourcesResponse::Representation command.response_class = Google::Apis::CloudsearchV1::ListQuerySourcesResponse command.query['pageToken'] = page_token unless page_token.nil? command.query['requestOptions.debugOptions.enableDebugging'] = unless .nil? command.query['requestOptions.languageCode'] = unless .nil? command.query['requestOptions.searchApplicationId'] = unless .nil? command.query['requestOptions.timeZone'] = unless .nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_setting_datasources(debug_options_enable_debugging: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::ListDataSourceResponse
Lists datasources. Note: This API requires an admin account to execute.
1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 1144 def list_setting_datasources(debug_options_enable_debugging: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/settings/datasources', ) command.response_representation = Google::Apis::CloudsearchV1::ListDataSourceResponse::Representation command.response_class = Google::Apis::CloudsearchV1::ListDataSourceResponse command.query['debugOptions.enableDebugging'] = unless .nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_setting_searchapplications(debug_options_enable_debugging: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::ListSearchApplicationsResponse
Lists all search applications. Note: This API requires an admin account to execute.
1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 1322 def list_setting_searchapplications(debug_options_enable_debugging: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/settings/searchapplications', ) command.response_representation = Google::Apis::CloudsearchV1::ListSearchApplicationsResponse::Representation command.response_class = Google::Apis::CloudsearchV1::ListSearchApplicationsResponse command.query['debugOptions.enableDebugging'] = unless .nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#poll_items(name, poll_items_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::PollItemsResponse
Polls for unreserved items from the indexing queue and marks a
set as reserved, starting with items that have
the oldest timestamp from the highest priority
ItemStatus.
The priority order is as follows:
ERROR
MODIFIED
NEW_ITEM
ACCEPTED
Reserving items ensures that polling from other threads
cannot create overlapping sets.
After handling the reserved items, the client should put items back
into the unreserved state, either by calling
index,
or by calling
push with
the type REQUEUE.
Items automatically become available (unreserved) after 4 hours even if no
update or push method is called.
This API requires an admin or service account to execute. The service
account used is the one whitelisted in the corresponding data source.
664 665 666 667 668 669 670 671 672 673 674 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 664 def poll_items(name, poll_items_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/indexing/{+name}/items:poll', ) command.request_representation = Google::Apis::CloudsearchV1::PollItemsRequest::Representation command.request_object = poll_items_request_object command.response_representation = Google::Apis::CloudsearchV1::PollItemsResponse::Representation command.response_class = Google::Apis::CloudsearchV1::PollItemsResponse command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#push_item(name, push_item_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::Item
Pushes an item onto a queue for later polling and updating. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.
703 704 705 706 707 708 709 710 711 712 713 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 703 def push_item(name, push_item_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/indexing/{+name}:push', ) command.request_representation = Google::Apis::CloudsearchV1::PushItemRequest::Representation command.request_object = push_item_request_object command.response_representation = Google::Apis::CloudsearchV1::Item::Representation command.response_class = Google::Apis::CloudsearchV1::Item command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#reset_searchapplication_search_application(name, reset_search_application_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::Operation
Resets a search application to default settings. This will return an empty response. Note: This API requires an admin account to execute.
1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 1358 def reset_searchapplication_search_application(name, reset_search_application_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/settings/{+name}:reset', ) command.request_representation = Google::Apis::CloudsearchV1::ResetSearchApplicationRequest::Representation command.request_object = reset_search_application_request_object command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation command.response_class = Google::Apis::CloudsearchV1::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#search_debug_datasource_item_by_view_url(name, search_items_by_view_url_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::SearchItemsByViewUrlResponse
Fetches the item whose viewUrl exactly matches that of the URL provided in the request. Note: This API requires an admin account to execute.
114 115 116 117 118 119 120 121 122 123 124 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 114 def search_debug_datasource_item_by_view_url(name, search_items_by_view_url_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/debug/{+name}/items:searchByViewUrl', ) command.request_representation = Google::Apis::CloudsearchV1::SearchItemsByViewUrlRequest::Representation command.request_object = search_items_by_view_url_request_object command.response_representation = Google::Apis::CloudsearchV1::SearchItemsByViewUrlResponse::Representation command.response_class = Google::Apis::CloudsearchV1::SearchItemsByViewUrlResponse command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#search_query(search_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::SearchResponse
The Cloud Search Query API provides the search method, which returns the most relevant results from a user query. The results can come from G Suite Apps, such as Gmail or Google Drive, or they can come from data that you have indexed from a third party. Note: This API requires a standard end user account to execute.
911 912 913 914 915 916 917 918 919 920 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 911 def search_query(search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/query/search', ) command.request_representation = Google::Apis::CloudsearchV1::SearchRequest::Representation command.request_object = search_request_object command.response_representation = Google::Apis::CloudsearchV1::SearchResponse::Representation command.response_class = Google::Apis::CloudsearchV1::SearchResponse command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#suggest_query(suggest_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::SuggestResponse
Provides suggestions for autocompleting the query. Note: This API requires a standard end user account to execute.
942 943 944 945 946 947 948 949 950 951 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 942 def suggest_query(suggest_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/query/suggest', ) command.request_representation = Google::Apis::CloudsearchV1::SuggestRequest::Representation command.request_object = suggest_request_object command.response_representation = Google::Apis::CloudsearchV1::SuggestResponse::Representation command.response_class = Google::Apis::CloudsearchV1::SuggestResponse command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#unreserve_items(name, unreserve_items_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::Operation
Unreserves all items from a queue, making them all eligible to be polled. This method is useful for resetting the indexing queue after a connector has been restarted. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.
741 742 743 744 745 746 747 748 749 750 751 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 741 def unreserve_items(name, unreserve_items_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/indexing/{+name}/items:unreserve', ) command.request_representation = Google::Apis::CloudsearchV1::UnreserveItemsRequest::Representation command.request_object = unreserve_items_request_object command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation command.response_class = Google::Apis::CloudsearchV1::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#update_datasource_data_source(name, update_data_source_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::Operation
Updates a datasource. Note: This API requires an admin account to execute.
1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 1180 def update_datasource_data_source(name, update_data_source_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v1/settings/{+name}', ) command.request_representation = Google::Apis::CloudsearchV1::UpdateDataSourceRequest::Representation command.request_object = update_data_source_request_object command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation command.response_class = Google::Apis::CloudsearchV1::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#update_datasource_schema(name, update_schema_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::Operation
Updates the schema of a data source. This method does not perform incremental updates to the schema. Instead, this method updates the schema by overwriting the entire schema. Note: This API requires an admin or service account to execute.
359 360 361 362 363 364 365 366 367 368 369 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 359 def update_datasource_schema(name, update_schema_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v1/indexing/{+name}/schema', ) command.request_representation = Google::Apis::CloudsearchV1::UpdateSchemaRequest::Representation command.request_object = update_schema_request_object command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation command.response_class = Google::Apis::CloudsearchV1::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#update_setting_searchapplication(name, search_application_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::Operation
Updates a search application. Note: This API requires an admin account to execute.
1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 1393 def update_setting_searchapplication(name, search_application_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v1/settings/{+name}', ) command.request_representation = Google::Apis::CloudsearchV1::SearchApplication::Representation command.request_object = search_application_object command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation command.response_class = Google::Apis::CloudsearchV1::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#upload_indexing_datasource_item(name, start_upload_item_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::UploadItemRef
Creates an upload session for uploading item content. For items smaller than 100 KB, it's easier to embed the content inline within an index request. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.
780 781 782 783 784 785 786 787 788 789 790 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 780 def upload_indexing_datasource_item(name, start_upload_item_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/indexing/{+name}:upload', ) command.request_representation = Google::Apis::CloudsearchV1::StartUploadItemRequest::Representation command.request_object = start_upload_item_request_object command.response_representation = Google::Apis::CloudsearchV1::UploadItemRef::Representation command.response_class = Google::Apis::CloudsearchV1::UploadItemRef command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#upload_medium(resource_name, media_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::Media
Uploads media for indexing. The upload endpoint supports direct and resumable upload protocols and is intended for large items that can not be inlined during index requests. To index large content:
- Call indexing.datasources.items.upload with the resource name to begin an upload session and retrieve the UploadItemRef.
- Call media.upload to upload the content using the same resource name from step 1.
- Call indexing.datasources.items.index to index the item. Populate the ItemContent with the UploadItemRef from step 1. For additional information, see Create a content connector using the REST API. Note: This API requires a service account to execute.
838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 |
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 838 def upload_medium(resource_name, media_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block) if upload_source.nil? command = make_simple_command(:post, 'v1/media/{+resourceName}', ) else command = make_upload_command(:post, 'v1/media/{+resourceName}', ) command.upload_source = upload_source command.upload_content_type = content_type end command.request_representation = Google::Apis::CloudsearchV1::Media::Representation command.request_object = media_object command.response_representation = Google::Apis::CloudsearchV1::Media::Representation command.response_class = Google::Apis::CloudsearchV1::Media command.params['resourceName'] = resource_name unless resource_name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |