Class: Cadenya::Models::MemoryLayers::MemoryEntryCreateSpec

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/cadenya/models/memory_layers/memory_entry_create_spec.rb

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(key:, content: nil, description: nil, upload_id: nil) ⇒ Object

Some parameter documentations has been truncated, see Cadenya::Models::MemoryLayers::MemoryEntryCreateSpec for more details.

MemoryEntryCreateSpec is the input shape for CreateMemoryEntry. It accepts either inline content or a reference to a completed Upload; exactly one of the two must be set.

Parameters:

  • key (String) —

    See MemoryEntrySpec.key for the full rule set. Same constraints apply

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

    Inline content, written directly into the entry.

  • description (String) (defaults to: nil)
  • upload_id (String) (defaults to: nil) —

    ID of a COMPLETE Upload. The server reads the object from storage,




# File 'lib/cadenya/models/memory_layers/memory_entry_create_spec.rb', line 31

Instance Attribute Details

#content ⇒ String?

Inline content, written directly into the entry.

Returns:

  • (String, nil) 


17
 
# File 'lib/cadenya/models/memory_layers/memory_entry_create_spec.rb', line 17

optional :content, String

#description ⇒ String?

Returns:

  • (String, nil) 


22
 
# File 'lib/cadenya/models/memory_layers/memory_entry_create_spec.rb', line 22

optional :description, String

#key ⇒ String

See MemoryEntrySpec.key for the full rule set. Same constraints apply here.

Returns:

  • (String) 


11
 
# File 'lib/cadenya/models/memory_layers/memory_entry_create_spec.rb', line 11

required :key, String

#upload_id ⇒ String?

ID of a COMPLETE Upload. The server reads the object from storage, copies its bytes into the entry, and marks the upload consumed.

Returns:

  • (String, nil) 


29
 
# File 'lib/cadenya/models/memory_layers/memory_entry_create_spec.rb', line 29

optional :upload_id, String, api_name: :uploadId