Class: OCI::ObjectStorage::Models::RetentionRuleDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/object_storage/models/retention_rule_details.rb

Overview

The details to create or update a retention rule.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RetentionRuleDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/oci/object_storage/models/retention_rule_details.rb', line 59

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.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

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

  self.time_rule_locked = attributes[:'timeRuleLocked'] if attributes[:'timeRuleLocked']

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

  self.time_rule_locked = attributes[:'time_rule_locked'] if attributes[:'time_rule_locked']
end

Instance Attribute Details

#display_name ⇒ String

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

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/object_storage/models/retention_rule_details.rb', line 15

def display_name
  @display_name
end

#duration ⇒ OCI::ObjectStorage::Models::Duration

Returns:



18
19
20
 
# File 'lib/oci/object_storage/models/retention_rule_details.rb', line 18

def duration
  @duration
end

#time_rule_locked ⇒ DateTime

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:

  • (DateTime) 


26
27
28
 
# File 'lib/oci/object_storage/models/retention_rule_details.rb', line 26

def time_rule_locked
  @time_rule_locked
end

Class Method Details

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
36
37
 
# File 'lib/oci/object_storage/models/retention_rule_details.rb', line 29

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'duration': :'duration',
    'time_rule_locked': :'timeRuleLocked'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



40
41
42
43
44
45
46
47
48
 
# File 'lib/oci/object_storage/models/retention_rule_details.rb', line 40

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'duration': :'OCI::ObjectStorage::Models::Duration',
    'time_rule_locked': :'DateTime'
    # 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



87
88
89
90
91
92
93
94
 
# File 'lib/oci/object_storage/models/retention_rule_details.rb', line 87

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

  self.class == other.class &&
    display_name == other.display_name &&
    duration == other.duration &&
    time_rule_locked == other.time_rule_locked
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



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/oci/object_storage/models/retention_rule_details.rb', line 119

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


99
100
101
 
# File 'lib/oci/object_storage/models/retention_rule_details.rb', line 99

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



108
109
110
 
# File 'lib/oci/object_storage/models/retention_rule_details.rb', line 108

def hash
  [display_name, duration, time_rule_locked].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



152
153
154
155
156
157
158
159
160
161
 
# File 'lib/oci/object_storage/models/retention_rule_details.rb', line 152

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



146
147
148
 
# File 'lib/oci/object_storage/models/retention_rule_details.rb', line 146

def to_s
  to_hash.to_s
end