Class: MicrosoftGraph::Models::SearchHitsContainer

Inherits:
Object
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::AdditionalDataHolder, MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/search_hits_container.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Object

Instantiates a new searchHitsContainer and sets the default values.



61
62
63
 
# File 'lib/models/search_hits_container.rb', line 61

def initialize()
    @additional_data = Hash.new
end

Class Method Details

.create_from_discriminator_value(parse_node) ⇒ Object

Creates a new instance of the appropriate class based on discriminator value

Parameters:

  • parse_node —

    The parse node to use to read the discriminator value and create the object

Returns:

  • a search_hits_container

Raises:

  • (StandardError) 


69
70
71
72
 
# File 'lib/models/search_hits_container.rb', line 69

def self.create_from_discriminator_value(parse_node)
    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
    return SearchHitsContainer.new
end

Instance Method Details

#additional_data ⇒ Object

Gets the additionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.

Returns:

  • a i_dictionary



31
32
33
 
# File 'lib/models/search_hits_container.rb', line 31

def additional_data
    return @additional_data
end

#additional_data=(value) ⇒ Object

Sets the additionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.

Parameters:

  • value —

    Value to set for the additionalData property.

Returns:

  • a void



39
40
41
 
# File 'lib/models/search_hits_container.rb', line 39

def additional_data=(value)
    @additional_data = value
end

#aggregations ⇒ Object

Gets the aggregations property value. The aggregations property

Returns:

  • a search_aggregation



46
47
48
 
# File 'lib/models/search_hits_container.rb', line 46

def aggregations
    return @aggregations
end

#aggregations=(value) ⇒ Object

Sets the aggregations property value. The aggregations property

Parameters:

  • value —

    Value to set for the aggregations property.

Returns:

  • a void



54
55
56
 
# File 'lib/models/search_hits_container.rb', line 54

def aggregations=(value)
    @aggregations = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



77
78
79
80
81
82
83
84
85
 
# File 'lib/models/search_hits_container.rb', line 77

def get_field_deserializers()
    return {
        "aggregations" => lambda {|n| @aggregations = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::SearchAggregation.create_from_discriminator_value(pn) }) },
        "hits" => lambda {|n| @hits = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::SearchHit.create_from_discriminator_value(pn) }) },
        "moreResultsAvailable" => lambda {|n| @more_results_available = n.get_boolean_value() },
        "@odata.type" => lambda {|n| @odata_type = n.get_string_value() },
        "total" => lambda {|n| @total = n.get_number_value() },
    }
end

#hits ⇒ Object

Gets the hits property value. A collection of the search results.

Returns:

  • a search_hit



90
91
92
 
# File 'lib/models/search_hits_container.rb', line 90

def hits
    return @hits
end

#hits=(value) ⇒ Object

Sets the hits property value. A collection of the search results.

Parameters:

  • value —

    Value to set for the hits property.

Returns:

  • a void



98
99
100
 
# File 'lib/models/search_hits_container.rb', line 98

def hits=(value)
    @hits = value
end

#more_results_available ⇒ Object

Gets the moreResultsAvailable property value. Provides information if more results are available. Based on this information, you can adjust the from and size properties of the searchRequest accordingly.

Returns:

  • a boolean



105
106
107
 
# File 'lib/models/search_hits_container.rb', line 105

def more_results_available
    return @more_results_available
end

#more_results_available=(value) ⇒ Object

Sets the moreResultsAvailable property value. Provides information if more results are available. Based on this information, you can adjust the from and size properties of the searchRequest accordingly.

Parameters:

  • value —

    Value to set for the moreResultsAvailable property.

Returns:

  • a void



113
114
115
 
# File 'lib/models/search_hits_container.rb', line 113

def more_results_available=(value)
    @more_results_available = value
end

#odata_type ⇒ Object

Gets the @odata.type property value. The OdataType property

Returns:

  • a string



120
121
122
 
# File 'lib/models/search_hits_container.rb', line 120

def odata_type
    return @odata_type
end

#odata_type=(value) ⇒ Object

Sets the @odata.type property value. The OdataType property

Parameters:

  • value —

    Value to set for the @odata.type property.

Returns:

  • a void



128
129
130
 
# File 'lib/models/search_hits_container.rb', line 128

def odata_type=(value)
    @odata_type = value
end

#serialize(writer) ⇒ Object

Serializes information the current object

Parameters:

  • writer —

    Serialization writer to use to serialize this model

Returns:

  • a void

Raises:

  • (StandardError) 


136
137
138
139
140
141
142
143
144
 
# File 'lib/models/search_hits_container.rb', line 136

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    writer.write_collection_of_object_values("aggregations", @aggregations)
    writer.write_collection_of_object_values("hits", @hits)
    writer.write_boolean_value("moreResultsAvailable", @more_results_available)
    writer.write_string_value("@odata.type", @odata_type)
    writer.write_number_value("total", @total)
    writer.write_additional_data(@additional_data)
end

#total ⇒ Object

Gets the total property value. The total number of results. Note this is not the number of results on the page, but the total number of results satisfying the query.

Returns:

  • a integer



149
150
151
 
# File 'lib/models/search_hits_container.rb', line 149

def total
    return @total
end

#total=(value) ⇒ Object

Sets the total property value. The total number of results. Note this is not the number of results on the page, but the total number of results satisfying the query.

Parameters:

  • value —

    Value to set for the total property.

Returns:

  • a void



157
158
159
 
# File 'lib/models/search_hits_container.rb', line 157

def total=(value)
    @total = value
end