Class LockDurationDetails

Details for setting a retention date or legal hold.

Inheritance

object

LockDurationDetails

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.FilestorageService.Models

Assembly: OCI.DotNetSDK.Filestorage.dll

Syntax

public class LockDurationDetails

Properties

CoolOffDuration

Declaration

[JsonProperty(PropertyName = "coolOffDuration")]
public int? CoolOffDuration { get; set; }

Property Value

Type	Description
int?	For snapshots in compliance mode, a cooling-off period (measured in days) begins. During this time, you can still edit or remove the lock. Once this period ends, the snapshot becomes immutable until the specified retention date expires, permanently preventing any deletion or modification. The cool off duration can be set for a minimum of 0 days and a maximum of 365. It defaults to 14 days if not set.

Type

Description

int?

For snapshots in compliance mode, a cooling-off period (measured in days) begins. During this time, you can still edit or remove the lock. Once this period ends, the snapshot becomes immutable until the specified retention date expires, permanently preventing any deletion or modification. The cool off duration can be set for a minimum of 0 days and a maximum of 365. It defaults to 14 days if not set.

LockDuration

Declaration

[Required(ErrorMessage = "LockDuration is required.")]
[JsonProperty(PropertyName = "lockDuration")]
public int? LockDuration { get; set; }

Property Value

Type	Description
int?	The retention period (measured in days) defines how long a snapshot remains locked, preventing user modifications or deletions. In governance mode this period can be adjusted, but in compliance mode it becomes permanent after a cool-off period. Snapshots can be locked for a minimum of 0 days and a maximum of 36,500 days. A value of 0 days stands for an indefinite retention period and it is used for a legal hold.

Type

Description

int?

The retention period (measured in days) defines how long a snapshot remains locked, preventing user modifications or deletions. In governance mode this period can be adjusted, but in compliance mode it becomes permanent after a cool-off period. Snapshots can be locked for a minimum of 0 days and a maximum of 36,500 days. A value of 0 days stands for an indefinite retention period and it is used for a legal hold.

Remarks

Required

LockMode

Declaration

[Required(ErrorMessage = "LockMode is required.")]
[JsonProperty(PropertyName = "lockMode")]
[JsonConverter(typeof(ResponseEnumConverter))]
public LockDurationDetails.LockModeEnum? LockMode { get; set; }

Property Value

Type	Description
LockDurationDetails.LockModeEnum?	Can be GOVERNANCE or COMPLIANCE. GOVERNANCE MODE: locks snapshots based on either a retention period or a legal hold. COMPLIANCE MODE: the customer can only remove the snapshot during its cooling-off period. Once that time ends, the snapshot becomes immutable; customers cannot delete or modify it until its set retention date passes. After the snapshot is locked, customers can only increase its retention period.

Type

Description

LockDurationDetails.LockModeEnum?

Can be GOVERNANCE or COMPLIANCE. GOVERNANCE MODE: locks snapshots based on either a retention period or a legal hold. COMPLIANCE MODE: the customer can only remove the snapshot during its cooling-off period. Once that time ends, the snapshot becomes immutable; customers cannot delete or modify it until its set retention date passes. After the snapshot is locked, customers can only increase its retention period.

Remarks

Required