Class: MicrosoftGraph::Models::Filter

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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Object

Instantiates a new filter and sets the default values.



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

Raises:

  • (StandardError) 


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

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

def additional_data=(value)
    @additional_data = value
end

#category_filter_groups ⇒ Object

Gets the categoryFilterGroups property value. Experimental Filter group set used to decide whether given object belongs and should be processed as part of this object mapping. An object is considered in scope if ANY of the groups in the collection is evaluated to true.

Returns:

  • a filter_group



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

def category_filter_groups
    return @category_filter_groups
end

#category_filter_groups=(value) ⇒ Object

Sets the categoryFilterGroups property value. Experimental Filter group set used to decide whether given object belongs and should be processed as part of this object mapping. An object is considered in scope if ANY of the groups in the collection is evaluated to true.

Parameters:

  • value —

    Value to set for the categoryFilterGroups property.

Returns:

  • a void



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

def category_filter_groups=(value)
    @category_filter_groups = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



74
75
76
77
78
79
80
81
 
# File 'lib/models/filter.rb', line 74

def get_field_deserializers()
    return {
        "categoryFilterGroups" => lambda {|n| @category_filter_groups = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::FilterGroup.create_from_discriminator_value(pn) }) },
        "groups" => lambda {|n| @groups = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::FilterGroup.create_from_discriminator_value(pn) }) },
        "inputFilterGroups" => lambda {|n| @input_filter_groups = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::FilterGroup.create_from_discriminator_value(pn) }) },
        "@odata.type" => lambda {|n| @odata_type = n.get_string_value() },
    }
end

#groups ⇒ Object

Gets the groups property value. Filter group set used to decide whether given object is in scope for provisioning. This is the filter which should be used in most cases. If an object used to satisfy this filter at a given moment, and then the object or the filter was changed so that filter is not satisfied any longer, such object will get de-provisioned’. An object is considered in scope if ANY of the groups in the collection is evaluated to true.

Returns:

  • a filter_group



86
87
88
 
# File 'lib/models/filter.rb', line 86

def groups
    return @groups
end

#groups=(value) ⇒ Object

Sets the groups property value. Filter group set used to decide whether given object is in scope for provisioning. This is the filter which should be used in most cases. If an object used to satisfy this filter at a given moment, and then the object or the filter was changed so that filter is not satisfied any longer, such object will get de-provisioned’. An object is considered in scope if ANY of the groups in the collection is evaluated to true.

Parameters:

  • value —

    Value to set for the groups property.

Returns:

  • a void



94
95
96
 
# File 'lib/models/filter.rb', line 94

def groups=(value)
    @groups = value
end

#input_filter_groups ⇒ Object

Gets the inputFilterGroups property value. Experimental Filter group set used to filter out objects at the early stage of reading them from the directory. If an object doesn’t satisfy this filter it will not be processed further. Important to understand is that if an object used to satisfy this filter at a given moment, and then the object or the filter was changed so that filter is no longer satisfied, such object will NOT get de-provisioned. An object is considered in scope if ANY of the groups in the collection is evaluated to true.

Returns:

  • a filter_group



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

def input_filter_groups
    return @input_filter_groups
end

#input_filter_groups=(value) ⇒ Object

Sets the inputFilterGroups property value. Experimental Filter group set used to filter out objects at the early stage of reading them from the directory. If an object doesn’t satisfy this filter it will not be processed further. Important to understand is that if an object used to satisfy this filter at a given moment, and then the object or the filter was changed so that filter is no longer satisfied, such object will NOT get de-provisioned. An object is considered in scope if ANY of the groups in the collection is evaluated to true.

Parameters:

  • value —

    Value to set for the inputFilterGroups property.

Returns:

  • a void



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

def input_filter_groups=(value)
    @input_filter_groups = value
end

#odata_type ⇒ Object

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

Returns:

  • a string



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

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    writer.write_collection_of_object_values("categoryFilterGroups", @category_filter_groups)
    writer.write_collection_of_object_values("groups", @groups)
    writer.write_collection_of_object_values("inputFilterGroups", @input_filter_groups)
    writer.write_string_value("@odata.type", @odata_type)
    writer.write_additional_data(@additional_data)
end