Class: MicrosoftGraph::Models::SearchAlterationOptions

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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Object

Instantiates a new searchAlterationOptions and sets the default values.



40
41
42
 
# File 'lib/models/search_alteration_options.rb', line 40

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_options

Raises:

  • (StandardError) 


48
49
50
51
 
# File 'lib/models/search_alteration_options.rb', line 48

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



25
26
27
 
# File 'lib/models/search_alteration_options.rb', line 25

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



33
34
35
 
# File 'lib/models/search_alteration_options.rb', line 33

def additional_data=(value)
    @additional_data = value
end

#enable_modification ⇒ Object

Gets the enableModification property value. Indicates whether spelling modifications are enabled. If enabled, the user will get the search results for the corrected query in case of no results for the original query with typos. The response will also include the spelling modification information in the queryAlterationResponse property. Optional.

Returns:

  • a boolean



56
57
58
 
# File 'lib/models/search_alteration_options.rb', line 56

def enable_modification
    return @enable_modification
end

#enable_modification=(value) ⇒ Object

Sets the enableModification property value. Indicates whether spelling modifications are enabled. If enabled, the user will get the search results for the corrected query in case of no results for the original query with typos. The response will also include the spelling modification information in the queryAlterationResponse property. Optional.

Parameters:

  • value —

    Value to set for the enableModification property.

Returns:

  • a void



64
65
66
 
# File 'lib/models/search_alteration_options.rb', line 64

def enable_modification=(value)
    @enable_modification = value
end

#enable_suggestion ⇒ Object

Gets the enableSuggestion property value. Indicates whether spelling suggestions are enabled. If enabled, the user will get the search results for the original search query and suggestions for spelling correction in the queryAlterationResponse property of the response for the typos in the query. Optional.

Returns:

  • a boolean



71
72
73
 
# File 'lib/models/search_alteration_options.rb', line 71

def enable_suggestion
    return @enable_suggestion
end

#enable_suggestion=(value) ⇒ Object

Sets the enableSuggestion property value. Indicates whether spelling suggestions are enabled. If enabled, the user will get the search results for the original search query and suggestions for spelling correction in the queryAlterationResponse property of the response for the typos in the query. Optional.

Parameters:

  • value —

    Value to set for the enableSuggestion property.

Returns:

  • a void



79
80
81
 
# File 'lib/models/search_alteration_options.rb', line 79

def enable_suggestion=(value)
    @enable_suggestion = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



86
87
88
89
90
91
92
 
# File 'lib/models/search_alteration_options.rb', line 86

def get_field_deserializers()
    return {
        "enableModification" => lambda {|n| @enable_modification = n.get_boolean_value() },
        "enableSuggestion" => lambda {|n| @enable_suggestion = n.get_boolean_value() },
        "@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



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

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



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

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) 


113
114
115
116
117
118
119
 
# File 'lib/models/search_alteration_options.rb', line 113

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    writer.write_boolean_value("enableModification", @enable_modification)
    writer.write_boolean_value("enableSuggestion", @enable_suggestion)
    writer.write_string_value("@odata.type", @odata_type)
    writer.write_additional_data(@additional_data)
end