Class: MicrosoftGraph::Models::SearchAlteration

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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Object

Instantiates a new searchAlteration and sets the default values.



88
89
90
 
# File 'lib/models/search_alteration.rb', line 88

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_alteration

Raises:

  • (StandardError) 


96
97
98
99
 
# File 'lib/models/search_alteration.rb', line 96

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



28
29
30
 
# File 'lib/models/search_alteration.rb', line 28

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



36
37
38
 
# File 'lib/models/search_alteration.rb', line 36

def additional_data=(value)
    @additional_data = value
end

#altered_highlighted_query_string ⇒ Object

Gets the alteredHighlightedQueryString property value. Defines the altered highlighted query string with spelling correction. The annotation around the corrected segment is: /ue000, /ue001.

Returns:

  • a string



43
44
45
 
# File 'lib/models/search_alteration.rb', line 43

def altered_highlighted_query_string
    return @altered_highlighted_query_string
end

#altered_highlighted_query_string=(value) ⇒ Object

Sets the alteredHighlightedQueryString property value. Defines the altered highlighted query string with spelling correction. The annotation around the corrected segment is: /ue000, /ue001.

Parameters:

  • value —

    Value to set for the alteredHighlightedQueryString property.

Returns:

  • a void



51
52
53
 
# File 'lib/models/search_alteration.rb', line 51

def altered_highlighted_query_string=(value)
    @altered_highlighted_query_string = value
end

#altered_query_string ⇒ Object

Gets the alteredQueryString property value. Defines the altered query string with spelling correction.

Returns:

  • a string



58
59
60
 
# File 'lib/models/search_alteration.rb', line 58

def altered_query_string
    return @altered_query_string
end

#altered_query_string=(value) ⇒ Object

Sets the alteredQueryString property value. Defines the altered query string with spelling correction.

Parameters:

  • value —

    Value to set for the alteredQueryString property.

Returns:

  • a void



66
67
68
 
# File 'lib/models/search_alteration.rb', line 66

def altered_query_string=(value)
    @altered_query_string = value
end

#altered_query_tokens ⇒ Object

Gets the alteredQueryTokens property value. Represents changed segments related to an original user query.

Returns:

  • a altered_query_token



73
74
75
 
# File 'lib/models/search_alteration.rb', line 73

def altered_query_tokens
    return @altered_query_tokens
end

#altered_query_tokens=(value) ⇒ Object

Sets the alteredQueryTokens property value. Represents changed segments related to an original user query.

Parameters:

  • value —

    Value to set for the alteredQueryTokens property.

Returns:

  • a void



81
82
83
 
# File 'lib/models/search_alteration.rb', line 81

def altered_query_tokens=(value)
    @altered_query_tokens = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



104
105
106
107
108
109
110
111
 
# File 'lib/models/search_alteration.rb', line 104

def get_field_deserializers()
    return {
        "alteredHighlightedQueryString" => lambda {|n| @altered_highlighted_query_string = n.get_string_value() },
        "alteredQueryString" => lambda {|n| @altered_query_string = n.get_string_value() },
        "alteredQueryTokens" => lambda {|n| @altered_query_tokens = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::AlteredQueryToken.create_from_discriminator_value(pn) }) },
        "@odata.type" => lambda {|n| @odata_type = n.get_string_value() },
    }
end

#odata_type ⇒ Object

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

Returns:

  • a string



116
117
118
 
# File 'lib/models/search_alteration.rb', line 116

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



124
125
126
 
# File 'lib/models/search_alteration.rb', line 124

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) 


132
133
134
135
136
137
138
139
 
# File 'lib/models/search_alteration.rb', line 132

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    writer.write_string_value("alteredHighlightedQueryString", @altered_highlighted_query_string)
    writer.write_string_value("alteredQueryString", @altered_query_string)
    writer.write_collection_of_object_values("alteredQueryTokens", @altered_query_tokens)
    writer.write_string_value("@odata.type", @odata_type)
    writer.write_additional_data(@additional_data)
end