Class: OCI::FileStorage::Models::LockDurationDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/file_storage/models/lock_duration_details.rb

Overview

Details for setting a retention date or legal hold.

Constant Summary collapse

LOCK_MODE_ENUM = 
[
  LOCK_MODE_GOVERNANCE = 'GOVERNANCE'.freeze,
  LOCK_MODE_COMPLIANCE = 'COMPLIANCE'.freeze,
  LOCK_MODE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LockDurationDetails

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :cool_off_duration (Integer) —

    The value to assign to the #cool_off_duration property

  • :lock_duration (Integer) —

    The value to assign to the #lock_duration property

  • :lock_mode (String) —

    The value to assign to the #lock_mode property



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
 
# File 'lib/oci/file_storage/models/lock_duration_details.rb', line 77

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.cool_off_duration = attributes[:'coolOffDuration'] if attributes[:'coolOffDuration']

  raise 'You cannot provide both :coolOffDuration and :cool_off_duration' if attributes.key?(:'coolOffDuration') && attributes.key?(:'cool_off_duration')

  self.cool_off_duration = attributes[:'cool_off_duration'] if attributes[:'cool_off_duration']

  self.lock_duration = attributes[:'lockDuration'] if attributes[:'lockDuration']

  raise 'You cannot provide both :lockDuration and :lock_duration' if attributes.key?(:'lockDuration') && attributes.key?(:'lock_duration')

  self.lock_duration = attributes[:'lock_duration'] if attributes[:'lock_duration']

  self.lock_mode = attributes[:'lockMode'] if attributes[:'lockMode']
  self.lock_mode = "GOVERNANCE" if lock_mode.nil? && !attributes.key?(:'lockMode') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :lockMode and :lock_mode' if attributes.key?(:'lockMode') && attributes.key?(:'lock_mode')

  self.lock_mode = attributes[:'lock_mode'] if attributes[:'lock_mode']
  self.lock_mode = "GOVERNANCE" if lock_mode.nil? && !attributes.key?(:'lockMode') && !attributes.key?(:'lock_mode') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#cool_off_duration ⇒ Integer

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.

Returns:

  • (Integer) 


25
26
27
 
# File 'lib/oci/file_storage/models/lock_duration_details.rb', line 25

def cool_off_duration
  @cool_off_duration
end

#lock_duration ⇒ Integer

[Required] 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.

Returns:

  • (Integer) 


34
35
36
 
# File 'lib/oci/file_storage/models/lock_duration_details.rb', line 34

def lock_duration
  @lock_duration
end

#lock_mode ⇒ String

[Required] 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.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/file_storage/models/lock_duration_details.rb', line 44

def lock_mode
  @lock_mode
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



47
48
49
50
51
52
53
54
55
 
# File 'lib/oci/file_storage/models/lock_duration_details.rb', line 47

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'cool_off_duration': :'coolOffDuration',
    'lock_duration': :'lockDuration',
    'lock_mode': :'lockMode'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
 
# File 'lib/oci/file_storage/models/lock_duration_details.rb', line 58

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'cool_off_duration': :'Integer',
    'lock_duration': :'Integer',
    'lock_mode': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



124
125
126
127
128
129
130
131
 
# File 'lib/oci/file_storage/models/lock_duration_details.rb', line 124

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    cool_off_duration == other.cool_off_duration &&
    lock_duration == other.lock_duration &&
    lock_mode == other.lock_mode
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/oci/file_storage/models/lock_duration_details.rb', line 156

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


136
137
138
 
# File 'lib/oci/file_storage/models/lock_duration_details.rb', line 136

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



145
146
147
 
# File 'lib/oci/file_storage/models/lock_duration_details.rb', line 145

def hash
  [cool_off_duration, lock_duration, lock_mode].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



189
190
191
192
193
194
195
196
197
198
 
# File 'lib/oci/file_storage/models/lock_duration_details.rb', line 189

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



183
184
185
 
# File 'lib/oci/file_storage/models/lock_duration_details.rb', line 183

def to_s
  to_hash.to_s
end