Class: Turbopuffer::Models::NamespaceWriteResponse

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

Overview

See Also:

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(billing:, message:, rows_affected:, rows_deleted: nil, rows_patched: nil, rows_remaining: nil, rows_upserted: nil, status: :OK) ⇒ Object

The response to a successful write request.

Parameters:

  • billing (Turbopuffer::Models::WriteBilling) —

    The billing information for a write request.

  • message (String) —

    A message describing the result of the write request.

  • rows_affected (Integer) —

    The number of rows affected by the write request.

  • rows_deleted (Integer) (defaults to: nil) —

    The number of rows deleted by the write request.

  • rows_patched (Integer) (defaults to: nil) —

    The number of rows patched by the write request.

  • rows_remaining (Boolean) (defaults to: nil) —

    Whether more documents match the filter for partial operations.

  • rows_upserted (Integer) (defaults to: nil) —

    The number of rows upserted by the write request.

  • status (Symbol, :OK) (defaults to: :OK) —

    The status of the request.




# File 'lib/turbopuffer/models/namespace_write_response.rb', line 55

Instance Attribute Details

#billing ⇒ Turbopuffer::Models::WriteBilling

The billing information for a write request.

Returns:



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

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

#message ⇒ String

A message describing the result of the write request.

Returns:

  • (String) 


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

required :message, String

#rows_affected ⇒ Integer

The number of rows affected by the write request.

Returns:

  • (Integer) 


23
 
# File 'lib/turbopuffer/models/namespace_write_response.rb', line 23

required :rows_affected, Integer

#rows_deleted ⇒ Integer?

The number of rows deleted by the write request.

Returns:

  • (Integer, nil) 


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

optional :rows_deleted, Integer

#rows_patched ⇒ Integer?

The number of rows patched by the write request.

Returns:

  • (Integer, nil) 


41
 
# File 'lib/turbopuffer/models/namespace_write_response.rb', line 41

optional :rows_patched, Integer

#rows_remaining ⇒ Boolean?

Whether more documents match the filter for partial operations.

Returns:

  • (Boolean, nil) 


47
 
# File 'lib/turbopuffer/models/namespace_write_response.rb', line 47

optional :rows_remaining, Turbopuffer::Internal::Type::Boolean

#rows_upserted ⇒ Integer?

The number of rows upserted by the write request.

Returns:

  • (Integer, nil) 


53
 
# File 'lib/turbopuffer/models/namespace_write_response.rb', line 53

optional :rows_upserted, Integer

#status ⇒ Symbol, :OK

The status of the request.

Returns:

  • (Symbol, :OK) 


29
 
# File 'lib/turbopuffer/models/namespace_write_response.rb', line 29

required :status, const: :OK