Class: MicrosoftGraph::Models::SearchResponse

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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Object

Instantiates a new searchResponse and sets the default values.



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

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_response

Raises:

  • (StandardError) 


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

def self.create_from_discriminator_value(parse_node)
    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
    return SearchResponse.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_response.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_response.rb', line 39

def additional_data=(value)
    @additional_data = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



62
63
64
65
66
67
68
69
70
 
# File 'lib/models/search_response.rb', line 62

def get_field_deserializers()
    return {
        "hitsContainers" => lambda {|n| @hits_containers = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::SearchHitsContainer.create_from_discriminator_value(pn) }) },
        "@odata.type" => lambda {|n| @odata_type = n.get_string_value() },
        "queryAlterationResponse" => lambda {|n| @query_alteration_response = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::AlterationResponse.create_from_discriminator_value(pn) }) },
        "resultTemplates" => lambda {|n| @result_templates = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::ResultTemplateDictionary.create_from_discriminator_value(pn) }) },
        "searchTerms" => lambda {|n| @search_terms = n.get_collection_of_primitive_values(String) },
    }
end

#hits_containers ⇒ Object

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

Returns:

  • a search_hits_container



75
76
77
 
# File 'lib/models/search_response.rb', line 75

def hits_containers
    return @hits_containers
end

#hits_containers=(value) ⇒ Object

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

Parameters:

  • value —

    Value to set for the hitsContainers property.

Returns:

  • a void



83
84
85
 
# File 'lib/models/search_response.rb', line 83

def hits_containers=(value)
    @hits_containers = value
end

#odata_type ⇒ Object

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

Returns:

  • a string



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

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



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

def odata_type=(value)
    @odata_type = value
end

#query_alteration_response ⇒ Object

Gets the queryAlterationResponse property value. Provides information related to spelling corrections in the alteration response.

Returns:

  • a alteration_response



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

def query_alteration_response
    return @query_alteration_response
end

#query_alteration_response=(value) ⇒ Object

Sets the queryAlterationResponse property value. Provides information related to spelling corrections in the alteration response.

Parameters:

  • value —

    Value to set for the queryAlterationResponse property.

Returns:

  • a void



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

def query_alteration_response=(value)
    @query_alteration_response = value
end

#result_templates ⇒ Object

Gets the resultTemplates property value. A dictionary of resultTemplateIds and associated values, which include the name and JSON schema of the result templates.

Returns:

  • a result_template_dictionary



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

def result_templates
    return @result_templates
end

#result_templates=(value) ⇒ Object

Sets the resultTemplates property value. A dictionary of resultTemplateIds and associated values, which include the name and JSON schema of the result templates.

Parameters:

  • value —

    Value to set for the resultTemplates property.

Returns:

  • a void



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

def result_templates=(value)
    @result_templates = value
end

#search_terms ⇒ Object

Gets the searchTerms property value. Contains the search terms sent in the initial search query.

Returns:

  • a string



135
136
137
 
# File 'lib/models/search_response.rb', line 135

def search_terms
    return @search_terms
end

#search_terms=(value) ⇒ Object

Sets the searchTerms property value. Contains the search terms sent in the initial search query.

Parameters:

  • value —

    Value to set for the searchTerms property.

Returns:

  • a void



143
144
145
 
# File 'lib/models/search_response.rb', line 143

def search_terms=(value)
    @search_terms = 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) 


151
152
153
154
155
156
157
158
159
 
# File 'lib/models/search_response.rb', line 151

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    writer.write_collection_of_object_values("hitsContainers", @hits_containers)
    writer.write_string_value("@odata.type", @odata_type)
    writer.write_object_value("queryAlterationResponse", @query_alteration_response)
    writer.write_object_value("resultTemplates", @result_templates)
    writer.write_collection_of_primitive_values("searchTerms", @search_terms)
    writer.write_additional_data(@additional_data)
end