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

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Moonbase::Models::Collections::FieldCreateParams::Field::FieldRelation::AllowedCollection

Defined in:

lib/moonbase/models/collections/field_create_params.rb

Instance Attribute Summary

• #id ⇒ String^?

  Unique identifier of the collection.

• #ref ⇒ String^?

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

• #type ⇒ Symbol, :collection

  String representing the object’s type.

Instance Method Summary

• #initialize(allowed_collections:, name:, relation_type:, cardinality: nil, default_values: nil, description: nil, required: nil, reverse_field_name: nil, unique: nil, type: :"field/relation") ⇒ Object constructor

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

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:, name:, relation_type:, cardinality: nil, default_values: nil, description: nil, required: nil, reverse_field_name: nil, unique: nil, type: :"field/relation") ⇒ Object

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

Parameters for creating a relation field that links items across collections.

Parameters:

• allowed_collections (Array<Moonbase::Models::Collections::FieldCreateParams::Field::FieldRelation::AllowedCollection>) —

  A list of collection IDs or ‘ref` values that are valid targets for this relatio

• name (String) —

  The human-readable name for the field.

• relation_type (Symbol, Moonbase::Models::Collections::FieldCreateParams::Field::FieldRelation::RelationType) —

  The type of relationship: ‘one_way` for simple references, or `two_way` for bidi

• cardinality (Symbol, Moonbase::Models::Collections::FieldCreateParams::Field::FieldRelation::Cardinality) (defaults to: nil) —

  Whether the field holds a single value (‘one`) or multiple values (`many`). Defa

• default_values (Array<Moonbase::Models::RelationValueParam, Moonbase::Models::CurrentMember>) (defaults to: nil)
• description (String) (defaults to: nil) —

  An optional description of the field’s purpose.

• required (Boolean) (defaults to: nil) —

  If ‘true`, items must have a value for this field. Defaults to `false`.

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

  For ‘two_way` relations, the name of the reverse field created on the target col

• unique (Boolean) (defaults to: nil) —

  If ‘true`, values must be unique across all items. Defaults to `false`.

• type (Symbol, :"field/relation") (defaults to: :"field/relation") —

  The field type. Must be ‘field/relation`.

# File 'lib/moonbase/models/collections/field_create_params.rb', line 1684

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)

# File 'lib/moonbase/models/collections/field_create_params.rb', line 1695

optional :id, String

#ref ⇒ String^?

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

Returns:

• (String, nil)

# File 'lib/moonbase/models/collections/field_create_params.rb', line 1701

optional :ref, String

#type ⇒ Symbol, :collection

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

Returns:

• (Symbol, :collection)

# File 'lib/moonbase/models/collections/field_create_params.rb', line 1689

required :type, const: :collection