Package com.microsoft.graph.models.security

Class RetentionLabel

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

  • Constructor Details

    • RetentionLabel

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

  • Method Details

    • createFromDiscriminatorValue

      @Nonnull public static RetentionLabel 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 RetentionLabel

    • getActionAfterRetentionPeriod

      @Nullable public ActionAfterRetentionPeriod getActionAfterRetentionPeriod()
      Gets the actionAfterRetentionPeriod property value. Specifies the action to take on the labeled document after the period specified by the retentionDuration property expires. The possible values are: none, delete, startDispositionReview, unknownFutureValue.
      Returns:
      a ActionAfterRetentionPeriod

    • getBehaviorDuringRetentionPeriod

      @Nullable public BehaviorDuringRetentionPeriod getBehaviorDuringRetentionPeriod()
      Gets the behaviorDuringRetentionPeriod property value. Specifies how the behavior of a document with this label should be during the retention period. The possible values are: doNotRetain, retain, retainAsRecord, retainAsRegulatoryRecord, unknownFutureValue.
      Returns:
      a BehaviorDuringRetentionPeriod

    • getCreatedBy

      @Nullable public IdentitySet getCreatedBy()
      Gets the createdBy property value. Represents the user who created the retentionLabel.
      Returns:
      a IdentitySet

    • getCreatedDateTime

      @Nullable public OffsetDateTime getCreatedDateTime()
      Gets the createdDateTime property value. Represents the date and time in which the retentionLabel is created.
      Returns:
      a OffsetDateTime

    • getDefaultRecordBehavior

      @Nullable public DefaultRecordBehavior getDefaultRecordBehavior()
      Gets the defaultRecordBehavior property value. Specifies the locked or unlocked state of a record label when it is created.The possible values are: startLocked, startUnlocked, unknownFutureValue.
      Returns:
      a DefaultRecordBehavior

    • getDescriptionForAdmins

      @Nullable public String getDescriptionForAdmins()
      Gets the descriptionForAdmins property value. Provides label information for the admin. Optional.
      Returns:
      a String

    • getDescriptionForUsers

      @Nullable public String getDescriptionForUsers()
      Gets the descriptionForUsers property value. Provides the label information for the user. Optional.
      Returns:
      a String

    • getDescriptors

      @Nullable public FilePlanDescriptor getDescriptors()
      Gets the descriptors property value. Represents out-of-the-box values that provide more options to improve the manageability and organization of the content you need to label.
      Returns:
      a FilePlanDescriptor

    • getDisplayName

      @Nullable public String getDisplayName()
      Gets the displayName property value. Unique string that defines a label name.
      Returns:
      a String

    • getDispositionReviewStages

      @Nullable public List<DispositionReviewStage> getDispositionReviewStages()
      Gets the dispositionReviewStages property value. When action at the end of retention is chosen as 'dispositionReview', dispositionReviewStages specifies a sequential set of stages with at least one reviewer in each stage.
      Returns:
      a List<DispositionReviewStage>

    • 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>>

    • getIsInUse

      @Nullable public Boolean getIsInUse()
      Gets the isInUse property value. Specifies whether the label is currently being used.
      Returns:
      a Boolean

    • getLabelToBeApplied

      @Nullable public String getLabelToBeApplied()
      Gets the labelToBeApplied property value. Specifies the replacement label to be applied automatically after the retention period of the current label ends.
      Returns:
      a String

    • getLastModifiedBy

      @Nullable public IdentitySet getLastModifiedBy()
      Gets the lastModifiedBy property value. The user who last modified the retentionLabel.
      Returns:
      a IdentitySet

    • getLastModifiedDateTime

      @Nullable public OffsetDateTime getLastModifiedDateTime()
      Gets the lastModifiedDateTime property value. The latest date time when the retentionLabel was modified.
      Returns:
      a OffsetDateTime

    • getRetentionDuration

      @Nullable public RetentionDuration getRetentionDuration()
      Gets the retentionDuration property value. Specifies the number of days to retain the content.
      Returns:
      a RetentionDuration

    • getRetentionEventType

      @Nullable public RetentionEventType getRetentionEventType()
      Gets the retentionEventType property value. Represents the type associated with a retention event.
      Returns:
      a RetentionEventType

    • getRetentionTrigger

      @Nullable public RetentionTrigger getRetentionTrigger()
      Gets the retentionTrigger property value. Specifies whether the retention duration is calculated from the content creation date, labeled date, or last modification date. The possible values are: dateLabeled, dateCreated, dateModified, dateOfEvent, unknownFutureValue.
      Returns:
      a RetentionTrigger

    • 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

    • setActionAfterRetentionPeriod

      public void setActionAfterRetentionPeriod(@Nullable ActionAfterRetentionPeriod value)
      Sets the actionAfterRetentionPeriod property value. Specifies the action to take on the labeled document after the period specified by the retentionDuration property expires. The possible values are: none, delete, startDispositionReview, unknownFutureValue.
      Parameters:
      value - Value to set for the actionAfterRetentionPeriod property.

    • setBehaviorDuringRetentionPeriod

      public void setBehaviorDuringRetentionPeriod(@Nullable BehaviorDuringRetentionPeriod value)
      Sets the behaviorDuringRetentionPeriod property value. Specifies how the behavior of a document with this label should be during the retention period. The possible values are: doNotRetain, retain, retainAsRecord, retainAsRegulatoryRecord, unknownFutureValue.
      Parameters:
      value - Value to set for the behaviorDuringRetentionPeriod property.

    • setCreatedBy

      public void setCreatedBy(@Nullable IdentitySet value)
      Sets the createdBy property value. Represents the user who created the retentionLabel.
      Parameters:
      value - Value to set for the createdBy property.

    • setCreatedDateTime

      public void setCreatedDateTime(@Nullable OffsetDateTime value)
      Sets the createdDateTime property value. Represents the date and time in which the retentionLabel is created.
      Parameters:
      value - Value to set for the createdDateTime property.

    • setDefaultRecordBehavior

      public void setDefaultRecordBehavior(@Nullable DefaultRecordBehavior value)
      Sets the defaultRecordBehavior property value. Specifies the locked or unlocked state of a record label when it is created.The possible values are: startLocked, startUnlocked, unknownFutureValue.
      Parameters:
      value - Value to set for the defaultRecordBehavior property.

    • setDescriptionForAdmins

      public void setDescriptionForAdmins(@Nullable String value)
      Sets the descriptionForAdmins property value. Provides label information for the admin. Optional.
      Parameters:
      value - Value to set for the descriptionForAdmins property.

    • setDescriptionForUsers

      public void setDescriptionForUsers(@Nullable String value)
      Sets the descriptionForUsers property value. Provides the label information for the user. Optional.
      Parameters:
      value - Value to set for the descriptionForUsers property.

    • setDescriptors

      public void setDescriptors(@Nullable FilePlanDescriptor value)
      Sets the descriptors property value. Represents out-of-the-box values that provide more options to improve the manageability and organization of the content you need to label.
      Parameters:
      value - Value to set for the descriptors property.

    • setDisplayName

      public void setDisplayName(@Nullable String value)
      Sets the displayName property value. Unique string that defines a label name.
      Parameters:
      value - Value to set for the displayName property.

    • setDispositionReviewStages

      public void setDispositionReviewStages(@Nullable List<DispositionReviewStage> value)
      Sets the dispositionReviewStages property value. When action at the end of retention is chosen as 'dispositionReview', dispositionReviewStages specifies a sequential set of stages with at least one reviewer in each stage.
      Parameters:
      value - Value to set for the dispositionReviewStages property.

    • setIsInUse

      public void setIsInUse(@Nullable Boolean value)
      Sets the isInUse property value. Specifies whether the label is currently being used.
      Parameters:
      value - Value to set for the isInUse property.

    • setLabelToBeApplied

      public void setLabelToBeApplied(@Nullable String value)
      Sets the labelToBeApplied property value. Specifies the replacement label to be applied automatically after the retention period of the current label ends.
      Parameters:
      value - Value to set for the labelToBeApplied property.

    • setLastModifiedBy

      public void setLastModifiedBy(@Nullable IdentitySet value)
      Sets the lastModifiedBy property value. The user who last modified the retentionLabel.
      Parameters:
      value - Value to set for the lastModifiedBy property.

    • setLastModifiedDateTime

      public void setLastModifiedDateTime(@Nullable OffsetDateTime value)
      Sets the lastModifiedDateTime property value. The latest date time when the retentionLabel was modified.
      Parameters:
      value - Value to set for the lastModifiedDateTime property.

    • setRetentionDuration

      public void setRetentionDuration(@Nullable RetentionDuration value)
      Sets the retentionDuration property value. Specifies the number of days to retain the content.
      Parameters:
      value - Value to set for the retentionDuration property.

    • setRetentionEventType

      public void setRetentionEventType(@Nullable RetentionEventType value)
      Sets the retentionEventType property value. Represents the type associated with a retention event.
      Parameters:
      value - Value to set for the retentionEventType property.

    • setRetentionTrigger

      public void setRetentionTrigger(@Nullable RetentionTrigger value)
      Sets the retentionTrigger property value. Specifies whether the retention duration is calculated from the content creation date, labeled date, or last modification date. The possible values are: dateLabeled, dateCreated, dateModified, dateOfEvent, unknownFutureValue.
      Parameters:
      value - Value to set for the retentionTrigger property.