Class: Moonbase::Models::SearchResponse::Data

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/moonbase/models/search_response.rb

Defined Under Namespace

Modules: Data

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(data:, type: :search_result) ⇒ Object

Some parameter documentations has been truncated, see Moonbase::Models::SearchResponse::Data for more details.

A search result entry.

Parameters:



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/moonbase/models/search_response.rb', line 23

class Data < Moonbase::Internal::Type::BaseModel
  # @!attribute data
  #   An Item represents a single record or row within a Collection. It holds a set of
  #   `values` corresponding to the Collection's `fields`.
  #
  #   @return [Moonbase::Models::Item, Moonbase::Models::MoonbaseFile]
  required :data, union: -> { Moonbase::Models::SearchResponse::Data::Data }

  # @!attribute type
  #
  #   @return [Symbol, :search_result]
  required :type, const: :search_result

  # @!method initialize(data:, type: :search_result)
  #   Some parameter documentations has been truncated, see
  #   {Moonbase::Models::SearchResponse::Data} for more details.
  #
  #   A search result entry.
  #
  #   @param data [Moonbase::Models::Item, Moonbase::Models::MoonbaseFile] An Item represents a single record or row within a Collection. It holds a set of
  #
  #   @param type [Symbol, :search_result]

  # An Item represents a single record or row within a Collection. It holds a set of
  # `values` corresponding to the Collection's `fields`.
  #
  # @see Moonbase::Models::SearchResponse::Data#data
  module Data
    extend Moonbase::Internal::Type::Union

    discriminator :type

    # An Item represents a single record or row within a Collection. It holds a set of `values` corresponding to the Collection's `fields`.
    variant :item, -> { Moonbase::Item }

    # The File object represents a file that has been uploaded to your library.
    variant :file, -> { Moonbase::MoonbaseFile }

    # @!method self.variants
    #   @return [Array(Moonbase::Models::Item, Moonbase::Models::MoonbaseFile)]
  end
end

Instance Attribute Details

#data ⇒ Moonbase::Models::Item, Moonbase::Models::MoonbaseFile

An Item represents a single record or row within a Collection. It holds a set of ‘values` corresponding to the Collection’s ‘fields`.

Returns:



29
 
# File 'lib/moonbase/models/search_response.rb', line 29

required :data, union: -> { Moonbase::Models::SearchResponse::Data::Data }

#type ⇒ Symbol, :search_result

Returns:

  • (Symbol, :search_result) 


34
 
# File 'lib/moonbase/models/search_response.rb', line 34

required :type, const: :search_result