Class: MicrosoftGraph::Models::UnifiedRoleScheduleBase

Inherits:
Entity
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/unified_role_schedule_base.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Entity

#additional_data, #additional_data=, #id, #id=, #odata_type, #odata_type=

Constructor Details

#initializeObject

Instantiates a new unifiedRoleScheduleBase and sets the default values.



80
81
82
# File 'lib/models/unified_role_schedule_base.rb', line 80

def initialize()
    super
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 unified_role_schedule_base

Raises:

  • (StandardError)


118
119
120
121
122
123
124
125
126
127
128
129
130
131
# File 'lib/models/unified_role_schedule_base.rb', line 118

def self.create_from_discriminator_value(parse_node)
    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
    mapping_value_node = parse_node.get_child_node("@odata.type")
    unless mapping_value_node.nil? then
        mapping_value = mapping_value_node.get_string_value
        case mapping_value
            when "#microsoft.graph.unifiedRoleAssignmentSchedule"
                return UnifiedRoleAssignmentSchedule.new
            when "#microsoft.graph.unifiedRoleEligibilitySchedule"
                return UnifiedRoleEligibilitySchedule.new
        end
    end
    return UnifiedRoleScheduleBase.new
end

Instance Method Details

#app_scopeObject

Gets the appScope property value. Read-only property with details of the app-specific scope when the role eligibility or assignment is scoped to an app. Nullable.

Returns:

  • a app_scope



50
51
52
# File 'lib/models/unified_role_schedule_base.rb', line 50

def app_scope
    return @app_scope
end

#app_scope=(value) ⇒ Object

Sets the appScope property value. Read-only property with details of the app-specific scope when the role eligibility or assignment is scoped to an app. Nullable.

Parameters:

  • value

    Value to set for the appScope property.

Returns:

  • a void



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

def app_scope=(value)
    @app_scope = value
end

#app_scope_idObject

Gets the appScopeId property value. Identifier of the app-specific scope when the assignment or eligibility is scoped to an app. The scope of an assignment or eligibility determines the set of resources for which the principal has been granted access. App scopes are scopes that are defined and understood by this application only. Use / for tenant-wide app scopes. Use directoryScopeId to limit the scope to particular directory objects, for example, administrative units.

Returns:

  • a string



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

def app_scope_id
    return @app_scope_id
end

#app_scope_id=(value) ⇒ Object

Sets the appScopeId property value. Identifier of the app-specific scope when the assignment or eligibility is scoped to an app. The scope of an assignment or eligibility determines the set of resources for which the principal has been granted access. App scopes are scopes that are defined and understood by this application only. Use / for tenant-wide app scopes. Use directoryScopeId to limit the scope to particular directory objects, for example, administrative units.

Parameters:

  • value

    Value to set for the appScopeId property.

Returns:

  • a void



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

def app_scope_id=(value)
    @app_scope_id = value
end

#created_date_timeObject

Gets the createdDateTime property value. When the schedule was created.

Returns:

  • a date_time



87
88
89
# File 'lib/models/unified_role_schedule_base.rb', line 87

def created_date_time
    return @created_date_time
end

#created_date_time=(value) ⇒ Object

Sets the createdDateTime property value. When the schedule was created.

Parameters:

  • value

    Value to set for the createdDateTime property.

Returns:

  • a void



95
96
97
# File 'lib/models/unified_role_schedule_base.rb', line 95

def created_date_time=(value)
    @created_date_time = value
end

#created_usingObject

Gets the createdUsing property value. Identifier of the object through which this schedule was created.

Returns:

  • a string



102
103
104
# File 'lib/models/unified_role_schedule_base.rb', line 102

def created_using
    return @created_using
end

#created_using=(value) ⇒ Object

Sets the createdUsing property value. Identifier of the object through which this schedule was created.

Parameters:

  • value

    Value to set for the createdUsing property.

Returns:

  • a void



