Class: Google::Apis::CloudsearchV1::CloudSearchService

Inherits:
Google::Apis::Core::BaseService show all
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.

Examples:

require 'google/apis/cloudsearch_v1'

Cloudsearch = Google::Apis::CloudsearchV1 # Alias the module
service = Cloudsearch::CloudSearchService.new

See Also:

Instance Attribute Summary collapse

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

Methods inherited from Google::Apis::Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Google::Apis::Core::Logging

#logger

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.

Returns:

  • (String) —

    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.

Returns:

  • (String) —

    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.

Parameters:

  • name (String) —

    Item name, format: datasources/source_id/items/item_id

  • principal_object (Google::Apis::CloudsearchV1::Principal) (defaults to: nil)
  • debug_options_enable_debugging (Boolean) —

    If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 76

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', options)
  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'] = debug_options_enable_debugging unless debug_options_enable_debugging.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.

Parameters:

  • data_source_object (Google::Apis::CloudsearchV1::DataSource) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



983
984
985
986
987
988
989
990
991
992
 
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 983

def create_setting_datasource(data_source_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/settings/datasources', options)
  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.

Parameters:

  • search_application_object (Google::Apis::CloudsearchV1::SearchApplication) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
 
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 1157

def create_setting_searchapplication(search_application_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/settings/searchapplications', options)
  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.

Parameters:

  • name (String) —

    Required. Name of the item to delete. Format: datasources/source_id/items/item_id

  • connector_name (String) —

    Name of connector making this call.
    Format: datasources/source_id/connectors/ID

  • debug_options_enable_debugging (Boolean) —

    If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.

  • mode (String) —

    Required. The RequestMode for this request.

  • version (String) —

    Required. The incremented version of the item to delete from the index. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering.

    Cloud Search Indexing won't delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 401

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}', options)
  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'] = debug_options_enable_debugging unless debug_options_enable_debugging.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.

Parameters:

  • name (String) —

    Name of the data source to delete Schema. Format: datasources/source_id

  • debug_options_enable_debugging (Boolean) —

    If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



281
282
283
284
285
286
287
288
289
290
 
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 281

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', options)
  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'] = debug_options_enable_debugging unless debug_options_enable_debugging.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.

Parameters:

  • name (String) —

    Name of the Data Source to delete items in a queue. Format: datasources/source_id

  • delete_queue_items_request_object (Google::Apis::CloudsearchV1::DeleteQueueItemsRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



438
439
440
441
442
443
444
445
446
447
448
 
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 438

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', options)
  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.

Parameters:

  • name (String) —

    Name of the datasource. Format: datasources/source_id.

  • debug_options_enable_debugging (Boolean) —

    If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
 
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 1018

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}', options)
  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'] = debug_options_enable_debugging unless debug_options_enable_debugging.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.

Parameters:

  • name (String) —

    The name of the search application to be deleted.
    Format: applications/application_id.

  • debug_options_enable_debugging (Boolean) —

    If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
 
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 1192

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}', options)
  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'] = debug_options_enable_debugging unless debug_options_enable_debugging.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.

Parameters:

  • name (String) —

    Name of the item to get info. Format: datasources/source_id/items/item_id

  • connector_name (String) —

    Name of connector making this call.
    Format: datasources/source_id/connectors/ID

  • debug_options_enable_debugging (Boolean) —

    If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



477
478
479
480
481
482
483
484
485
486
487
 
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 477

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}', options)
  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'] = debug_options_enable_debugging unless debug_options_enable_debugging.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.

Parameters:

  • name (String) —

    Name of the data source to get Schema. Format: datasources/source_id

  • debug_options_enable_debugging (Boolean) —

    If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



316
317
318
319
320
321
322
323
324
325
 
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 316

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', options)
  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'] = debug_options_enable_debugging unless debug_options_enable_debugging.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.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



837
838
839
840
841
842
843
844
845
 
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 837

def get_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  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.

Parameters:

  • name (String) —

    Name of the datasource resource. Format: datasources/source_id.

  • debug_options_enable_debugging (Boolean) —

    If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
 
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 1053

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}', options)
  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'] = debug_options_enable_debugging unless debug_options_enable_debugging.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.

Parameters:

  • name (String) —

    Name of the search application.
    Format: applications/application_id.

  • debug_options_enable_debugging (Boolean) —

    If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
 
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 1227

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}', options)
  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'] = debug_options_enable_debugging unless debug_options_enable_debugging.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.

Parameters:

  • from_date_day (Fixnum) —

    Day of month. Must be from 1 to 31 and valid for the year and month.

  • from_date_month (Fixnum) —

    Month of date. Must be from 1 to 12.

  • from_date_year (Fixnum) —

    Year of date. Must be from 1 to 9999.

  • to_date_day (Fixnum) —

    Day of month. Must be from 1 to 31 and valid for the year and month.

  • to_date_month (Fixnum) —

    Month of date. Must be from 1 to 12.

  • to_date_year (Fixnum) —

    Year of date. Must be from 1 to 9999.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
 
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 1377

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', options)
  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.

