Class: MicrosoftGraph::Models::AccessReviewScheduleDefinition

Inherits:
Entity
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/access_review_schedule_definition.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

#initialize ⇒ Object

Instantiates a new accessReviewScheduleDefinition and sets the default values.



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

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 access_review_schedule_definition

Raises:

  • (StandardError) 


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

def self.create_from_discriminator_value(parse_node)
    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
    return AccessReviewScheduleDefinition.new
end

Instance Method Details

#additional_notification_recipients ⇒ Object

Gets the additionalNotificationRecipients property value. Defines the list of additional users or group members to be notified of the access review progress.

Returns:

  • a access_review_notification_recipient_item



59
60
61
 
# File 'lib/models/access_review_schedule_definition.rb', line 59

def additional_notification_recipients
    return @additional_notification_recipients
end

#additional_notification_recipients=(value) ⇒ Object

Sets the additionalNotificationRecipients property value. Defines the list of additional users or group members to be notified of the access review progress.

Parameters:

  • value —

    Value to set for the additionalNotificationRecipients property.

Returns:

  • a void



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

def additional_notification_recipients=(value)
    @additional_notification_recipients = value
end

#created_by ⇒ Object

Gets the createdBy property value. User who created this review. Read-only.

Returns:

  • a user_identity



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

def created_by
    return @created_by
end

#created_by=(value) ⇒ Object

Sets the createdBy property value. User who created this review. Read-only.

Parameters:

  • value —

    Value to set for the createdBy property.

Returns:

  • a void



89
90
91
 
# File 'lib/models/access_review_schedule_definition.rb', line 89

def created_by=(value)
    @created_by = value
end

#created_date_time ⇒ Object

Gets the createdDateTime property value. Timestamp when the access review series was created. Supports $select. Read-only.

Returns:

  • a date_time



96
97
98
 
# File 'lib/models/access_review_schedule_definition.rb', line 96

def created_date_time
    return @created_date_time
end

#created_date_time=(value) ⇒ Object

Sets the createdDateTime property value. Timestamp when the access review series was created. Supports $select. Read-only.

Parameters:

  • value —

    Value to set for the createdDateTime property.

Returns:

  • a void



104
105
106
 
# File 'lib/models/access_review_schedule_definition.rb', line 104

def created_date_time=(value)
    @created_date_time = value
end

#description_for_admins ⇒ Object

Gets the descriptionForAdmins property value. Description provided by review creators to provide more context of the review to admins. Supports $select.

Returns:

  • a string



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

def description_for_admins
    return @description_for_admins
end

#description_for_admins=(value) ⇒ Object

Sets the descriptionForAdmins property value. Description provided by review creators to provide more context of the review to admins. Supports $select.

Parameters:

  • value —

    Value to set for the descriptionForAdmins property.

Returns:

  • a void



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

def description_for_admins=(value)
    @description_for_admins = value
end

#description_for_reviewers ⇒ Object

Gets the descriptionForReviewers property value. Description provided by review creators to provide more context of the review to reviewers. Reviewers will see this description in the email sent to them requesting their review. Email notifications support up to 256 characters. Supports $select.

Returns:

  • a string



135
136
137
 
# File 'lib/models/access_review_schedule_definition.rb', line 135

def description_for_reviewers
    return @description_for_reviewers
end

#description_for_reviewers=(value) ⇒ Object

Sets the descriptionForReviewers property value. Description provided by review creators to provide more context of the review to reviewers. Reviewers will see this description in the email sent to them requesting their review. Email notifications support up to 256 characters. Supports $select.

Parameters:

  • value —

    Value to set for the descriptionForReviewers property.

Returns:

  • a void



143
144
145
 
# File 'lib/models/access_review_schedule_definition.rb', line 143

def description_for_reviewers=(value)
    @description_for_reviewers = value
end

#display_name ⇒ Object

Gets the displayName property value. Name of the access review series. Supports $select and $orderBy. Required on create.

Returns:

  • a string



150
151
152
 
# File 'lib/models/access_review_schedule_definition.rb', line 150

def display_name
    return @display_name
end

#display_name=(value) ⇒ Object

Sets the displayName property value. Name of the access review series. Supports $select and $orderBy. Required on create.

Parameters:

  • value —

    Value to set for the displayName property.

