Class: Turbopuffer::Models::NamespaceQueryResponse

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Turbopuffer::Models::NamespaceQueryResponse

Defined in:

lib/turbopuffer/models/namespace_query_response.rb

Overview

See Also:

• Resources::Namespaces#query

Instance Attribute Summary

• #aggregation_groups ⇒ Array<Hash{Symbol=>Object}>^?
• #aggregations ⇒ Hash{Symbol=>Object}^?
• #billing ⇒ Turbopuffer::Models::QueryBilling

  The billing information for a query.

• #performance ⇒ Turbopuffer::Models::QueryPerformance

  The performance information for a query.

• #rows ⇒ Array<Turbopuffer::Models::Row>^?

Instance Method Summary

• #initialize(billing: , performance: , aggregation_groups: nil, aggregations: nil, rows: nil) ⇒ Object constructor

  The result of a query.

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(billing: , performance: , aggregation_groups: nil, aggregations: nil, rows: nil) ⇒ Object

The result of a query.

Parameters:

• billing (Turbopuffer::Models::QueryBilling) (defaults to: ) —

  The billing information for a query.

• performance (Turbopuffer::Models::QueryPerformance) (defaults to: ) —

  The performance information for a query.

• aggregation_groups (Array<Hash{Symbol=>Object}>) (defaults to: nil)
• aggregations (Hash{Symbol=>Object}) (defaults to: nil)
• rows (Array<Turbopuffer::Models::Row>) (defaults to: nil)

# File 'lib/turbopuffer/models/namespace_query_response.rb', line 35

Instance Attribute Details

#aggregation_groups ⇒ Array<Hash{Symbol=>Object}>^?

Returns:

• (Array<Hash{Symbol=>Object}>, nil)

# File 'lib/turbopuffer/models/namespace_query_response.rb', line 22

optional :aggregation_groups,
Turbopuffer::Internal::Type::ArrayOf[Turbopuffer::Internal::Type::HashOf[Turbopuffer::Internal::Type::Unknown]]

#aggregations ⇒ Hash{Symbol=>Object}^?

Returns:

• (Hash{Symbol=>Object}, nil)

# File 'lib/turbopuffer/models/namespace_query_response.rb', line 28

optional :aggregations, Turbopuffer::Internal::Type::HashOf[Turbopuffer::Internal::Type::Unknown]

#billing ⇒ Turbopuffer::Models::QueryBilling

The billing information for a query.

Returns:

• (Turbopuffer::Models::QueryBilling)

# File 'lib/turbopuffer/models/namespace_query_response.rb', line 11

required :billing, -> { Turbopuffer::QueryBilling }

#performance ⇒ Turbopuffer::Models::QueryPerformance

The performance information for a query.

Returns:

• (Turbopuffer::Models::QueryPerformance)

# File 'lib/turbopuffer/models/namespace_query_response.rb', line 17

required :performance, -> { Turbopuffer::QueryPerformance }

#rows ⇒ Array<Turbopuffer::Models::Row>^?

Returns:

• (Array<Turbopuffer::Models::Row>, nil)

# File 'lib/turbopuffer/models/namespace_query_response.rb', line 33

optional :rows, -> { Turbopuffer::Internal::Type::ArrayOf[Turbopuffer::Row] }