Class: Turbopuffer::Models::NamespaceExplainQueryParams::Consistency

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/turbopuffer/models/namespace_explain_query_params.rb

Defined Under Namespace

Modules: Level

Instance Attribute Summary collapse

Instance Method Summary collapse

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(level: nil) ⇒ Object

The consistency level for a query.

Parameters:



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/turbopuffer/models/namespace_explain_query_params.rb', line 107

class Consistency < Turbopuffer::Internal::Type::BaseModel
  # @!attribute level
  #   The query's consistency level.
  #
  #   @return [Symbol, Turbopuffer::Models::NamespaceExplainQueryParams::Consistency::Level, nil]
  optional :level, enum: -> { Turbopuffer::NamespaceExplainQueryParams::Consistency::Level }

  # @!method initialize(level: nil)
  #   The consistency level for a query.
  #
  #   @param level [Symbol, Turbopuffer::Models::NamespaceExplainQueryParams::Consistency::Level] The query's consistency level.

  # The query's consistency level.
  #
  # @see Turbopuffer::Models::NamespaceExplainQueryParams::Consistency#level
  module Level
    extend Turbopuffer::Internal::Type::Enum

    # Strong consistency. Requires a round-trip to object storage to fetch the latest writes.
    STRONG = :strong

    # Eventual consistency. Does not require a round-trip to object storage, but may not see the latest writes.
    EVENTUAL = :eventual

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

#level ⇒ Symbol, ...

The query’s consistency level.

Returns:



112
 
# File 'lib/turbopuffer/models/namespace_explain_query_params.rb', line 112

optional :level, enum: -> { Turbopuffer::NamespaceExplainQueryParams::Consistency::Level }