Package com.microsoft.graph.models

Class AccessReviewScheduleDefinition

java.lang.Object
com.microsoft.graph.models.Entity
com.microsoft.graph.models.AccessReviewScheduleDefinition
All Implemented Interfaces:
com.microsoft.kiota.serialization.AdditionalDataHolder, com.microsoft.kiota.serialization.Parsable, com.microsoft.kiota.store.BackedModel
@Generated("com.microsoft.kiota") public class AccessReviewScheduleDefinition extends Entity implements com.microsoft.kiota.serialization.Parsable

  • Constructor Details

    • AccessReviewScheduleDefinition

      public AccessReviewScheduleDefinition()
      Instantiates a new AccessReviewScheduleDefinition and sets the default values.

  • Method Details

    • createFromDiscriminatorValue

      @Nonnull public static AccessReviewScheduleDefinition createFromDiscriminatorValue(@Nonnull com.microsoft.kiota.serialization.ParseNode parseNode)
      Creates a new instance of the appropriate class based on discriminator value
      Parameters:
      parseNode - The parse node to use to read the discriminator value and create the object
      Returns:
      a AccessReviewScheduleDefinition

    • getAdditionalNotificationRecipients

      @Nullable public List<AccessReviewNotificationRecipientItem> getAdditionalNotificationRecipients()
      Gets the additionalNotificationRecipients property value. Defines the list of additional users or group members to be notified of the access review progress.
      Returns:
      a List<AccessReviewNotificationRecipientItem>

    • getCreatedBy

      @Nullable public UserIdentity getCreatedBy()
      Gets the createdBy property value. User who created this review. Read-only.
      Returns:
      a UserIdentity

    • getCreatedDateTime

      @Nullable public OffsetDateTime getCreatedDateTime()
      Gets the createdDateTime property value. Timestamp when the access review series was created. Supports $select. Read-only.
      Returns:
      a OffsetDateTime

    • getDescriptionForAdmins

      @Nullable public String getDescriptionForAdmins()
      Gets the descriptionForAdmins property value. Description provided by review creators to provide more context of the review to admins. Supports $select.
      Returns:
      a String

    • getDescriptionForReviewers

      @Nullable public String getDescriptionForReviewers()
      Gets the descriptionForReviewers property value. 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.
      Returns:
      a String

    • getDisplayName

      @Nullable public String getDisplayName()
      Gets the displayName property value. Name of the access review series. Supports $select and $orderby. Required on create.
      Returns:
      a String

    • getFallbackReviewers

      @Nullable public List<AccessReviewReviewerScope> getFallbackReviewers()
      Gets the fallbackReviewers property value. 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.
      Returns:
      a List<AccessReviewReviewerScope>

    • getFieldDeserializers

      @Nonnull public Map<String,Consumer<com.microsoft.kiota.serialization.ParseNode>> getFieldDeserializers()
      The deserialization information for the current model
      Specified by:
      getFieldDeserializers in interface com.microsoft.kiota.serialization.Parsable
      Overrides:
      getFieldDeserializers in class Entity
      Returns:
      a Map<String,Consumer<com.microsoft.kiota.serialization.ParseNode>>

    • getInstanceEnumerationScope

      @Nullable public AccessReviewScope getInstanceEnumerationScope()
      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 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.
      Returns:
      a AccessReviewScope

    • getInstances

      @Nullable public List<AccessReviewInstance> getInstances()
      Gets the instances property value. 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.
      Returns:
      a List<AccessReviewInstance>

    • getLastModifiedDateTime

      @Nullable public OffsetDateTime getLastModifiedDateTime()
      Gets the lastModifiedDateTime property value. Timestamp when the access review series was last modified. Supports $select. Read-only.
      Returns:
      a OffsetDateTime

    • getReviewers

      @Nullable public List<AccessReviewReviewerScope> getReviewers()
      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 List<AccessReviewReviewerScope>

    • getScope

      @Nullable public AccessReviewScope getScope()
      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 AccessReviewScope

    • getSettings

      @Nullable public AccessReviewScheduleSettings getSettings()
      Gets the settings property value. The settings for an access review series, see type definition below. Supports $select. Required on create.
      Returns:
      a AccessReviewScheduleSettings

    • getStageSettings

      @Nullable public List<AccessReviewStageSettings> getStageSettings()
      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 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.
      Returns:
      a List<AccessReviewStageSettings>

    • getStatus

      @Nullable public String getStatus()
      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

    • serialize

      public void serialize(@Nonnull com.microsoft.kiota.serialization.SerializationWriter writer)
      Serializes information the current object
      Specified by:
      serialize in interface com.microsoft.kiota.serialization.Parsable
      Overrides:
      serialize in class Entity
      Parameters:
      writer - Serialization writer to use to serialize this model

    • setAdditionalNotificationRecipients

      public void setAdditionalNotificationRecipients(@Nullable List<AccessReviewNotificationRecipientItem> value)
      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.

    • setCreatedBy

      public void setCreatedBy(@Nullable UserIdentity value)
      Sets the createdBy property value. User who created this review. Read-only.
      Parameters:
      value - Value to set for the createdBy property.

    • setCreatedDateTime

      public void setCreatedDateTime(@Nullable OffsetDateTime value)
      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.

    • setDescriptionForAdmins

      public void setDescriptionForAdmins(@Nullable String value)
      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.

    • setDescriptionForReviewers

      public void setDescriptionForReviewers(@Nullable String value)
      Sets the descriptionForReviewers property value. 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.
      Parameters:
      value - Value to set for the descriptionForReviewers property.

    • setDisplayName

      public void setDisplayName(@Nullable String value)
      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.

    • setFallbackReviewers

      public void setFallbackReviewers(@Nullable List<AccessReviewReviewerScope> value)
      Sets the fallbackReviewers property value. 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.
      Parameters:
      value - Value to set for the fallbackReviewers property.

    • setInstanceEnumerationScope

      public void setInstanceEnumerationScope(@Nullable AccessReviewScope value)
      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 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.
      Parameters:
      value - Value to set for the instanceEnumerationScope property.

    • setInstances

      public void setInstances(@Nullable List<AccessReviewInstance> value)
      Sets the instances property value. 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.
      Parameters:
      value - Value to set for the instances property.

    • setLastModifiedDateTime

      public void setLastModifiedDateTime(@Nullable OffsetDateTime value)
      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.

    • setReviewers

      public void setReviewers(@Nullable List<AccessReviewReviewerScope> value)
      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.

    • setScope

      public void setScope(@Nullable AccessReviewScope value)
      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.

    • setSettings

      public void setSettings(@Nullable AccessReviewScheduleSettings value)
      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.

    • setStageSettings

      public void setStageSettings(@Nullable List<AccessReviewStageSettings> value)
      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 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.
      Parameters:
      value - Value to set for the stageSettings property.

    • setStatus

      public void setStatus(@Nullable String value)
      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.