Class: MicrosoftGraph::Models::SearchBucket

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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Object

Instantiates a new searchBucket and sets the default values.



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

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_bucket

Raises:

  • (StandardError) 


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

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

def additional_data=(value)
    @additional_data = value
end

#aggregation_filter_token ⇒ Object

Gets the aggregationFilterToken property value. A token containing the encoded filter to aggregate search matches by the specific key value. To use the filter, pass the token as part of the aggregationFilter property in a searchRequest object, in the format ‘field:/’aggregationFilterToken/”. See an example.

Returns:

  • a string



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

def aggregation_filter_token
    return @aggregation_filter_token
end

#aggregation_filter_token=(value) ⇒ Object

Sets the aggregationFilterToken property value. A token containing the encoded filter to aggregate search matches by the specific key value. To use the filter, pass the token as part of the aggregationFilter property in a searchRequest object, in the format ‘field:/’aggregationFilterToken/”. See an example.

Parameters:

  • value —

    Value to set for the aggregationFilterToken property.

Returns:

  • a void



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

def aggregation_filter_token=(value)
    @aggregation_filter_token = value
end

#count ⇒ Object

Gets the count property value. The approximate number of search matches that share the same value specified in the key property. Note that this number is not the exact number of matches.

Returns:

  • a integer



65
66
67
 
# File 'lib/models/search_bucket.rb', line 65

def count
    return @count
end

#count=(value) ⇒ Object

Sets the count property value. The approximate number of search matches that share the same value specified in the key property. Note that this number is not the exact number of matches.

Parameters:

  • value —

    Value to set for the count property.

Returns:

  • a void



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

def count=(value)
    @count = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



89
90
91
92
93
94
95
96
 
# File 'lib/models/search_bucket.rb', line 89

def get_field_deserializers()
    return {
        "aggregationFilterToken" => lambda {|n| @aggregation_filter_token = n.get_string_value() },
        "count" => lambda {|n| @count = n.get_number_value() },
        "key" => lambda {|n| @key = n.get_string_value() },
        "@odata.type" => lambda {|n| @odata_type = n.get_string_value() },
    }
end

#key ⇒ Object

Gets the key property value. The discrete value of the field that an aggregation was computed on.

Returns:

  • a string



101
102
103
 
# File 'lib/models/search_bucket.rb', line 101

def key
    return @key
end

#key=(value) ⇒ Object

Sets the key property value. The discrete value of the field that an aggregation was computed on.

Parameters:

  • value —

    Value to set for the key property.

Returns:

  • a void



109
110
111
 
# File 'lib/models/search_bucket.rb', line 109

def key=(value)
    @key = value
end

#odata_type ⇒ Object

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

Returns:

  • a string



116
117
118
 
# File 'lib/models/search_bucket.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_bucket.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_bucket.rb', line 132

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    writer.write_string_value("aggregationFilterToken", @aggregation_filter_token)
    writer.write_number_value("count", @count)
    writer.write_string_value("key", @key)
    writer.write_string_value("@odata.type", @odata_type)
    writer.write_additional_data(@additional_data)
end