Class: Moonbase::Models::FieldPointer

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/moonbase/models/field_pointer.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(id:, collection:, ref:, type: :field) ⇒ Object

A lightweight reference to a ‘Field`, containing the minimal information needed to identify it.

Parameters:

  • id (String) —

    Unique identifier of the field.

  • collection (Moonbase::Models::CollectionPointer) —

    A reference to the ‘Collection` containing this field.

  • ref (String) —

    The stable, machine-readable reference identifier of the field.

  • type (Symbol, :field) (defaults to: :field) —

    String representing the object’s type. Always ‘field` for this object.




# File 'lib/moonbase/models/field_pointer.rb', line 30

Instance Attribute Details

#collection ⇒ Moonbase::Models::CollectionPointer

A reference to the ‘Collection` containing this field.

Returns:



16
 
# File 'lib/moonbase/models/field_pointer.rb', line 16

required :collection, -> { Moonbase::CollectionPointer }

#id ⇒ String

Unique identifier of the field.

Returns:

  • (String) 


10
 
# File 'lib/moonbase/models/field_pointer.rb', line 10

required :id, String

#ref ⇒ String

The stable, machine-readable reference identifier of the field.

Returns:

  • (String) 


22
 
# File 'lib/moonbase/models/field_pointer.rb', line 22

required :ref, String

#type ⇒ Symbol, :field

String representing the object’s type. Always ‘field` for this object.

Returns:

  • (Symbol, :field) 


28
 
# File 'lib/moonbase/models/field_pointer.rb', line 28

required :type, const: :field