Class: Turbopuffer::Models::ClientNamespacesParams

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

Overview

See Also:

  • Resources::Client#namespaces

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

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(cursor: nil, page_size: nil, prefix: nil, request_options: {}) ⇒ Object

Parameters:

  • cursor (String) (defaults to: nil) —

    Retrieve the next page of results.

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

    Limit the number of results per page.

  • prefix (String) (defaults to: nil) —

    Retrieve only the namespaces that match the prefix.

  • request_options (Turbopuffer::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



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

Instance Attribute Details

#cursor ⇒ String?

Retrieve the next page of results.

Returns:

  • (String, nil) 


14
 
# File 'lib/turbopuffer/models/client_namespaces_params.rb', line 14

optional :cursor, String

#page_size ⇒ Integer?

Limit the number of results per page.

Returns:

  • (Integer, nil) 


20
 
# File 'lib/turbopuffer/models/client_namespaces_params.rb', line 20

optional :page_size, Integer

#prefix ⇒ String?

Retrieve only the namespaces that match the prefix.

Returns:

  • (String, nil) 


26
 
# File 'lib/turbopuffer/models/client_namespaces_params.rb', line 26

optional :prefix, String