Class: Inttegro::Search::FacetResult

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

Overview

Typed representation of the facet result 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

#buckets ⇒ Array<Inttegro::Search::FacetBucket> (readonly)

Value of the buckets field in the Inttegro API payload.

Required in the API payload. Wire name: buckets.

Returns:



30
31
32
33
 
# File 'lib/inttegro/search/facet_result.rb', line 30

class FacetResult < T::Struct
  const :field, String
  const :buckets, T::Array[Inttegro::Search::FacetBucket]
end

#field ⇒ String (readonly)

The same unqualified route-local field requested by the caller.

Required in the API payload. Wire name: field.

Returns:

  • (String) 


30
31
32
33
 
# File 'lib/inttegro/search/facet_result.rb', line 30

class FacetResult < T::Struct
  const :field, String
  const :buckets, T::Array[Inttegro::Search::FacetBucket]
end