Class: Google::Apis::CustomsearchV1::Search::SearchInformation

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/customsearch_v1/classes.rb,
lib/google/apis/customsearch_v1/representations.rb,
lib/google/apis/customsearch_v1/representations.rb

Overview

Metadata about a search operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ SearchInformation

Returns a new instance of SearchInformation.



1358
1359
1360
 
# File 'lib/google/apis/customsearch_v1/classes.rb', line 1358

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#formatted_search_time ⇒ String

The time taken for the server to return search results, formatted according to locale style. Corresponds to the JSON property formattedSearchTime

Returns:

  • (String) 


1341
1342
1343
 
# File 'lib/google/apis/customsearch_v1/classes.rb', line 1341

def formatted_search_time
  @formatted_search_time
end

#formatted_total_results ⇒ String

The total number of search results, formatted according to locale style. Corresponds to the JSON property formattedTotalResults

Returns:

  • (String) 


1346
1347
1348
 
# File 'lib/google/apis/customsearch_v1/classes.rb', line 1346

def formatted_total_results
  @formatted_total_results
end

#search_time ⇒ Float

The time taken for the server to return search results. Corresponds to the JSON property searchTime

Returns:

  • (Float) 


1351
1352
1353
 
# File 'lib/google/apis/customsearch_v1/classes.rb', line 1351

def search_time
  @search_time
end

#total_results ⇒ String

The total number of search results returned by the query. Corresponds to the JSON property totalResults

Returns:

  • (String) 


1356
1357
1358
 
# File 'lib/google/apis/customsearch_v1/classes.rb', line 1356

def total_results
  @total_results
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1363
1364
1365
1366
1367
1368
 
# File 'lib/google/apis/customsearch_v1/classes.rb', line 1363

def update!(**args)
  @formatted_search_time = args[:formatted_search_time] if args.key?(:formatted_search_time)
  @formatted_total_results = args[:formatted_total_results] if args.key?(:formatted_total_results)
  @search_time = args[:search_time] if args.key?(:search_time)
  @total_results = args[:total_results] if args.key?(:total_results)
end