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

Inherits:
Google::Apis::Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/cloudsearch_v1/service.rb

Overview

Cloud Search API

Cloud Search provides cloud-based search capabilities over Google Workspace data. The Cloud Search API allows indexing of non-Google Workspace 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

Instance Method Summary collapse

Constructor Details

#initialize ⇒ CloudSearchService

Returns a new instance of CloudSearchService.



47
48
49
50
51
52
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 47

def initialize
  super('https://cloudsearch.googleapis.com/', '',
        client_name: 'google-apis-cloudsearch_v1',
        client_version: Google::Apis::CloudsearchV1::GEM_VERSION)
  @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.



40
41
42
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 40

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.



45
46
47
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 45

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. Principal must be a user; groups and domain values aren't supported. Note: This API requires an admin account to execute.

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) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 80

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. Note: This API requires an admin account to execute.

Parameters:

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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. Note: This API requires an admin account to execute.

Parameters:

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 1262

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. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.

Parameters:

  • name (String) —

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

  • connector_name (String) (defaults to: nil) —

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

  • debug_options_enable_debugging (Boolean) (defaults to: nil) —

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

  • mode (String) (defaults to: nil) —

    Required. The RequestMode for this request.

  • version (String) (defaults to: nil) —

    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. For information on how item version affects the deletion process, refer to Handle revisions after manual deletes.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 407

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. Note: This API requires an admin or service account to execute.

Parameters:

  • name (String) —

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

  • debug_options_enable_debugging (Boolean) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



284
285
286
287
288
289
290
291
292
293
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 284

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. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.

Parameters:

  • name (String) —

    The 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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 445

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. Note: This API requires an admin account to execute.

Parameters:

  • name (String) —

    The name of the datasource. Format: datasources/source_id.

  • debug_options_enable_debugging (Boolean) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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. Note: This API requires an admin account to execute.

Parameters:

  • name (String) —

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

  • debug_options_enable_debugging (Boolean) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.

Parameters:

  • name (String) —

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

  • connector_name (String) (defaults to: nil) —

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

  • debug_options_enable_debugging (Boolean) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



486
487
488
489
490
491
492
493
494
495
496
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 486

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. Note: This API requires an admin or service account to execute.

Parameters:

  • name (String) —

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

  • debug_options_enable_debugging (Boolean) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



319
320
321
322
323
324
325
326
327
328
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 319

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



