Class: OCI::DataSafe::Models::ChangeRetentionDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_safe/models/change_retention_details.rb

Overview

Details for the audit retention months to be modified.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ChangeRetentionDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/oci/data_safe/models/change_retention_details.rb', line 60

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

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

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

  self.offline_months = attributes[:'offlineMonths'] if attributes[:'offlineMonths']

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

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

  self.is_override_global_retention_setting = attributes[:'isOverrideGlobalRetentionSetting'] unless attributes[:'isOverrideGlobalRetentionSetting'].nil?

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

  self.is_override_global_retention_setting = attributes[:'is_override_global_retention_setting'] unless attributes[:'is_override_global_retention_setting'].nil?
end

Instance Attribute Details

#is_override_global_retention_setting ⇒ BOOLEAN

Indicates whether audit retention settings like online and offline months set at the target level override both the global settings and the target group level audit retention settings.

Returns:

  • (BOOLEAN) 


27
28
29
 
# File 'lib/oci/data_safe/models/change_retention_details.rb', line 27

def is_override_global_retention_setting
  @is_override_global_retention_setting
end

#offline_months ⇒ Integer

Number of months the audit records will be stored offline in the offline archive. Minimum: 0; Maximum: 72 months. If you have a requirement to store the audit data even longer in the offline archive, please contact the Oracle Support.

Returns:

  • (Integer) 


21
22
23
 
# File 'lib/oci/data_safe/models/change_retention_details.rb', line 21

def offline_months
  @offline_months
end

#online_months ⇒ Integer

Number of months the audit records will be stored online in the audit repository for immediate reporting and analysis. Minimum: 1; Maximum: 12 months

Returns:

  • (Integer) 


14
15
16
 
# File 'lib/oci/data_safe/models/change_retention_details.rb', line 14

def online_months
  @online_months
end

Class Method Details

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
38
 
# File 'lib/oci/data_safe/models/change_retention_details.rb', line 30

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'online_months': :'onlineMonths',
    'offline_months': :'offlineMonths',
    'is_override_global_retention_setting': :'isOverrideGlobalRetentionSetting'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



41
42
43
44
45
46
47
48
49
 
# File 'lib/oci/data_safe/models/change_retention_details.rb', line 41

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'online_months': :'Integer',
    'offline_months': :'Integer',
    'is_override_global_retention_setting': :'BOOLEAN'
    # 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



92
93
94
95
96
97
98
99
 
# File 'lib/oci/data_safe/models/change_retention_details.rb', line 92

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

  self.class == other.class &&
    online_months == other.online_months &&
    offline_months == other.offline_months &&
    is_override_global_retention_setting == other.is_override_global_retention_setting
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



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/oci/data_safe/models/change_retention_details.rb', line 124

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


104
105
106
 
# File 'lib/oci/data_safe/models/change_retention_details.rb', line 104

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



113
114
115
 
# File 'lib/oci/data_safe/models/change_retention_details.rb', line 113

def hash
  [online_months, offline_months, is_override_global_retention_setting].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



157
158
159
160
161
162
163
164
165
166
 
# File 'lib/oci/data_safe/models/change_retention_details.rb', line 157

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



151
152
153
 
# File 'lib/oci/data_safe/models/change_retention_details.rb', line 151

def to_s
  to_hash.to_s
end