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

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

Overview

Metadata about a search operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ SearchInformation

Returns a new instance of SearchInformation.



1538
1539
1540
# File 'generated/google/apis/customsearch_v1/classes.rb', line 1538

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

Instance Attribute Details

#formatted_search_timeString

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

Returns:

  • (String)


1521
1522
1523
# File 'generated/google/apis/customsearch_v1/classes.rb', line 1521

def formatted_search_time
  @formatted_search_time
end

#formatted_total_resultsString

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

Returns:

  • (String)


1526
1527
1528
# File 'generated/google/apis/customsearch_v1/classes.rb', line 1526

def formatted_total_results
  @formatted_total_results
end

#search_timeFloat

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

Returns:

  • (Float)


1531
1532
1533
# File 'generated/google/apis/customsearch_v1/classes.rb', line 1531

def search_time
  @search_time
end

#total_resultsString

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

Returns:

  • (String)


1536
1537
1538
# File 'generated/google/apis/customsearch_v1/classes.rb', line 1536

def total_results
  @total_results
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1543
1544
1545
1546
1547
1548
# File 'generated/google/apis/customsearch_v1/classes.rb', line 1543

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