Class: Ecfr::SearchService::ContentVersion::Count

Inherits:

Base

• Object
• Base
• Base
• Ecfr::SearchService::ContentVersion::Count

Defined in:

lib/ecfr/search_service/content_version/count.rb

Constant Summary

COUNT_PATH =

"v1/count"

Instance Attribute Summary

• #description ⇒ String readonly

  description of the search results.

• #total_count ⇒ Integer readonly

  total count of matching results.

Class Method Summary

• .find(args) ⇒ <Count>

  Retrieves count metadata about a search query.

Methods inherited from Base

base_url, service_name, service_path

Instance Attribute Details

#description ⇒ String (readonly)

description of the search results

Returns:

• (String)

# File 'lib/ecfr/search_service/content_version/count.rb', line 7

metadata :description,
desc: "description of the search results"

#total_count ⇒ Integer (readonly)

total count of matching results

Returns:

• (Integer)

# File 'lib/ecfr/search_service/content_version/count.rb', line 10

metadata :total_count,
type: :integer,
desc: "total count of matching results"

Class Method Details

.find(args) ⇒ <Count>

Retrieves count metadata about a search query

Parameters:

• args (<Hash>) —

  see: Result.find

Returns:

• (<Count>) —

  search query count metadata

# File 'lib/ecfr/search_service/content_version/count.rb', line 23

def self.find(args)
  perform(
    :get,
    COUNT_PATH,
    params: args
  )
end