110
111
112
# File 'lib/models/unified_role_schedule_base.rb', line 110

def created_using=(value)
    @created_using = value
end

#directory_scopeObject

Gets the directoryScope property value. The directory object that is the scope of the role eligibility or assignment. Read-only.

Returns:

  • a directory_object



136
137
138
# File 'lib/models/unified_role_schedule_base.rb', line 136

def directory_scope
    return @directory_scope
end

#directory_scope=(value) ⇒ Object

Sets the directoryScope property value. The directory object that is the scope of the role eligibility or assignment. Read-only.

Parameters:

  • value

    Value to set for the directoryScope property.

Returns:

  • a void



144
145
146
# File 'lib/models/unified_role_schedule_base.rb', line 144

def directory_scope=(value)
    @directory_scope = value
end

#directory_scope_idObject

Gets the directoryScopeId property value. Identifier of the directory object representing the scope of the assignment or eligibility. The scope of an assignment or eligibility determines the set of resources for which the principal has been granted access. Directory scopes are shared scopes stored in the directory that are understood by multiple applications. Use / for tenant-wide scope. Use appScopeId to limit the scope to an application only.

Returns:

  • a string



151
152
153
# File 'lib/models/unified_role_schedule_base.rb', line 151

def directory_scope_id
    return @directory_scope_id
end

#directory_scope_id=(value) ⇒ Object

Sets the directoryScopeId property value. Identifier of the directory object representing the scope of the assignment or eligibility. The scope of an assignment or eligibility determines the set of resources for which the principal has been granted access. Directory scopes are shared scopes stored in the directory that are understood by multiple applications. Use / for tenant-wide scope. Use appScopeId to limit the scope to an application only.

Parameters:

  • value

    Value to set for the directoryScopeId property.

Returns:

  • a void



159
160
161
# File 'lib/models/unified_role_schedule_base.rb', line 159

def directory_scope_id=(value)
    @directory_scope_id = value
end

#get_field_deserializersObject

The deserialization information for the current model

Returns:

  • a i_dictionary



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
# File 'lib/models/unified_role_schedule_base.rb', line 166

def get_field_deserializers()
    return super.merge({
        "appScope" => lambda {|n| @app_scope = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::AppScope.create_from_discriminator_value(pn) }) },
        "appScopeId" => lambda {|n| @app_scope_id = n.get_string_value() },
        "createdDateTime" => lambda {|n| @created_date_time = n.get_date_time_value() },
        "createdUsing" => lambda {|n| @created_using = n.get_string_value() },
        "directoryScope" => lambda {|n| @directory_scope = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::DirectoryObject.create_from_discriminator_value(pn) }) },
        "directoryScopeId" => lambda {|n| @directory_scope_id = n.get_string_value() },
        "modifiedDateTime" => lambda {|n| @modified_date_time = n.get_date_time_value() },
        "principal" => lambda {|n| @principal = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::DirectoryObject.create_from_discriminator_value(pn) }) },
        "principalId" => lambda {|n| @principal_id = n.get_string_value() },
        "roleDefinition" => lambda {|n| @role_definition = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::UnifiedRoleDefinition.create_from_discriminator_value(pn) }) },
        "roleDefinitionId" => lambda {|n| @role_definition_id = n.get_string_value() },
        "status" => lambda {|n| @status = n.get_string_value() },
    })
end

#modified_date_timeObject

Gets the modifiedDateTime property value. When the schedule was last modified.

Returns:

  • a date_time



186
187
188
# File 'lib/models/unified_role_schedule_base.rb', line 186

def modified_date_time
    return @modified_date_time
end

#modified_date_time=(value) ⇒ Object

Sets the modifiedDateTime property value. When the schedule was last modified.

Parameters:

  • value

    Value to set for the modifiedDateTime property.

Returns:

  • a void



194
195
196
# File 'lib/models/unified_role_schedule_base.rb', line 194

def modified_date_time=(value)
    @modified_date_time = value
end

