forked from microsoftgraph/msgraph-sdk-php
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathAccessReviewScheduleDefinition.php
More file actions
491 lines (455 loc) · 19.4 KB
/
Copy pathAccessReviewScheduleDefinition.php
File metadata and controls
491 lines (455 loc) · 19.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
<?php
/**
* Copyright (c) Microsoft Corporation. All Rights Reserved. Licensed under the MIT License. See License in the project root for license information.
*
* AccessReviewScheduleDefinition File
* PHP version 7
*
* @category Library
* @package Microsoft.Graph
* @copyright (c) Microsoft Corporation. All rights reserved.
* @license https://opensource.org/licenses/MIT MIT License
* @link https://graph.microsoft.com
*/
namespace Microsoft\Graph\Model;
/**
* AccessReviewScheduleDefinition class
*
* @category Model
* @package Microsoft.Graph
* @copyright (c) Microsoft Corporation. All rights reserved.
* @license https://opensource.org/licenses/MIT MIT License
* @link https://graph.microsoft.com
*/
class AccessReviewScheduleDefinition extends Entity
{
/**
* Gets the additionalNotificationRecipients
* Defines the list of additional users or group members to be notified of the access review progress.
*
* @return array|null The additionalNotificationRecipients
*/
public function getAdditionalNotificationRecipients()
{
if (array_key_exists("additionalNotificationRecipients", $this->_propDict)) {
return $this->_propDict["additionalNotificationRecipients"];
} else {
return null;
}
}
/**
* Sets the additionalNotificationRecipients
* Defines the list of additional users or group members to be notified of the access review progress.
*
* @param AccessReviewNotificationRecipientItem[] $val The additionalNotificationRecipients
*
* @return AccessReviewScheduleDefinition
*/
public function setAdditionalNotificationRecipients($val)
{
$this->_propDict["additionalNotificationRecipients"] = $val;
return $this;
}
/**
* Gets the createdBy
* User who created this review. Read-only.
*
* @return UserIdentity|null The createdBy
*/
public function getCreatedBy()
{
if (array_key_exists("createdBy", $this->_propDict)) {
if (is_a($this->_propDict["createdBy"], "\Microsoft\Graph\Model\UserIdentity") || is_null($this->_propDict["createdBy"])) {
return $this->_propDict["createdBy"];
} else {
$this->_propDict["createdBy"] = new UserIdentity($this->_propDict["createdBy"]);
return $this->_propDict["createdBy"];
}
}
return null;
}
/**
* Sets the createdBy
* User who created this review. Read-only.
*
* @param UserIdentity $val The createdBy
*
* @return AccessReviewScheduleDefinition
*/
public function setCreatedBy($val)
{
$this->_propDict["createdBy"] = $val;
return $this;
}
/**
* Gets the createdDateTime
* Timestamp when the access review series was created. Supports $select. Read-only.
*
* @return \DateTime|null The createdDateTime
*/
public function getCreatedDateTime()
{
if (array_key_exists("createdDateTime", $this->_propDict)) {
if (is_a($this->_propDict["createdDateTime"], "\DateTime") || is_null($this->_propDict["createdDateTime"])) {
return $this->_propDict["createdDateTime"];
} else {
$this->_propDict["createdDateTime"] = new \DateTime($this->_propDict["createdDateTime"]);
return $this->_propDict["createdDateTime"];
}
}
return null;
}
/**
* Sets the createdDateTime
* Timestamp when the access review series was created. Supports $select. Read-only.
*
* @param \DateTime $val The createdDateTime
*
* @return AccessReviewScheduleDefinition
*/
public function setCreatedDateTime($val)
{
$this->_propDict["createdDateTime"] = $val;
return $this;
}
/**
* Gets the descriptionForAdmins
* Description provided by review creators to provide more context of the review to admins. Supports $select.
*
* @return string|null The descriptionForAdmins
*/
public function getDescriptionForAdmins()
{
if (array_key_exists("descriptionForAdmins", $this->_propDict)) {
return $this->_propDict["descriptionForAdmins"];
} else {
return null;
}
}
/**
* Sets the descriptionForAdmins
* Description provided by review creators to provide more context of the review to admins. Supports $select.
*
* @param string $val The descriptionForAdmins
*
* @return AccessReviewScheduleDefinition
*/
public function setDescriptionForAdmins($val)
{
$this->_propDict["descriptionForAdmins"] = $val;
return $this;
}
/**
* Gets the descriptionForReviewers
* Description provided by review creators to provide more context of the review to reviewers. Reviewers see this description in the email sent to them requesting their review. Email notifications support up to 256 characters. Supports $select.
*
* @return string|null The descriptionForReviewers
*/
public function getDescriptionForReviewers()
{
if (array_key_exists("descriptionForReviewers", $this->_propDict)) {
return $this->_propDict["descriptionForReviewers"];
} else {
return null;
}
}
/**
* Sets the descriptionForReviewers
* Description provided by review creators to provide more context of the review to reviewers. Reviewers see this description in the email sent to them requesting their review. Email notifications support up to 256 characters. Supports $select.
*
* @param string $val The descriptionForReviewers
*
* @return AccessReviewScheduleDefinition
*/
public function setDescriptionForReviewers($val)
{
$this->_propDict["descriptionForReviewers"] = $val;
return $this;
}
/**
* Gets the displayName
* Name of the access review series. Supports $select and $orderby. Required on create.
*
* @return string|null The displayName
*/
public function getDisplayName()
{
if (array_key_exists("displayName", $this->_propDict)) {
return $this->_propDict["displayName"];
} else {
return null;
}
}
/**
* Sets the displayName
* Name of the access review series. Supports $select and $orderby. Required on create.
*
* @param string $val The displayName
*
* @return AccessReviewScheduleDefinition
*/
public function setDisplayName($val)
{
$this->_propDict["displayName"] = $val;
return $this;
}
/**
* Gets the fallbackReviewers
* This collection of reviewer scopes is used to define the list of fallback reviewers. These fallback reviewers are 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 doesn't exist, or manager is specified as reviewer but a user's manager doesn't 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.
*
* @return array|null The fallbackReviewers
*/
public function getFallbackReviewers()
{
if (array_key_exists("fallbackReviewers", $this->_propDict)) {
return $this->_propDict["fallbackReviewers"];
} else {
return null;
}
}
/**
* Sets the fallbackReviewers
* This collection of reviewer scopes is used to define the list of fallback reviewers. These fallback reviewers are 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 doesn't exist, or manager is specified as reviewer but a user's manager doesn't 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.
*
* @param AccessReviewReviewerScope[] $val The fallbackReviewers
*
* @return AccessReviewScheduleDefinition
*/
public function setFallbackReviewers($val)
{
$this->_propDict["fallbackReviewers"] = $val;
return $this;
}
/**
* Gets the instanceEnumerationScope
* 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 becomes 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.
*
* @return AccessReviewScope|null The instanceEnumerationScope
*/
public function getInstanceEnumerationScope()
{
if (array_key_exists("instanceEnumerationScope", $this->_propDict)) {
if (is_a($this->_propDict["instanceEnumerationScope"], "\Microsoft\Graph\Model\AccessReviewScope") || is_null($this->_propDict["instanceEnumerationScope"])) {
return $this->_propDict["instanceEnumerationScope"];
} else {
$this->_propDict["instanceEnumerationScope"] = new AccessReviewScope($this->_propDict["instanceEnumerationScope"]);
return $this->_propDict["instanceEnumerationScope"];
}
}
return null;
}
/**
* Sets the instanceEnumerationScope
* 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 becomes 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.
*
* @param AccessReviewScope $val The instanceEnumerationScope
*
* @return AccessReviewScheduleDefinition
*/
public function setInstanceEnumerationScope($val)
{
$this->_propDict["instanceEnumerationScope"] = $val;
return $this;
}
/**
* Gets the lastModifiedDateTime
* Timestamp when the access review series was last modified. Supports $select. Read-only.
*
* @return \DateTime|null The lastModifiedDateTime
*/
public function getLastModifiedDateTime()
{
if (array_key_exists("lastModifiedDateTime", $this->_propDict)) {
if (is_a($this->_propDict["lastModifiedDateTime"], "\DateTime") || is_null($this->_propDict["lastModifiedDateTime"])) {
return $this->_propDict["lastModifiedDateTime"];
} else {
$this->_propDict["lastModifiedDateTime"] = new \DateTime($this->_propDict["lastModifiedDateTime"]);
return $this->_propDict["lastModifiedDateTime"];
}
}
return null;
}
/**
* Sets the lastModifiedDateTime
* Timestamp when the access review series was last modified. Supports $select. Read-only.
*
* @param \DateTime $val The lastModifiedDateTime
*
* @return AccessReviewScheduleDefinition
*/
public function setLastModifiedDateTime($val)
{
$this->_propDict["lastModifiedDateTime"] = $val;
return $this;
}
/**
* Gets the reviewers
* 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.
*
* @return array|null The reviewers
*/
public function getReviewers()
{
if (array_key_exists("reviewers", $this->_propDict)) {
return $this->_propDict["reviewers"];
} else {
return null;
}
}
/**
* Sets the reviewers
* 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.
*
* @param AccessReviewReviewerScope[] $val The reviewers
*
* @return AccessReviewScheduleDefinition
*/
public function setReviewers($val)
{
$this->_propDict["reviewers"] = $val;
return $this;
}
/**
* Gets the scope
* 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.
*
* @return AccessReviewScope|null The scope
*/
public function getScope()
{
if (array_key_exists("scope", $this->_propDict)) {
if (is_a($this->_propDict["scope"], "\Microsoft\Graph\Model\AccessReviewScope") || is_null($this->_propDict["scope"])) {
return $this->_propDict["scope"];
} else {
$this->_propDict["scope"] = new AccessReviewScope($this->_propDict["scope"]);
return $this->_propDict["scope"];
}
}
return null;
}
/**
* Sets the scope
* 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.
*
* @param AccessReviewScope $val The scope
*
* @return AccessReviewScheduleDefinition
*/
public function setScope($val)
{
$this->_propDict["scope"] = $val;
return $this;
}
/**
* Gets the settings
* The settings for an access review series, see type definition below. Supports $select. Required on create.
*
* @return AccessReviewScheduleSettings|null The settings
*/
public function getSettings()
{
if (array_key_exists("settings", $this->_propDict)) {
if (is_a($this->_propDict["settings"], "\Microsoft\Graph\Model\AccessReviewScheduleSettings") || is_null($this->_propDict["settings"])) {
return $this->_propDict["settings"];
} else {
$this->_propDict["settings"] = new AccessReviewScheduleSettings($this->_propDict["settings"]);
return $this->_propDict["settings"];
}
}
return null;
}
/**
* Sets the settings
* The settings for an access review series, see type definition below. Supports $select. Required on create.
*
* @param AccessReviewScheduleSettings $val The settings
*
* @return AccessReviewScheduleDefinition
*/
public function setSettings($val)
{
$this->_propDict["settings"] = $val;
return $this;
}
/**
* Gets the stageSettings
* 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 are 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.
*
* @return array|null The stageSettings
*/
public function getStageSettings()
{
if (array_key_exists("stageSettings", $this->_propDict)) {
return $this->_propDict["stageSettings"];
} else {
return null;
}
}
/**
* Sets the stageSettings
* 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 are 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.
*
* @param AccessReviewStageSettings[] $val The stageSettings
*
* @return AccessReviewScheduleDefinition
*/
public function setStageSettings($val)
{
$this->_propDict["stageSettings"] = $val;
return $this;
}
/**
* Gets the status
* 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.
*
* @return string|null The status
*/
public function getStatus()
{
if (array_key_exists("status", $this->_propDict)) {
return $this->_propDict["status"];
} else {
return null;
}
}
/**
* Sets the status
* 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.
*
* @param string $val The status
*
* @return AccessReviewScheduleDefinition
*/
public function setStatus($val)
{
$this->_propDict["status"] = $val;
return $this;
}
/**
* Gets the instances
* If the accessReviewScheduleDefinition is a recurring access review, instances represent each recurrence. A review that doesn't 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 has a unique instance for each recurrence.
*
* @return array|null The instances
*/
public function getInstances()
{
if (array_key_exists("instances", $this->_propDict)) {
return $this->_propDict["instances"];
} else {
return null;
}
}
/**
* Sets the instances
* If the accessReviewScheduleDefinition is a recurring access review, instances represent each recurrence. A review that doesn't 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 has a unique instance for each recurrence.
*
* @param AccessReviewInstance[] $val The instances
*
* @return AccessReviewScheduleDefinition
*/
public function setInstances($val)
{
$this->_propDict["instances"] = $val;
return $this;
}
}