821
822
823
824
825
826
827
828
829
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 821

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_customer(fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::CustomerSettings

Get customer settings. Note: This API requires an admin account to execute.

Parameters:

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1026
1027
1028
1029
1030
1031
1032
1033
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 1026

def get_setting_customer(fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/settings/customer', options)
  command.response_representation = Google::Apis::CloudsearchV1::CustomerSettings::Representation
  command.response_class = Google::Apis::CloudsearchV1::CustomerSettings
  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.

Parameters:

  • name (String) —

    The name of the datasource resource. Format: datasources/source_id.

  • debug_options_enable_debugging (Boolean) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 1159

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. Note: This API requires an admin account to execute.

Parameters:

  • name (String) —

    The name of the search application. Format: searchapplications/application_id .

  • debug_options_enable_debugging (Boolean) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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. Note: This API requires a standard end user account to execute.

Parameters:

  • from_date_day (Fixnum) (defaults to: nil) —

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

  • from_date_month (Fixnum) (defaults to: nil) —

    Month of date. Must be from 1 to 12.

  • from_date_year (Fixnum) (defaults to: nil) —

    Year of date. Must be from 1 to 9999.

  • to_date_day (Fixnum) (defaults to: nil) —

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

  • to_date_month (Fixnum) (defaults to: nil) —

    Month of date. Must be from 1 to 12.

  • to_date_year (Fixnum) (defaults to: nil) —

    Year of date. Must be from 1 to 9999.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 1487

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. Note: This API requires a standard end user account to execute.

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) (defaults to: nil) —

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

  • from_date_month (Fixnum) (defaults to: nil) —

    Month of date. Must be from 1 to 12.

  • from_date_year (Fixnum) (defaults to: nil) —

    Year of date. Must be from 1 to 9999.

  • to_date_day (Fixnum) (defaults to: nil) —

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

  • to_date_month (Fixnum) (defaults to: nil) —

    Month of date. Must be from 1 to 12.

  • to_date_year (Fixnum) (defaults to: nil) —

    Year of date. Must be from 1 to 9999.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 1721

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

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

Parameters:

  • from_date_day (Fixnum) (defaults to: nil) —

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

  • from_date_month (Fixnum) (defaults to: nil) —

    Month of date. Must be from 1 to 12.

  • from_date_year (Fixnum) (defaults to: nil) —

    Year of date. Must be from 1 to 9999.

  • to_date_day (Fixnum) (defaults to: nil) —

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

  • to_date_month (Fixnum) (defaults to: nil) —

    Month of date. Must be from 1 to 12.

  • to_date_year (Fixnum) (defaults to: nil) —

    Year of date. Must be from 1 to 9999.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 1533

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

Parameters:

  • name (String) —

    The resource id of the search application query stats, in the following format: searchapplications/application_id

  • from_date_day (Fixnum) (defaults to: nil) —

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

  • from_date_month (Fixnum) (defaults to: nil) —

    Month of date. Must be from 1 to 12.

  • from_date_year (Fixnum) (defaults to: nil) —

    Year of date. Must be from 1 to 9999.

  • to_date_day (Fixnum) (defaults to: nil) —

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

  • to_date_month (Fixnum) (defaults to: nil) —

    Month of date. Must be from 1 to 12.

  • to_date_year (Fixnum) (defaults to: nil) —

    Year of date. Must be from 1 to 9999.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 1771

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}', options)
  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_searchapplication(end_date_day: nil, end_date_month: nil, end_date_year: nil, start_date_day: nil, start_date_month: nil, start_date_year: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::GetCustomerSearchApplicationStatsResponse

Get search application stats for customer. Note: This API requires a standard end user account to execute.

Parameters:

  • end_date_day (Fixnum) (defaults to: nil) —

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

  • end_date_month (Fixnum) (defaults to: nil) —

    Month of date. Must be from 1 to 12.

  • end_date_year (Fixnum) (defaults to: nil) —

    Year of date. Must be from 1 to 9999.

  • start_date_day (Fixnum) (defaults to: nil) —

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

  • start_date_month (Fixnum) (defaults to: nil) —

    Month of date. Must be from 1 to 12.

  • start_date_year (Fixnum) (defaults to: nil) —

    Year of date. Must be from 1 to 9999.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 1579

def get_stat_searchapplication(end_date_day: nil, end_date_month: nil, end_date_year: nil, start_date_day: nil, start_date_month: nil, start_date_year: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/stats/searchapplication', options)
  command.response_representation = Google::Apis::CloudsearchV1::GetCustomerSearchApplicationStatsResponse::Representation
  command.response_class = Google::Apis::CloudsearchV1::GetCustomerSearchApplicationStatsResponse
  command.query['endDate.day'] = end_date_day unless end_date_day.nil?
  command.query['endDate.month'] = end_date_month unless end_date_month.nil?
  command.query['endDate.year'] = end_date_year unless end_date_year.nil?
  command.query['startDate.day'] = start_date_day unless start_date_day.nil?
  command.query['startDate.month'] = start_date_month unless start_date_month.nil?
  command.query['startDate.year'] = start_date_year unless start_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.

Parameters:

  • from_date_day (Fixnum) (defaults to: nil) —

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

  • from_date_month (Fixnum) (defaults to: nil) —

    Month of date. Must be from 1 to 12.

  • from_date_year (Fixnum) (defaults to: nil) —

    Year of date. Must be from 1 to 9999.

  • to_date_day (Fixnum) (defaults to: nil) —

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

  • to_date_month (Fixnum) (defaults to: nil) —

    Month of date. Must be from 1 to 12.

  • to_date_year (Fixnum) (defaults to: nil) —

    Year of date. Must be from 1 to 9999.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 1626

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

Parameters:

  • name (String) —

    The resource id of the search application session stats, in the following format: searchapplications/application_id

  • from_date_day (Fixnum) (defaults to: nil) —

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

  • from_date_month (Fixnum) (defaults to: nil) —

    Month of date. Must be from 1 to 12.

  • from_date_year (Fixnum) (defaults to: nil) —

    Year of date. Must be from 1 to 9999.

  • to_date_day (Fixnum) (defaults to: nil) —

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

  • to_date_month (Fixnum) (defaults to: nil) —

    Month of date. Must be from 1 to 12.

  • to_date_year (Fixnum) (defaults to: nil) —

    Year of date. Must be from 1 to 9999.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 1822

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

Parameters:

  • from_date_day (Fixnum) (defaults to: nil) —

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

  • from_date_month (Fixnum) (defaults to: nil) —

    Month of date. Must be from 1 to 12.

  • from_date_year (Fixnum) (defaults to: nil) —

    Year of date. Must be from 1 to 9999.

  • to_date_day (Fixnum) (defaults to: nil) —

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

  • to_date_month (Fixnum) (defaults to: nil) —

    Month of date. Must be from 1 to 12.

  • to_date_year (Fixnum) (defaults to: nil) —

    Year of date. Must be from 1 to 9999.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 1672

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

Parameters:

  • name (String) —

    The resource id of the search application session stats, in the following format: searchapplications/application_id

  • from_date_day (Fixnum) (defaults to: nil) —

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

  • from_date_month (Fixnum) (defaults to: nil) —

    Month of date. Must be from 1 to 12.

  • from_date_year (Fixnum) (defaults to: nil) —

    Year of date. Must be from 1 to 9999.

  • to_date_day (Fixnum) (defaults to: nil) —

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

  • to_date_month (Fixnum) (defaults to: nil) —

    Month of date. Must be from 1 to 12.

  • to_date_year (Fixnum) (defaults to: nil) —

    Year of date. Must be from 1 to 9999.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 1872

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

Parameters:

  • name (String) —

    The 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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



524
525
526
527
528
529
530
531
532
533
534
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 524

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

#initialize_customer(initialize_customer_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::Operation

Enables third party support in Google Cloud Search. Note: This API requires an admin account to execute.

Parameters:

  • initialize_customer_request_object (Google::Apis::CloudsearchV1::InitializeCustomerRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 1908

def initialize_customer(initialize_customer_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1:initializeCustomer', options)
  command.request_representation = Google::Apis::CloudsearchV1::InitializeCustomerRequest::Representation
  command.request_object = initialize_customer_request_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

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

Parameters:

  • parent (String) —

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

  • debug_options_enable_debugging (Boolean) (defaults to: nil) —

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

  • page_size (Fixnum) (defaults to: nil) —

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

  • page_token (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/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', 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. Note: This API requires an admin account to execute.

Parameters:

  • parent (String) —

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

  • debug_options_enable_debugging (Boolean) (defaults to: nil) —

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

  • group_resource_name (String) (defaults to: nil)
  • page_size (Fixnum) (defaults to: nil) —

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

  • page_token (String) (defaults to: nil) —

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

  • user_resource_name (String) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 200

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. Note: This API requires an admin account to execute.

Parameters:

  • parent (String) —

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

  • debug_options_enable_debugging (Boolean) (defaults to: nil) —

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

  • page_size (Fixnum) (defaults to: nil) —

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

  • page_token (String) (defaults to: nil) —

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

  • resolution_status_code (String) (defaults to: nil) —

    Limit users selection to this status.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 246

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. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.

Parameters:

  • name (String) —

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

  • brief (Boolean) (defaults to: nil) —

    When set to true, the indexing system only populates the following fields: name, version, queue. metadata.hash, metadata.title, metadata. sourceRepositoryURL, metadata.objectType, metadata.createTime, metadata. updateTime, metadata.contentLanguage, metadata.mimeType, structured_data.hash, content.hash, itemType, itemStatus.code, itemStatus.processingError.code, itemStatus.repositoryError.type, If this value is false, then all the fields are populated in Item.

  • connector_name (String) (defaults to: nil) —

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

  • debug_options_enable_debugging (Boolean) (defaults to: nil) —

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

  • page_size (Fixnum) (defaults to: nil) —

    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) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



577
578
579
580
581
582
583
584
585
586
587
588
589
590
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 577

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_operation_lros(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::ListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/name=users/*/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil) —

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil) —

    The standard list page size.

  • page_token (String) (defaults to: nil) —

    The standard list page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



864
865
866
867
868
869
870
871
872
873
874
875
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 864

def list_operation_lros(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/lro', options)
  command.response_representation = Google::Apis::CloudsearchV1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::CloudsearchV1::ListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.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:

Parameters:

  • page_token (String) (defaults to: nil) —

    Number of sources to return in the response.

  • request_options_debug_options_enable_debugging (Boolean) (defaults to: nil) —

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

  • request_options_language_code (String) (defaults to: nil) —

    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. Set this field using the language set in browser or for the page. In the event that the user's language preference is known, set this field to the known user language. When specified, the documents in search results are biased towards the specified language. The suggest API does not use this parameter. Instead, suggest autocompletes only based on characters in the query.

  • request_options_search_application_id (String) (defaults to: nil) —

    The ID generated when you create a search application using the admin console.

  • request_options_time_zone (String) (defaults to: nil) —

    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. This field is used to correctly interpret date and time queries. If this field is not specified, the default time zone (UTC) is used.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 994

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. Note: This API requires an admin account to execute.

Parameters:

  • debug_options_enable_debugging (Boolean) (defaults to: nil) —

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

  • page_size (Fixnum) (defaults to: nil) —

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

  • page_token (String) (defaults to: nil) —

    Starting index of the results.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 1196

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. Note: This API requires an admin account to execute.

Parameters:

  • debug_options_enable_debugging (Boolean) (defaults to: nil) —

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

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of items to return.

  • page_token (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 1372

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. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.

Parameters:

  • name (String) —

    The 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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



622
623
624
625
626
627
628
629
630
631
632
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 622

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. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.

Parameters:

  • name (String) —

    The 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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



659
660
661
662
663
664
665
666
667
668
669
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 659

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. Note: This API requires an admin account to execute.

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 1407

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. Note: This API requires an admin account to execute.

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 115

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 Google Workspace 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. A service account can't perform Query API requests directly; to use a service account to perform queries, set up Google Workspace domain-wide delegation of authority.

Parameters:

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



903
904
905
906
907
908
909
910
911
912
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 903

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. Note: This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up Google Workspace domain-wide delegation of authority.

Parameters:

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



937
938
939
940
941
942
943
944
945
946
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 937

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. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.

Parameters:

  • name (String) —

    The 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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



696
697
698
699
700
701
702
703
704
705
706
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 696

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. Note: This API requires an admin account to execute.

Parameters:

  • name (String) —

    The 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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 1230

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

Parameters:

  • name (String) —

    The 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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 354

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_customer(customer_settings_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsearchV1::Operation

Update customer settings. Note: This API requires an admin account to execute.

Parameters:

  • customer_settings_object (Google::Apis::CloudsearchV1::CustomerSettings) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Update mask to control which fields get updated. If you specify a field in the update_mask but don't specify its value here, that field will be cleared. If the mask is not present or empty, all fields will be updated. Currently supported field paths: vpc_settings and audit_logging_settings

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 1060

def update_setting_customer(customer_settings_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/settings/customer', options)
  command.request_representation = Google::Apis::CloudsearchV1::CustomerSettings::Representation
  command.request_object = customer_settings_object
  command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation
  command.response_class = Google::Apis::CloudsearchV1::Operation
  command.query['updateMask'] = update_mask unless update_mask.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.

Parameters:

  • name (String) —

    The name of the Search Application. Format: searchapplications/application_id .

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 1442

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. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.

Parameters:

  • name (String) —

    The name of the Item to start a resumable upload. Format: datasources/ source_id/items/item_id. The maximum length is 1536 bytes.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



733
734
735
736
737
738
739
740
741
742
743
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 733

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 item name to begin an upload session and retrieve the UploadItemRef. 1. Call media.upload to upload the content, as a streaming request, using the same resource name from the UploadItemRef from step 1. 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.

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    IO stream or filename containing content to upload

  • content_type (String) (defaults to: nil) —

    Content type of the uploaded content.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
 
# File 'lib/google/apis/cloudsearch_v1/service.rb', line 782

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