Class: MicrosoftGraph::Models::AggregationOption

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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Object

Instantiates a new aggregationOption and sets the default values.



58
59
60
 
# File 'lib/models/aggregation_option.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 aggregation_option

Raises:

  • (StandardError) 


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

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

def additional_data=(value)
    @additional_data = value
end

#bucket_definition ⇒ Object

Gets the bucketDefinition property value. The bucketDefinition property

Returns:

  • a bucket_aggregation_definition



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

def bucket_definition
    return @bucket_definition
end

#bucket_definition=(value) ⇒ Object

Sets the bucketDefinition property value. The bucketDefinition property

Parameters:

  • value —

    Value to set for the bucketDefinition property.

Returns:

  • a void



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

def bucket_definition=(value)
    @bucket_definition = value
end

#field ⇒ Object

Gets the field property value. Computes aggregation on the field while the field exists in current entity type. Required.

Returns:

  • a string



74
75
76
 
# File 'lib/models/aggregation_option.rb', line 74

def field
    return @field
end

#field=(value) ⇒ Object

Sets the field property value. Computes aggregation on the field while the field exists in current entity type. Required.

Parameters:

  • value —

    Value to set for the field property.

Returns:

  • a void



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

def field=(value)
    @field = 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/aggregation_option.rb', line 89

def get_field_deserializers()
    return {
        "bucketDefinition" => lambda {|n| @bucket_definition = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::BucketAggregationDefinition.create_from_discriminator_value(pn) }) },
        "field" => lambda {|n| @field = n.get_string_value() },
        "@odata.type" => lambda {|n| @odata_type = n.get_string_value() },
        "size" => lambda {|n| @size = n.get_number_value() },
    }
end

#odata_type ⇒ Object

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

Returns:

  • a string



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

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



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

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) 


117
118
119
120
121
122
123
124
 
# File 'lib/models/aggregation_option.rb', line 117

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    writer.write_object_value("bucketDefinition", @bucket_definition)
    writer.write_string_value("field", @field)
    writer.write_string_value("@odata.type", @odata_type)
    writer.write_number_value("size", @size)
    writer.write_additional_data(@additional_data)
end

#size ⇒ Object

Gets the size property value. The number of searchBucket resources to be returned. This is not required when the range is provided manually in the search request. Optional.

Returns:

  • a integer



129
130
131
 
# File 'lib/models/aggregation_option.rb', line 129

def size
    return @size
end

#size=(value) ⇒ Object

Sets the size property value. The number of searchBucket resources to be returned. This is not required when the range is provided manually in the search request. Optional.

Parameters:

  • value —

    Value to set for the size property.

Returns:

  • a void



137
138
139
 
# File 'lib/models/aggregation_option.rb', line 137

def size=(value)
    @size = value
end