Parameters:

  • name (String) —

    The resource id of the data source to retrieve statistics for, in the following format: "datasources/source_id"

  • from_date_day (Fixnum) —

    Day of month. Must be from 1 to 31 and valid for the year and month.

  • from_date_month (Fixnum) —

    Month of date. Must be from 1 to 12.

  • from_date_year (Fixnum) —

    Year of date. Must be from 1 to 9999.

  • to_date_day (Fixnum) —

    Day of month. Must be from 1 to 31 and valid for the year and month.

  • to_date_month (Fixnum) —

    Month of date. Must be from 1 to 12.

  • to_date_year (Fixnum) —

    Year of date. Must be from 1 to 9999.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
 
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 1425

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}', options)
  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

#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.

Parameters:

  • name (String) —

    Name of the Item. Format: datasources/source_id/items/item_id
    This is a required field. The maximum length is 1536 characters.

  • index_item_request_object (Google::Apis::CloudsearchV1::IndexItemRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



517
518
519
520
521
522
523
524
525
526
527
 
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 517

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', options)
  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.

Parameters:

  • parent (String) —

    The name of the item, in the following format: datasources/source_id/items/ID

  • debug_options_enable_debugging (Boolean) —

    If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.

  • page_size (Fixnum) —

    Maximum number of items to fetch in a request. Defaults to 100.

  • page_token (String) —

    The next_page_token value returned from a previous List request, if any.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 153

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', options)
  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'] = debug_options_enable_debugging unless debug_options_enable_debugging.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.

Parameters:

  • parent (String) —

    The name of the identity source, in the following format: identitysources/source_id`

  • debug_options_enable_debugging (Boolean) —

    If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.

  • group_resource_name (String)
  • page_size (Fixnum) —

    Maximum number of items to fetch in a request. Defaults to 100.

  • page_token (String) —

    The next_page_token value returned from a previous List request, if any.

  • user_resource_name (String)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 197

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', options)
  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'] = debug_options_enable_debugging unless debug_options_enable_debugging.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.

Parameters:

  • parent (String) —

    The name of the identity source, in the following format: identitysources/source_id

  • debug_options_enable_debugging (Boolean) —

    If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.

  • page_size (Fixnum) —

    Maximum number of items to fetch in a request. Defaults to 100.

  • page_token (String) —

    The next_page_token value returned from a previous List request, if any.

  • resolution_status_code (String) —

    Limit users selection to this status.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 243

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', options)
  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'] = debug_options_enable_debugging unless debug_options_enable_debugging.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.

Parameters:

  • name (String) —

    Name of the Data Source to list Items. Format: datasources/source_id

  • brief (Boolean) —

    When set to true, the indexing system only populates the following fields: name, version, metadata.hash, structured_data.hash, content.hash.
    If this value is false, then all the fields are populated in Item.

  • connector_name (String) —

    Name of connector making this call.
    Format: datasources/source_id/connectors/ID

  • debug_options_enable_debugging (Boolean) —

    If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.

  • page_size (Fixnum) —

    Maximum number of items to fetch in a request. The max value is 1000 when brief is true. The max value is 10 if brief is false.
    The default value is 10

  • page_token (String) —

    The next_page_token value returned from a previous List request, if any.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



571
572
573
574
575
576
577
578
579
580
581
582
583
584
 
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 571

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', options)
  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'] = debug_options_enable_debugging unless debug_options_enable_debugging.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.

Parameters:

  • page_token (String) —

    Number of sources to return in the response.

  • request_options_debug_options_enable_debugging (Boolean) —

    If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.

  • request_options_language_code (String) —

    The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. When specified, the documents in search results are biased towards the specified language. Suggest API does not use this parameter. It autocompletes only based on characters in the query.

  • request_options_search_application_id (String) —

    Id of the application created using SearchApplicationsService.

  • request_options_time_zone (String) —

    Current user's time zone id, such as "America/Los_Angeles" or "Australia/Sydney". These IDs are defined by Unicode Common Locale Data Repository (CLDR) project, and currently available in the file timezone.xml

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



950
951
952
953
954
955
956
957
958
959
960
961
962
 
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 950

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', options)
  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'] = request_options_debug_options_enable_debugging unless request_options_debug_options_enable_debugging.nil?
  command.query['requestOptions.languageCode'] = request_options_language_code unless request_options_language_code.nil?
  command.query['requestOptions.searchApplicationId'] = request_options_search_application_id unless request_options_search_application_id.nil?
  command.query['requestOptions.timeZone'] = request_options_time_zone unless request_options_time_zone.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.

Parameters:

  • debug_options_enable_debugging (Boolean) —

    If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.

  • page_size (Fixnum) —

    Maximum number of datasources to fetch in a request. The max value is 100.
    The default value is 10

  • page_token (String) —

    Starting index of the results.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
 
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 1091

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', options)
  command.response_representation = Google::Apis::CloudsearchV1::ListDataSourceResponse::Representation
  command.response_class = Google::Apis::CloudsearchV1::ListDataSourceResponse
  command.query['debugOptions.enableDebugging'] = debug_options_enable_debugging unless debug_options_enable_debugging.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.

Parameters:

  • debug_options_enable_debugging (Boolean) —

    If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.

  • page_size (Fixnum) —

    The maximum number of items to return.

  • page_token (String) —

    The next_page_token value returned from a previous List request, if any.
    The default value is 10

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
 
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 1264

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', options)
  command.response_representation = Google::Apis::CloudsearchV1::ListSearchApplicationsResponse::Representation
  command.response_class = Google::Apis::CloudsearchV1::ListSearchApplicationsResponse
  command.query['debugOptions.enableDebugging'] = debug_options_enable_debugging unless debug_options_enable_debugging.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.

Parameters:

  • name (String) —

    Name of the Data Source to poll items. Format: datasources/source_id

  • poll_items_request_object (Google::Apis::CloudsearchV1::PollItemsRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



630
631
632
633
634
635
636
637
638
639
640
 
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 630

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', options)
  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.

Parameters:

  • name (String) —

    Name of the item to push into the indexing queue.
    Format: datasources/source_id/items/ID
    This is a required field. The maximum length is 1536 characters.

  • push_item_request_object (Google::Apis::CloudsearchV1::PushItemRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



667
668
669
670
671
672
673
674
675
676
677
 
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 667

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', options)
  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.

Parameters:

  • name (String) —

    The name of the search application to be reset.
    Format: applications/application_id.

  • reset_search_application_request_object (Google::Apis::CloudsearchV1::ResetSearchApplicationRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
 
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 1299

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', options)
  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.

Parameters:

  • name (String) —

    Source name, format: datasources/source_id

  • search_items_by_view_url_request_object (Google::Apis::CloudsearchV1::SearchItemsByViewUrlRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



112
113
114
115
116
117
118
119
120
121
122
 
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 112

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', options)
  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.

Parameters:

  • search_request_object (Google::Apis::CloudsearchV1::SearchRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



869
870
871
872
873
874
875
876
877
878
 
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 869

def search_query(search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/query/search', options)
  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.

Parameters:

  • suggest_request_object (Google::Apis::CloudsearchV1::SuggestRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



899
900
901
902
903
904
905
906
907
908
 
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 899

def suggest_query(suggest_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/query/suggest', options)
  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.

Parameters:

  • name (String) —

    Name of the Data Source to unreserve all items. Format: datasources/source_id

  • unreserve_items_request_object (Google::Apis::CloudsearchV1::UnreserveItemsRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



703
704
705
706
707
708
709
710
711
712
713
 
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 703

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', options)
  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.

Parameters:

  • name (String) —

    Name of the datasource resource. Format: datasources/source_id.
    The name is ignored when creating a datasource.

  • update_data_source_request_object (Google::Apis::CloudsearchV1::UpdateDataSourceRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
 
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 1126

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}', options)
  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.

Parameters:

  • name (String) —

    Name of the data source to update Schema. Format: datasources/source_id

  • update_schema_request_object (Google::Apis::CloudsearchV1::UpdateSchemaRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



349
350
351
352
353
354
355
356
357
358
359
 
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 349

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', options)
  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.

Parameters:

  • name (String) —

    Name of the Search Application.
    Format: searchapplications/application_id.

  • search_application_object (Google::Apis::CloudsearchV1::SearchApplication) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
 
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 1333

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}', options)
  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.

Parameters:

  • name (String) —

    Name of the Item to start a resumable upload. Format: datasources/source_id/items/item_id.

  • start_upload_item_request_object (Google::Apis::CloudsearchV1::StartUploadItemRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



740
741
742
743
744
745
746
747
748
749
750
 
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 740

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', options)
  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:

  1. Call indexing.datasources.items.upload with the resource name to begin an upload session and retrieve the UploadItemRef.
  2. Call media.upload to upload the content using the same resource name from step 1.
  3. 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.

Parameters:

  • resource_name (String) —

    Name of the media that is being downloaded. See ReadRequest.resource_name.

  • media_object (Google::Apis::CloudsearchV1::Media) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • upload_source (IO, String) —

    IO stream or filename containing content to upload

  • content_type (String) —

    Content type of the uploaded content.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
 
# File 'generated/google/apis/cloudsearch_v1/service.rb', line 797

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}', options)
  else
    command = make_upload_command(:post, 'v1/media/{+resourceName}', options)
    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