Returns:

  • a void



158
159
160
 
# File 'lib/models/access_review_schedule_definition.rb', line 158

def display_name=(value)
    @display_name = value
end

#fallback_reviewers ⇒ Object

Gets the fallbackReviewers property value. This collection of reviewer scopes is used to define the list of fallback reviewers. These fallback reviewers will be notified to take action if no users are found from the list of reviewers specified. This could occur when either the group owner is specified as the reviewer but the group owner does not exist, or manager is specified as reviewer but a user’s manager does not exist. See accessReviewReviewerScope. Replaces backupReviewers. Supports $select. NOTE: The value of this property will be ignored if fallback reviewers are assigned through the stageSettings property.

Returns:

  • a access_review_reviewer_scope



165
166
167
 
# File 'lib/models/access_review_schedule_definition.rb', line 165

def fallback_reviewers
    return @fallback_reviewers
end

#fallback_reviewers=(value) ⇒ Object

Sets the fallbackReviewers property value. This collection of reviewer scopes is used to define the list of fallback reviewers. These fallback reviewers will be notified to take action if no users are found from the list of reviewers specified. This could occur when either the group owner is specified as the reviewer but the group owner does not exist, or manager is specified as reviewer but a user’s manager does not exist. See accessReviewReviewerScope. Replaces backupReviewers. Supports $select. NOTE: The value of this property will be ignored if fallback reviewers are assigned through the stageSettings property.

Parameters:

  • value —

    Value to set for the fallbackReviewers property.

Returns:

  • a void



173
174
175
 
# File 'lib/models/access_review_schedule_definition.rb', line 173

def fallback_reviewers=(value)
    @fallback_reviewers = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/models/access_review_schedule_definition.rb', line 180

def get_field_deserializers()
    return super.merge({
        "additionalNotificationRecipients" => lambda {|n| @additional_notification_recipients = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::AccessReviewNotificationRecipientItem.create_from_discriminator_value(pn) }) },
        "createdBy" => lambda {|n| @created_by = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::UserIdentity.create_from_discriminator_value(pn) }) },
        "createdDateTime" => lambda {|n| @created_date_time = n.get_date_time_value() },
        "descriptionForAdmins" => lambda {|n| @description_for_admins = n.get_string_value() },
        "descriptionForReviewers" => lambda {|n| @description_for_reviewers = n.get_string_value() },
        "displayName" => lambda {|n| @display_name = n.get_string_value() },
        "fallbackReviewers" => lambda {|n| @fallback_reviewers = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::AccessReviewReviewerScope.create_from_discriminator_value(pn) }) },
        "instanceEnumerationScope" => lambda {|n| @instance_enumeration_scope = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::AccessReviewScope.create_from_discriminator_value(pn) }) },
        "instances" => lambda {|n| @instances = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::AccessReviewInstance.create_from_discriminator_value(pn) }) },
        "lastModifiedDateTime" => lambda {|n| @last_modified_date_time = n.get_date_time_value() },
        "reviewers" => lambda {|n| @reviewers = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::AccessReviewReviewerScope.create_from_discriminator_value(pn) }) },
        "scope" => lambda {|n| @scope = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::AccessReviewScope.create_from_discriminator_value(pn) }) },
        "settings" => lambda {|n| @settings = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::AccessReviewScheduleSettings.create_from_discriminator_value(pn) }) },
        "stageSettings" => lambda {|n| @stage_settings = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::AccessReviewStageSettings.create_from_discriminator_value(pn) }) },
        "status" => lambda {|n| @status = n.get_string_value() },
    })
end

#instance_enumeration_scope ⇒ Object

Gets the instanceEnumerationScope property value. This property is required when scoping a review to guest users’ access across all Microsoft 365 groups and determines which Microsoft 365 groups are reviewed. Each group will become a unique accessReviewInstance of the access review series. For supported scopes, see accessReviewScope. Supports $select. For examples of options for configuring instanceEnumerationScope, see Configure the scope of your access review definition using the Microsoft Graph API.

Returns:

  • a access_review_scope



203
204
205
 
# File 'lib/models/access_review_schedule_definition.rb', line 203

def instance_enumeration_scope
    return @instance_enumeration_scope
end

#instance_enumeration_scope=(value) ⇒ Object