#principalObject

Gets the principal property value. The principal that’s getting a role assignment or that’s eligible for a role through the request.

Returns:

  • a directory_object



201
202
203
# File 'lib/models/unified_role_schedule_base.rb', line 201

def principal
    return @principal
end

#principal=(value) ⇒ Object

Sets the principal property value. The principal that’s getting a role assignment or that’s eligible for a role through the request.

Parameters:

  • value

    Value to set for the principal property.

Returns:

  • a void



209
210
211
# File 'lib/models/unified_role_schedule_base.rb', line 209

def principal=(value)
    @principal = value
end

#principal_idObject

Gets the principalId property value. Identifier of the principal that has been granted the role assignment or eligibility.

Returns:

  • a string



216
217
218
# File 'lib/models/unified_role_schedule_base.rb', line 216

def principal_id
    return @principal_id
end

#principal_id=(value) ⇒ Object

Sets the principalId property value. Identifier of the principal that has been granted the role assignment or eligibility.

Parameters:

  • value

    Value to set for the principalId property.

Returns:

  • a void



224
225
226
# File 'lib/models/unified_role_schedule_base.rb', line 224

def principal_id=(value)
    @principal_id = value
end

#role_definitionObject

Gets the roleDefinition property value. Detailed information for the roleDefinition object that is referenced through the roleDefinitionId property.

Returns:

  • a unified_role_definition



231
232
233
# File 'lib/models/unified_role_schedule_base.rb', line 231

def role_definition
    return @role_definition
end

#role_definition=(value) ⇒ Object

Sets the roleDefinition property value. Detailed information for the roleDefinition object that is referenced through the roleDefinitionId property.

Parameters:

  • value

    Value to set for the roleDefinition property.

Returns:

  • a void



239
240
241
# File 'lib/models/unified_role_schedule_base.rb', line 239

def role_definition=(value)
    @role_definition = value
end

#role_definition_idObject

Gets the roleDefinitionId property value. Identifier of the unifiedRoleDefinition object that is being assigned to the principal or that a principal is eligible for.

Returns:

  • a string



246
247
248
# File 'lib/models/unified_role_schedule_base.rb', line 246

def role_definition_id
    return @role_definition_id
end

#role_definition_id=(value) ⇒ Object

Sets the roleDefinitionId property value. Identifier of the unifiedRoleDefinition object that is being assigned to the principal or that a principal is eligible for.

Parameters:

  • value

    Value to set for the roleDefinitionId property.

Returns:

  • a void



254
255
256
# File 'lib/models/unified_role_schedule_base.rb', line 254

def role_definition_id=(value)
    @role_definition_id = 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)


262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
# File 'lib/models/unified_role_schedule_base.rb', line 262

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_object_value("appScope", @app_scope)
    writer.write_string_value("appScopeId", @app_scope_id)
    writer.write_date_time_value("createdDateTime", @created_date_time)
    writer.write_string_value("createdUsing", @created_using)
    writer.write_object_value("directoryScope", @directory_scope)
    writer.write_string_value("directoryScopeId", @directory_scope_id)
    writer.write_date_time_value("modifiedDateTime", @modified_date_time)
    writer.write_object_value("principal", @principal)
    writer.write_string_value("principalId", @principal_id)
    writer.write_object_value("roleDefinition", @role_definition)
    writer.write_string_value("roleDefinitionId", @role_definition_id)
    writer.write_string_value("status", @status)
end

#statusObject

Gets the status property value. The status of the role assignment or eligibility request.

Returns:

  • a string



282
283
284
# File 'lib/models/unified_role_schedule_base.rb', line 282

def status
    return @status
end

#status=(value) ⇒ Object

Sets the status property value. The status of the role assignment or eligibility request.

Parameters:

  • value

    Value to set for the status property.

Returns:

  • a void



290
291
292
# File 'lib/models/unified_role_schedule_base.rb', line 290

def status=(value)
    @status = value
end