Class: Turbopuffer::Models::NamespaceWriteParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/turbopuffer/models/namespace_write_params.rb

Overview

See Also:

Defined Under Namespace

Modules: CopyFromNamespace Classes: Encryption, PatchByFilter

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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

Some parameter documentations has been truncated, see Turbopuffer::Models::NamespaceWriteParams::Encryption::Cmek for more details.

Parameters:

  • key_name (String) —

    The identifier of the CMEK key to use for encryption. For GCP, the fully-qualifi




# File 'lib/turbopuffer/models/namespace_write_params.rb', line 119

Instance Attribute Details

#copy_from_namespace ⇒ String, ...

The namespace to copy documents from.

Returns:



19
 
# File 'lib/turbopuffer/models/namespace_write_params.rb', line 19

optional :copy_from_namespace, union: -> { Turbopuffer::NamespaceWriteParams::CopyFromNamespace }

#delete_by_filter ⇒ Object?

The filter specifying which documents to delete.

Returns:

  • (Object, nil) 


25
 
# File 'lib/turbopuffer/models/namespace_write_params.rb', line 25

optional :delete_by_filter, Turbopuffer::Internal::Type::Unknown

#delete_by_filter_allow_partial ⇒ Boolean?

Allow partial completion when filter matches too many documents.

Returns:

  • (Boolean, nil) 


31
 
# File 'lib/turbopuffer/models/namespace_write_params.rb', line 31

optional :delete_by_filter_allow_partial, Turbopuffer::Internal::Type::Boolean

#delete_condition ⇒ Object?

A condition evaluated against the current value of each document targeted by a delete write. Only documents that pass the condition are deleted.

Returns:

  • (Object, nil) 


38
 
# File 'lib/turbopuffer/models/namespace_write_params.rb', line 38

optional :delete_condition, Turbopuffer::Internal::Type::Unknown

#deletes ⇒ Array<String, Integer>?

Returns:

  • (Array<String, Integer>, nil) 


43
 
# File 'lib/turbopuffer/models/namespace_write_params.rb', line 43

optional :deletes, -> { Turbopuffer::Internal::Type::ArrayOf[union: Turbopuffer::ID] }

#disable_backpressure ⇒ Boolean?

Disables write throttling (HTTP 429 responses) during high-volume ingestion.

Returns:

  • (Boolean, nil) 


49
 
# File 'lib/turbopuffer/models/namespace_write_params.rb', line 49

optional :disable_backpressure, Turbopuffer::Internal::Type::Boolean

#distance_metric ⇒ Symbol, ...

A function used to calculate vector similarity.

Returns:



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

optional :distance_metric, enum: -> { Turbopuffer::DistanceMetric }

#encryption ⇒ Turbopuffer::Models::NamespaceWriteParams::Encryption?

The encryption configuration for a namespace.

Returns:



61
 
# File 'lib/turbopuffer/models/namespace_write_params.rb', line 61

optional :encryption, -> { Turbopuffer::NamespaceWriteParams::Encryption }

#namespace ⇒ String?

Returns:

  • (String, nil) 


13
 
# File 'lib/turbopuffer/models/namespace_write_params.rb', line 13

optional :namespace, String

#patch_by_filter ⇒ Turbopuffer::Models::NamespaceWriteParams::PatchByFilter?

The patch and filter specifying which documents to patch.

Returns:



67
 
# File 'lib/turbopuffer/models/namespace_write_params.rb', line 67

optional :patch_by_filter, -> { Turbopuffer::NamespaceWriteParams::PatchByFilter }

#patch_by_filter_allow_partial ⇒ Boolean?

Allow partial completion when filter matches too many documents.

Returns:

  • (Boolean, nil) 


73
 
# File 'lib/turbopuffer/models/namespace_write_params.rb', line 73

optional :patch_by_filter_allow_partial, Turbopuffer::Internal::Type::Boolean

#patch_columns ⇒ Turbopuffer::Models::Columns?

A list of documents in columnar format. Each key is a column name, mapped to an array of values for that column.

Returns:



80
 
# File 'lib/turbopuffer/models/namespace_write_params.rb', line 80

optional :patch_columns, -> { Turbopuffer::Columns }

#patch_condition ⇒ Object?

A condition evaluated against the current value of each document targeted by a patch write. Only documents that pass the condition are patched.

Returns:

  • (Object, nil) 


87
 
# File 'lib/turbopuffer/models/namespace_write_params.rb', line 87

optional :patch_condition, Turbopuffer::Internal::Type::Unknown

#patch_rows ⇒ Array<Turbopuffer::Models::Row>?

Returns:



92
 
# File 'lib/turbopuffer/models/namespace_write_params.rb', line 92

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

#schema ⇒ Hash{Symbol=>String, Turbopuffer::Models::AttributeSchemaConfig}?

The schema of the attributes attached to the documents.

Returns:



98
 
# File 'lib/turbopuffer/models/namespace_write_params.rb', line 98

optional :schema, -> { Turbopuffer::Internal::Type::HashOf[union: Turbopuffer::AttributeSchema] }

#upsert_columns ⇒ Turbopuffer::Models::Columns?

A list of documents in columnar format. Each key is a column name, mapped to an array of values for that column.

Returns:



105
 
# File 'lib/turbopuffer/models/namespace_write_params.rb', line 105

optional :upsert_columns, -> { Turbopuffer::Columns }

#upsert_condition ⇒ Object?

A condition evaluated against the current value of each document targeted by an upsert write. Only documents that pass the condition are upserted.

Returns:

  • (Object, nil) 


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

optional :upsert_condition, Turbopuffer::Internal::Type::Unknown

#upsert_rows ⇒ Array<Turbopuffer::Models::Row>?

Returns:



117
 
# File 'lib/turbopuffer/models/namespace_write_params.rb', line 117

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

Class Method Details

.variants ⇒ Array(String, Turbopuffer::Models::NamespaceWriteParams::CopyFromNamespace::CopyFromNamespaceConfig)

Returns:




# File 'lib/turbopuffer/models/namespace_write_params.rb', line 197