Sets the instanceEnumerationScope property value. This property is required when scoping a review to guest users’ access across all Microsoft 365 groups and determines which Microsoft 365 groups are reviewed. Each group will become a unique accessReviewInstance of the access review series. For supported scopes, see accessReviewScope. Supports $select. For examples of options for configuring instanceEnumerationScope, see Configure the scope of your access review definition using the Microsoft Graph API.

Parameters:

  • value —

    Value to set for the instanceEnumerationScope property.

Returns:

  • a void



211
212
213
 
# File 'lib/models/access_review_schedule_definition.rb', line 211

def instance_enumeration_scope=(value)
    @instance_enumeration_scope = value
end

#instances ⇒ Object

Gets the instances property value. If the accessReviewScheduleDefinition is a recurring access review, instances represent each recurrence. A review that does not recur will have exactly one instance. Instances also represent each unique resource under review in the accessReviewScheduleDefinition. If a review has multiple resources and multiple instances, each resource will have a unique instance for each recurrence.

Returns:

  • a access_review_instance



218
219
220
 
# File 'lib/models/access_review_schedule_definition.rb', line 218

def instances
    return @instances
end

#instances=(value) ⇒ Object

Sets the instances property value. If the accessReviewScheduleDefinition is a recurring access review, instances represent each recurrence. A review that does not recur will have exactly one instance. Instances also represent each unique resource under review in the accessReviewScheduleDefinition. If a review has multiple resources and multiple instances, each resource will have a unique instance for each recurrence.

Parameters:

  • value —

    Value to set for the instances property.

Returns:

  • a void



226
227
228
 
# File 'lib/models/access_review_schedule_definition.rb', line 226

def instances=(value)
    @instances = value
end

#last_modified_date_time ⇒ Object

Gets the lastModifiedDateTime property value. Timestamp when the access review series was last modified. Supports $select. Read-only.

Returns:

  • a date_time



233
234
235
 
# File 'lib/models/access_review_schedule_definition.rb', line 233

def last_modified_date_time
    return @last_modified_date_time
end

#last_modified_date_time=(value) ⇒ Object

Sets the lastModifiedDateTime property value. Timestamp when the access review series was last modified. Supports $select. Read-only.

Parameters:

  • value —

    Value to set for the lastModifiedDateTime property.

Returns:

  • a void



241
242
243
 
# File 'lib/models/access_review_schedule_definition.rb', line 241

def last_modified_date_time=(value)
    @last_modified_date_time = value
end

#reviewers ⇒ Object

Gets the reviewers property value. This collection of access review scopes is used to define who are the reviewers. The reviewers property is only updatable if individual users are assigned as reviewers. Required on create. Supports $select. For examples of options for assigning reviewers, see Assign reviewers to your access review definition using the Microsoft Graph API. NOTE: The value of this property will be ignored if reviewers are assigned through the stageSettings property.

Returns:

  • a access_review_reviewer_scope



248
249
250
 
# File 'lib/models/access_review_schedule_definition.rb', line 248

def reviewers
    return @reviewers
end

#reviewers=(value) ⇒ Object

Sets the reviewers property value. This collection of access review scopes is used to define who are the reviewers. The reviewers property is only updatable if individual users are assigned as reviewers. Required on create. Supports $select. For examples of options for assigning reviewers, see Assign reviewers to your access review definition using the Microsoft Graph API. NOTE: The value of this property will be ignored if reviewers are assigned through the stageSettings property.

Parameters:

  • value —

    Value to set for the reviewers property.

Returns:

  • a void



256
257
258
 
# File 'lib/models/access_review_schedule_definition.rb', line 256

def reviewers=(value)
    @reviewers = value
end

#scope ⇒ Object

Gets the scope property value. Defines the entities whose access is reviewed. For supported scopes, see accessReviewScope. Required on create. Supports $select and $filter (contains only). For examples of options for configuring scope, see Configure the scope of your access review definition using the Microsoft Graph API.

Returns:

  • a access_review_scope



263
264
265
 
# File 'lib/models/access_review_schedule_definition.rb', line 263

def scope
    return @scope
end

#scope=(value) ⇒ Object

