CreateRetentionRuleDetails

class oci.object_storage.models.CreateRetentionRuleDetails(**kwargs)

Bases: object

The details to create a retention rule.

Methods

__init__(**kwargs) Initializes a new CreateRetentionRuleDetails object with values from keyword arguments.

Attributes

display_name Gets the display_name of this CreateRetentionRuleDetails.
duration Gets the duration of this CreateRetentionRuleDetails.
time_rule_locked Gets the time_rule_locked of this CreateRetentionRuleDetails.
__init__(**kwargs)

Initializes a new CreateRetentionRuleDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • display_name (str) – The value to assign to the display_name property of this CreateRetentionRuleDetails.
  • duration (oci.object_storage.models.Duration) – The value to assign to the duration property of this CreateRetentionRuleDetails.
  • time_rule_locked (datetime) – The value to assign to the time_rule_locked property of this CreateRetentionRuleDetails.
display_name

Gets the display_name of this CreateRetentionRuleDetails. A user-specified name for the retention rule. Names can be helpful in identifying retention rules. Avoid entering confidential information.

Returns:The display_name of this CreateRetentionRuleDetails.
Return type:str
duration

Gets the duration of this CreateRetentionRuleDetails.

Returns:The duration of this CreateRetentionRuleDetails.
Return type:oci.object_storage.models.Duration
time_rule_locked

Gets the time_rule_locked of this CreateRetentionRuleDetails. The date and time as per RFC 3339 after which this rule is locked and can only be deleted by deleting the bucket. Once a rule is locked, only increases in the duration are allowed and no other properties can be changed. This property cannot be updated for rules that are in a locked state. Specifying it when a duration is not specified is considered an error.

Returns:The time_rule_locked of this CreateRetentionRuleDetails.
Return type:datetime