Class: Inttegro::Search::Facet

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

Overview

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

#field ⇒ String (readonly)

Unqualified route-local field to group and count.

Required in the API payload. Wire name: field.

Returns:

  • (String) 


29
30
31
32
 
# File 'lib/inttegro/search/facet.rb', line 29

class Facet < T::Struct
  const :field, String
  const :limit, T.nilable(Integer), default: nil
end

#limit ⇒ Integer? (readonly)

Value of the limit field in the Inttegro API payload.

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

Returns:

  • (Integer, nil) 


29
30
31
32
 
# File 'lib/inttegro/search/facet.rb', line 29

class Facet < T::Struct
  const :field, String
  const :limit, T.nilable(Integer), default: nil
end