Sets the scope property value. Defines the entities whose access is reviewed. For supported scopes, see accessReviewScope. Required on create. Supports $select and $filter (contains only). For examples of options for configuring scope, see Configure the scope of your access review definition using the Microsoft Graph API.

Parameters:

  • value —

    Value to set for the scope property.

Returns:

  • a void



271
272
273
 
# File 'lib/models/access_review_schedule_definition.rb', line 271

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


279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/models/access_review_schedule_definition.rb', line 279

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_collection_of_object_values("additionalNotificationRecipients", @additional_notification_recipients)
    writer.write_object_value("createdBy", @created_by)
    writer.write_date_time_value("createdDateTime", @created_date_time)
    writer.write_string_value("descriptionForAdmins", @description_for_admins)
    writer.write_string_value("descriptionForReviewers", @description_for_reviewers)
    writer.write_string_value("displayName", @display_name)
    writer.write_collection_of_object_values("fallbackReviewers", @fallback_reviewers)
    writer.write_object_value("instanceEnumerationScope", @instance_enumeration_scope)
    writer.write_collection_of_object_values("instances", @instances)
    writer.write_date_time_value("lastModifiedDateTime", @last_modified_date_time)
    writer.write_collection_of_object_values("reviewers", @reviewers)
    writer.write_object_value("scope", @scope)
    writer.write_object_value("settings", @settings)
    writer.write_collection_of_object_values("stageSettings", @stage_settings)
    writer.write_string_value("status", @status)
end

#settings ⇒ Object

Gets the settings property value. The settings for an access review series, see type definition below. Supports $select. Required on create.

Returns:

  • a access_review_schedule_settings



302
303
304
 
# File 'lib/models/access_review_schedule_definition.rb', line 302

def settings
    return @settings
end

#settings=(value) ⇒ Object

Sets the settings property value. The settings for an access review series, see type definition below. Supports $select. Required on create.

Parameters:

  • value —

    Value to set for the settings property.

Returns:

  • a void



310
311
312
 
# File 'lib/models/access_review_schedule_definition.rb', line 310

def settings=(value)
    @settings = value
end

#stage_settings ⇒ Object

Gets the stageSettings property value. Required only for a multi-stage access review to define the stages and their settings. You can break down each review instance into up to three sequential stages, where each stage can have a different set of reviewers, fallback reviewers, and settings. Stages will be created sequentially based on the dependsOn property. Optional. When this property is defined, its settings are used instead of the corresponding settings in the accessReviewScheduleDefinition object and its settings, reviewers, and fallbackReviewers properties.

Returns:

  • a access_review_stage_settings



317
318
319
 
# File 'lib/models/access_review_schedule_definition.rb', line 317

def stage_settings
    return @stage_settings
end

#stage_settings=(value) ⇒ Object

Sets the stageSettings property value. Required only for a multi-stage access review to define the stages and their settings. You can break down each review instance into up to three sequential stages, where each stage can have a different set of reviewers, fallback reviewers, and settings. Stages will be created sequentially based on the dependsOn property. Optional. When this property is defined, its settings are used instead of the corresponding settings in the accessReviewScheduleDefinition object and its settings, reviewers, and fallbackReviewers properties.

Parameters:

  • value —

    Value to set for the stageSettings property.

Returns:

  • a void



325
326
327
 
# File 'lib/models/access_review_schedule_definition.rb', line 325

def stage_settings=(value)
    @stage_settings = value
end

#status ⇒ Object

Gets the status property value. This read-only field specifies the status of an access review. The typical states include Initializing, NotStarted, Starting, InProgress, Completing, Completed, AutoReviewing, and AutoReviewed. Supports $select, $orderby, and $filter (eq only). Read-only.

Returns:

  • a string



332
333
334
 
# File 'lib/models/access_review_schedule_definition.rb', line 332

def status
    return @status
end

#status=(value) ⇒ Object

Sets the status property value. This read-only field specifies the status of an access review. The typical states include Initializing, NotStarted, Starting, InProgress, Completing, Completed, AutoReviewing, and AutoReviewed. Supports $select, $orderby, and $filter (eq only). Read-only.

Parameters:

  • value —

    Value to set for the status property.

Returns:

  • a void



340
341
342
 
# File 'lib/models/access_review_schedule_definition.rb', line 340

def status=(value)
    @status = value
end