Class: Moonbase::Models::Collections::FieldUpdateParams::Field::FieldRelation::AllowedCollection

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/moonbase/models/collections/field_update_params.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(allowed_collections: nil, cardinality: nil, default_values: nil, description: nil, name: nil, relation_type: nil, required: nil, unique: nil, type: :"field/relation") ⇒ Object

Some parameter documentations has been truncated, see Moonbase::Models::Collections::FieldUpdateParams::Field::FieldRelation for more details.

Parameters for updating a relation field.

Parameters:



1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
 
# File 'lib/moonbase/models/collections/field_update_params.rb', line 1652

class AllowedCollection < Moonbase::Internal::Type::BaseModel
  # @!attribute type
  #   String representing the object’s type. Always `collection` for this object.
  #
  #   @return [Symbol, :collection]
  required :type, const: :collection

  # @!attribute id
  #   Unique identifier of the collection.
  #
  #   @return [String, nil]
  optional :id, String

  # @!attribute ref
  #   The stable, machine-readable reference identifier of the collection.
  #
  #   @return [String, nil]
  optional :ref, String

  # @!method initialize(id: nil, ref: nil, type: :collection)
  #   A reference to a `Collection` used in request bodies. Provide at least one of
  #   `id` or `ref` to identify the collection.
  #
  #   @param id [String] Unique identifier of the collection.
  #
  #   @param ref [String] The stable, machine-readable reference identifier of the collection.
  #
  #   @param type [Symbol, :collection] String representing the object’s type. Always `collection` for this object.
end

Instance Attribute Details

#id ⇒ String?

Unique identifier of the collection.

Returns:

  • (String, nil) 


1663
 
# File 'lib/moonbase/models/collections/field_update_params.rb', line 1663

optional :id, String

#ref ⇒ String?

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

Returns:

  • (String, nil) 


1669
 
# File 'lib/moonbase/models/collections/field_update_params.rb', line 1669

optional :ref, String

#type ⇒ Symbol, :collection

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

Returns:

  • (Symbol, :collection) 


1657
 
# File 'lib/moonbase/models/collections/field_update_params.rb', line 1657

required :type, const: :collection