Class: MicrosoftGraph::Models::OptionalClaim

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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Object

Instantiates a new optionalClaim and sets the default values.



61
62
63
 
# File 'lib/models/optional_claim.rb', line 61

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 optional_claim

Raises:

  • (StandardError) 


69
70
71
72
 
# File 'lib/models/optional_claim.rb', line 69

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



31
32
33
 
# File 'lib/models/optional_claim.rb', line 31

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



39
40
41
 
# File 'lib/models/optional_claim.rb', line 39

def additional_data=(value)
    @additional_data = value
end

#additional_properties ⇒ Object

Gets the additionalProperties property value. Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property.

Returns:

  • a string



46
47
48
 
# File 'lib/models/optional_claim.rb', line 46

def additional_properties
    return @additional_properties
end

#additional_properties=(value) ⇒ Object

Sets the additionalProperties property value. Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property.

Parameters:

  • value —

    Value to set for the additionalProperties property.

Returns:

  • a void



54
55
56
 
# File 'lib/models/optional_claim.rb', line 54

def additional_properties=(value)
    @additional_properties = value
end

#essential ⇒ Object

Gets the essential property value. If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false.

Returns:

  • a boolean



77
78
79
 
# File 'lib/models/optional_claim.rb', line 77

def essential
    return @essential
end

#essential=(value) ⇒ Object

Sets the essential property value. If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false.

Parameters:

  • value —

    Value to set for the essential property.

Returns:

  • a void



85
86
87
 
# File 'lib/models/optional_claim.rb', line 85

def essential=(value)
    @essential = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



92
93
94
95
96
97
98
99
100
 
# File 'lib/models/optional_claim.rb', line 92

def get_field_deserializers()
    return {
        "additionalProperties" => lambda {|n| @additional_properties = n.get_collection_of_primitive_values(String) },
        "essential" => lambda {|n| @essential = n.get_boolean_value() },
        "name" => lambda {|n| @name = n.get_string_value() },
        "@odata.type" => lambda {|n| @odata_type = n.get_string_value() },
        "source" => lambda {|n| @source = n.get_string_value() },
    }
end

#name ⇒ Object

Gets the name property value. The name of the optional claim.

Returns:

  • a string



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

def name
    return @name
end

#name=(value) ⇒ Object

Sets the name property value. The name of the optional claim.

Parameters:

  • value —

    Value to set for the name property.

Returns:

  • a void



113
114
115
 
# File 'lib/models/optional_claim.rb', line 113

def name=(value)
    @name = value
end

#odata_type ⇒ Object

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

Returns:

  • a string



120
121
122
 
# File 'lib/models/optional_claim.rb', line 120

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



128
129
130
 
# File 'lib/models/optional_claim.rb', line 128

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) 


136
137
138
139
140
141
142
143
144
 
# File 'lib/models/optional_claim.rb', line 136

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    writer.write_collection_of_primitive_values("additionalProperties", @additional_properties)
    writer.write_boolean_value("essential", @essential)
    writer.write_string_value("name", @name)
    writer.write_string_value("@odata.type", @odata_type)
    writer.write_string_value("source", @source)
    writer.write_additional_data(@additional_data)
end

#source ⇒ Object

Gets the source property value. The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object.

Returns:

  • a string



149
150
151
 
# File 'lib/models/optional_claim.rb', line 149

def source
    return @source
end

#source=(value) ⇒ Object

Sets the source property value. The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object.

Parameters:

  • value —

    Value to set for the source property.

Returns:

  • a void



157
158
159
 
# File 'lib/models/optional_claim.rb', line 157

def source=(value)
    @source = value
end