Class: Telnyx::Models::Storage::Kvs::KeyListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/telnyx/models/storage/kvs/key_list_params.rb,
sig/telnyx/models/storage/kvs/key_list_params.rbs

Overview

See Also:

  • Telnyx::Resources::Storage::Kvs::Keys#list

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

Parameters:

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

    Opaque pagination cursor from a previous response's meta.cursor.

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

    Maximum number of keys to return. Values above 1000 are treated as 1000.

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

    Return only keys that start with this prefix.

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



# File 'lib/telnyx/models/storage/kvs/key_list_params.rb', line 35

Instance Attribute Details

#cursor ⇒ String?

Opaque pagination cursor from a previous response's meta.cursor.

Parameters:

  • (String)

Returns:

  • (String, nil) 


21
 
# File 'lib/telnyx/models/storage/kvs/key_list_params.rb', line 21

optional :cursor, String

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


15
 
# File 'lib/telnyx/models/storage/kvs/key_list_params.rb', line 15

required :id, String

#limit ⇒ Integer?

Maximum number of keys to return. Values above 1000 are treated as 1000.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


27
 
# File 'lib/telnyx/models/storage/kvs/key_list_params.rb', line 27

optional :limit, Integer

#prefix ⇒ String?

Return only keys that start with this prefix.

Parameters:

  • (String)

Returns:

  • (String, nil) 


33
 
# File 'lib/telnyx/models/storage/kvs/key_list_params.rb', line 33

optional :prefix, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


35
 
# File 'sig/telnyx/models/storage/kvs/key_list_params.rbs', line 35

def to_hash: -> {