Class: OCI::DataSafe::Models::TargetOverrideSummary

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

Overview

Summary of the target database-specific profiles that override the audit profile of the target database group.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TargetOverrideSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :target_database_id (String) —

    The value to assign to the #target_database_id property

  • :is_paid_usage_enabled (BOOLEAN) —

    The value to assign to the #is_paid_usage_enabled property

  • :online_months (Integer) —

    The value to assign to the #online_months property

  • :offline_months (Integer) —

    The value to assign to the #offline_months property

  • :online_months_source (String) —

    The value to assign to the #online_months_source property

  • :offline_months_source (String) —

    The value to assign to the #offline_months_source property

  • :paid_usage_source (String) —

    The value to assign to the #paid_usage_source property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/oci/data_safe/models/target_override_summary.rb', line 118

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

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

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

  self.is_paid_usage_enabled = attributes[:'isPaidUsageEnabled'] unless attributes[:'isPaidUsageEnabled'].nil?

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

  self.is_paid_usage_enabled = attributes[:'is_paid_usage_enabled'] unless attributes[:'is_paid_usage_enabled'].nil?

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

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

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

  self.offline_months_source = attributes[:'offlineMonthsSource'] if attributes[:'offlineMonthsSource']

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

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

  self.paid_usage_source = attributes[:'paidUsageSource'] if attributes[:'paidUsageSource']

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

Instance Attribute Details

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


58
59
60
 
# File 'lib/oci/data_safe/models/target_override_summary.rb', line 58

def defined_tags
  @defined_tags
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


52
53
54
 
# File 'lib/oci/data_safe/models/target_override_summary.rb', line 52

def freeform_tags
  @freeform_tags
end

#is_paid_usage_enabled ⇒ BOOLEAN

[Required] Indicates if you want to continue collecting audit records beyond the free limit of one million audit records per month per target database, potentially incurring additional charges. The default value is inherited from the global settings. You can change at the global level or at the target level.

Returns:

  • (BOOLEAN) 


20
21
22
 
# File 'lib/oci/data_safe/models/target_override_summary.rb', line 20

def is_paid_usage_enabled
  @is_paid_usage_enabled
end

#offline_months ⇒ Integer

[Required] 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 (up to 168 months) in the offline archive, please contact the Oracle Support.

Returns:

  • (Integer) 


33
34
35
 
# File 'lib/oci/data_safe/models/target_override_summary.rb', line 33

def offline_months
  @offline_months
end

#offline_months_source ⇒ String

The name or the OCID of the resource from which the offline month retention setting is sourced. For example a target database group OCID or global.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/data_safe/models/target_override_summary.rb', line 41

def offline_months_source
  @offline_months_source
end

#online_months ⇒ Integer

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


26
27
28
 
# File 'lib/oci/data_safe/models/target_override_summary.rb', line 26

def online_months
  @online_months
end

#online_months_source ⇒ String

The name or the OCID of the resource from which the online month retention setting is sourced. For example a target database group OCID or global.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/data_safe/models/target_override_summary.rb', line 37

def online_months_source
  @online_months_source
end

The name or the OCID of the resource from which the paid usage setting is sourced. For example a target database group OCID or global.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/data_safe/models/target_override_summary.rb', line 45

def paid_usage_source
  @paid_usage_source
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


64
65
66
 
# File 'lib/oci/data_safe/models/target_override_summary.rb', line 64

def system_tags
  @system_tags
end

#target_database_id ⇒ String

[Required] The OCID of the target database that overrides from the audit profile of the target database group.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/data_safe/models/target_override_summary.rb', line 13

def target_database_id
  @target_database_id
end

Class Method Details

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/oci/data_safe/models/target_override_summary.rb', line 67

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'target_database_id': :'targetDatabaseId',
    'is_paid_usage_enabled': :'isPaidUsageEnabled',
    'online_months': :'onlineMonths',
    'offline_months': :'offlineMonths',
    'online_months_source': :'onlineMonthsSource',
    'offline_months_source': :'offlineMonthsSource',
    'paid_usage_source': :'paidUsageSource',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/oci/data_safe/models/target_override_summary.rb', line 85

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'target_database_id': :'String',
    'is_paid_usage_enabled': :'BOOLEAN',
    'online_months': :'Integer',
    'offline_months': :'Integer',
    'online_months_source': :'String',
    'offline_months_source': :'String',
    'paid_usage_source': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # 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



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/oci/data_safe/models/target_override_summary.rb', line 192

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

  self.class == other.class &&
    target_database_id == other.target_database_id &&
    is_paid_usage_enabled == other.is_paid_usage_enabled &&
    online_months == other.online_months &&
    offline_months == other.offline_months &&
    online_months_source == other.online_months_source &&
    offline_months_source == other.offline_months_source &&
    paid_usage_source == other.paid_usage_source &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/oci/data_safe/models/target_override_summary.rb', line 231

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


211
212
213
 
# File 'lib/oci/data_safe/models/target_override_summary.rb', line 211

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



220
221
222
 
# File 'lib/oci/data_safe/models/target_override_summary.rb', line 220

def hash
  [target_database_id, is_paid_usage_enabled, online_months, offline_months, online_months_source, offline_months_source, paid_usage_source, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



264
265
266
267
268
269
270
271
272
273
 
# File 'lib/oci/data_safe/models/target_override_summary.rb', line 264

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



258
259
260
 
# File 'lib/oci/data_safe/models/target_override_summary.rb', line 258

def to_s
  to_hash.to_s
end