Class: Inttegro::Search::Page

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/search/page.rb

Overview

Typed representation of the page object in the Inttegro API.

This generated model is immutable. Construct it with .new, or decode a string-keyed API payload with .from_hash. #serialize produces a string-keyed hash using the original wire field names and serialized enum values.

Instance Attribute Summary collapse

Instance Attribute Details

#facets ⇒ Array<Inttegro::Search::FacetResult> (readonly)

Value of the facets field in the Inttegro API payload.

Required in the API payload. Wire name: facets.

Returns:



90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/inttegro/search/page.rb', line 90

class Page < T::Struct
  const :resource_types, T::Array[Inttegro::Search::Type]
  const :sort, Inttegro::Search::Sort
  const :page_size, Integer
  const :result_count, Integer
  const :has_more, T::Boolean
  const :total, Inttegro::Search::Total
  const :resource_totals, T::Array[Inttegro::Search::ResourceTotal]
  const :results, T::Array[Inttegro::Search::Result]
  const :facets, T::Array[Inttegro::Search::FacetResult]
  const :next_cursor, T.nilable(String), default: nil
  const :freshness, Inttegro::Search::Freshness
end

#freshness ⇒ Inttegro::Search::Freshness (readonly)

Value of the freshness field in the Inttegro API payload.

Required in the API payload. Wire name: freshness.

Returns:



90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/inttegro/search/page.rb', line 90

class Page < T::Struct
  const :resource_types, T::Array[Inttegro::Search::Type]
  const :sort, Inttegro::Search::Sort
  const :page_size, Integer
  const :result_count, Integer
  const :has_more, T::Boolean
  const :total, Inttegro::Search::Total
  const :resource_totals, T::Array[Inttegro::Search::ResourceTotal]
  const :results, T::Array[Inttegro::Search::Result]
  const :facets, T::Array[Inttegro::Search::FacetResult]
  const :next_cursor, T.nilable(String), default: nil
  const :freshness, Inttegro::Search::Freshness
end

#has_more ⇒ Boolean (readonly)

Value of the has_more field in the Inttegro API payload.

Required in the API payload. Wire name: has_more.

Returns:

  • (Boolean) 


90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/inttegro/search/page.rb', line 90

class Page < T::Struct
  const :resource_types, T::Array[Inttegro::Search::Type]
  const :sort, Inttegro::Search::Sort
  const :page_size, Integer
  const :result_count, Integer
  const :has_more, T::Boolean
  const :total, Inttegro::Search::Total
  const :resource_totals, T::Array[Inttegro::Search::ResourceTotal]
  const :results, T::Array[Inttegro::Search::Result]
  const :facets, T::Array[Inttegro::Search::FacetResult]
  const :next_cursor, T.nilable(String), default: nil
  const :freshness, Inttegro::Search::Freshness
end

#next_cursor ⇒ String? (readonly)

Value of the next_cursor field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: next_cursor.

Returns:

  • (String, nil) 


90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/inttegro/search/page.rb', line 90

class Page < T::Struct
  const :resource_types, T::Array[Inttegro::Search::Type]
  const :sort, Inttegro::Search::Sort
  const :page_size, Integer
  const :result_count, Integer
  const :has_more, T::Boolean
  const :total, Inttegro::Search::Total
  const :resource_totals, T::Array[Inttegro::Search::ResourceTotal]
  const :results, T::Array[Inttegro::Search::Result]
  const :facets, T::Array[Inttegro::Search::FacetResult]
  const :next_cursor, T.nilable(String), default: nil
  const :freshness, Inttegro::Search::Freshness
end

#page_size ⇒ Integer (readonly)

Value of the page_size field in the Inttegro API payload.

Required in the API payload. Wire name: page_size.

Returns:

  • (Integer) 


90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/inttegro/search/page.rb', line 90

class Page < T::Struct
  const :resource_types, T::Array[Inttegro::Search::Type]
  const :sort, Inttegro::Search::Sort
  const :page_size, Integer
  const :result_count, Integer
  const :has_more, T::Boolean
  const :total, Inttegro::Search::Total
  const :resource_totals, T::Array[Inttegro::Search::ResourceTotal]
  const :results, T::Array[Inttegro::Search::Result]
  const :facets, T::Array[Inttegro::Search::FacetResult]
  const :next_cursor, T.nilable(String), default: nil
  const :freshness, Inttegro::Search::Freshness
end

#resource_totals ⇒ Array<Inttegro::Search::ResourceTotal> (readonly)

Value of the resource_totals field in the Inttegro API payload.

Required in the API payload. Wire name: resource_totals.

Returns:



90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/inttegro/search/page.rb', line 90

