Class: Turbopuffer::Models::NamespaceMetadataPatch

Inherits:

Internal::Type::BaseModel

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

Defined in:

lib/turbopuffer/models/namespace_metadata_patch.rb

Direct Known Subclasses

NamespaceUpdateMetadataParams

Defined Under Namespace

Modules: Pinning

Instance Attribute Summary

• #pinning ⇒ Boolean, ...

  Configuration for namespace pinning.

Instance Method Summary

• #initialize(pinning: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see NamespaceMetadataPatch for more details.

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

Some parameter documentations has been truncated, see Turbopuffer::Models::NamespaceMetadataPatch for more details.

Request to update namespace metadata configuration.

Parameters:

• pinning (Boolean, Turbopuffer::Models::PinningConfig, nil) (defaults to: nil) —

  Configuration for namespace pinning.

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

Instance Attribute Details

#pinning ⇒ Boolean, ...

Configuration for namespace pinning.

• Missing field: no change to pinning configuration

• ‘null` or `false`: explicitly remove pinning

• ‘true`: enable pinning with default configuration

• Object: set pinning configuration

Returns:

• (Boolean, Turbopuffer::Models::PinningConfig, nil)

# File 'lib/turbopuffer/models/namespace_metadata_patch.rb', line 15

optional :pinning, union: -> { Turbopuffer::NamespaceMetadataPatch::Pinning }, nil?: true