class Page < T::Struct
  const :resource_types, T::Array[Inttegro::Search::Type]
  const :sort, Inttegro::Search::Sort
  const :page_size, Integer
  const :result_count, Integer
  const :has_more, T::Boolean
  const :total, Inttegro::Search::Total
  const :resource_totals, T::Array[Inttegro::Search::ResourceTotal]
  const :results, T::Array[Inttegro::Search::Result]
  const :facets, T::Array[Inttegro::Search::FacetResult]
  const :next_cursor, T.nilable(String), default: nil
  const :freshness, Inttegro::Search::Freshness
end

#resource_types ⇒ Array<Inttegro::Search::Type> (readonly)

Value of the resource_types field in the Inttegro API payload.

Required in the API payload. Wire name: resource_types.

Returns:



90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/inttegro/search/page.rb', line 90

class Page < T::Struct
  const :resource_types, T::Array[Inttegro::Search::Type]
  const :sort, Inttegro::Search::Sort
  const :page_size, Integer
  const :result_count, Integer
  const :has_more, T::Boolean
  const :total, Inttegro::Search::Total
  const :resource_totals, T::Array[Inttegro::Search::ResourceTotal]
  const :results, T::Array[Inttegro::Search::Result]
  const :facets, T::Array[Inttegro::Search::FacetResult]
  const :next_cursor, T.nilable(String), default: nil
  const :freshness, Inttegro::Search::Freshness
end

#result_count ⇒ Integer (readonly)

Value of the result_count field in the Inttegro API payload.

Required in the API payload. Wire name: result_count.

Returns:

  • (Integer) 


90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/inttegro/search/page.rb', line 90

class Page < T::Struct
  const :resource_types, T::Array[Inttegro::Search::Type]
  const :sort, Inttegro::Search::Sort
  const :page_size, Integer
  const :result_count, Integer
  const :has_more, T::Boolean
  const :total, Inttegro::Search::Total
  const :resource_totals, T::Array[Inttegro::Search::ResourceTotal]
  const :results, T::Array[Inttegro::Search::Result]
  const :facets, T::Array[Inttegro::Search::FacetResult]
  const :next_cursor, T.nilable(String), default: nil
  const :freshness, Inttegro::Search::Freshness
end

#results ⇒ Array<Inttegro::Search::Result> (readonly)

Search projections for discovery, not canonical resource snapshots.

Required in the API payload. Wire name: results.

Returns:



90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/inttegro/search/page.rb', line 90

class Page < T::Struct
  const :resource_types, T::Array[Inttegro::Search::Type]
  const :sort, Inttegro::Search::Sort
  const :page_size, Integer
  const :result_count, Integer
  const :has_more, T::Boolean
  const :total, Inttegro::Search::Total
  const :resource_totals, T::Array[Inttegro::Search::ResourceTotal]
  const :results, T::Array[Inttegro::Search::Result]
  const :facets, T::Array[Inttegro::Search::FacetResult]
  const :next_cursor, T.nilable(String), default: nil
  const :freshness, Inttegro::Search::Freshness
end

#sort ⇒ Inttegro::Search::Sort (readonly)

Value of the sort field in the Inttegro API payload.

Required in the API payload. Wire name: sort.

Returns:



90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/inttegro/search/page.rb', line 90

class Page < T::Struct
  const :resource_types, T::Array[Inttegro::Search::Type]
  const :sort, Inttegro::Search::Sort
  const :page_size, Integer
  const :result_count, Integer
  const :has_more, T::Boolean
  const :total, Inttegro::Search::Total
  const :resource_totals, T::Array[Inttegro::Search::ResourceTotal]
  const :results, T::Array[Inttegro::Search::Result]
  const :facets, T::Array[Inttegro::Search::FacetResult]
  const :next_cursor, T.nilable(String), default: nil
  const :freshness, Inttegro::Search::Freshness
end

#total ⇒ Inttegro::Search::Total (readonly)

Value of the total field in the Inttegro API payload.

Required in the API payload. Wire name: total.

Returns:



90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/inttegro/search/page.rb', line 90

class Page < T::Struct
  const :resource_types, T::Array[Inttegro::Search::Type]
  const :sort, Inttegro::Search::Sort
  const :page_size, Integer
  const :result_count, Integer
  const :has_more, T::Boolean
  const :total, Inttegro::Search::Total
  const :resource_totals, T::Array[Inttegro::Search::ResourceTotal]
  const :results, T::Array[Inttegro::Search::Result]
  const :facets, T::Array[Inttegro::Search::FacetResult]
  const :next_cursor, T.nilable(String), default: nil
  const :freshness, Inttegro::Search::Freshness
end