Class: OCI::DataSafe::Models::UnifiedAuditPolicyDefinition

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

Overview

Resource represents a single unified audit policy definition.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
AUDIT_POLICY_CATEGORY_ENUM = 
[
  AUDIT_POLICY_CATEGORY_BASIC_ACTIVITY = 'BASIC_ACTIVITY'.freeze,
  AUDIT_POLICY_CATEGORY_ADMIN_USER_ACTIVITY = 'ADMIN_USER_ACTIVITY'.freeze,
  AUDIT_POLICY_CATEGORY_USER_ACTIVITY = 'USER_ACTIVITY'.freeze,
  AUDIT_POLICY_CATEGORY_ORACLE_PREDEFINED = 'ORACLE_PREDEFINED'.freeze,
  AUDIT_POLICY_CATEGORY_COMPLIANCE_STANDARD = 'COMPLIANCE_STANDARD'.freeze,
  AUDIT_POLICY_CATEGORY_SQL_FIREWALL_AUDITING = 'SQL_FIREWALL_AUDITING'.freeze,
  AUDIT_POLICY_CATEGORY_CUSTOM = 'CUSTOM'.freeze,
  AUDIT_POLICY_CATEGORY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UnifiedAuditPolicyDefinition

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :policy_name (String) —

    The value to assign to the #policy_name property

  • :is_seeded (BOOLEAN) —

    The value to assign to the #is_seeded property

  • :audit_policy_category (String) —

    The value to assign to the #audit_policy_category property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :policy_definition_statement (String) —

    The value to assign to the #policy_definition_statement 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



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/oci/data_safe/models/unified_audit_policy_definition.rb', line 169

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

  self.policy_name = attributes[:'policyName'] if attributes[:'policyName']

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

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

  self.is_seeded = attributes[:'isSeeded'] unless attributes[:'isSeeded'].nil?

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

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

  self.audit_policy_category = attributes[:'auditPolicyCategory'] if attributes[:'auditPolicyCategory']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  self.policy_definition_statement = attributes[:'policyDefinitionStatement'] if attributes[:'policyDefinitionStatement']

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

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

  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

#audit_policy_category ⇒ String

The category to which the unified audit policy belongs in the target database.

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/data_safe/models/unified_audit_policy_definition.rb', line 69

def audit_policy_category
  @audit_policy_category
end

#compartment_id ⇒ String

[Required] The OCID of the compartment containing the unified audit policy definition.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#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>>) 


94
95
96
 
# File 'lib/oci/data_safe/models/unified_audit_policy_definition.rb', line 94

def defined_tags
  @defined_tags
end

#description ⇒ String

The description of the unified audit policy definition.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/data_safe/models/unified_audit_policy_definition.rb', line 49

def description
  @description
end

#display_name ⇒ String

[Required] The display name of the unified audit policy definition.

Returns:

  • (String) 


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

def display_name
  @display_name
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>) 


88
89
90
 
# File 'lib/oci/data_safe/models/unified_audit_policy_definition.rb', line 88

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the unified audit policy definition.

Returns:

  • (String) 


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

def id
  @id
end

#is_seeded ⇒ BOOLEAN

Signifies whether the unified audit policy definition is seeded or not.

Returns:

  • (BOOLEAN) 


65
66
67
 
# File 'lib/oci/data_safe/models/unified_audit_policy_definition.rb', line 65

def is_seeded
  @is_seeded
end

#lifecycle_details ⇒ String

Details about the current state of the unified audit policy definition.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/data_safe/models/unified_audit_policy_definition.rb', line 57

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the unified audit policy definition.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/data_safe/models/unified_audit_policy_definition.rb', line 53

def lifecycle_state
  @lifecycle_state
end

#policy_definition_statement ⇒ String

The definition of the unified audit policy to be provisioned in the target database.

Returns:

  • (String) 


81
82
83
 
# File 'lib/oci/data_safe/models/unified_audit_policy_definition.rb', line 81

def policy_definition_statement
  @policy_definition_statement
end

#policy_name ⇒ String

The unified audit policy name in the target database.

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/data_safe/models/unified_audit_policy_definition.rb', line 61

def policy_name
  @policy_name
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>>) 


100
101
102
 
# File 'lib/oci/data_safe/models/unified_audit_policy_definition.rb', line 100

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The time the unified audit policy was created, in the format defined by RFC3339.

Returns:

  • (DateTime) 


73
74
75
 
# File 'lib/oci/data_safe/models/unified_audit_policy_definition.rb', line 73

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The last date and time the unified audit policy was updated, in the format defined by RFC3339.

Returns:

  • (DateTime) 


77
78
79
 
# File 'lib/oci/data_safe/models/unified_audit_policy_definition.rb', line 77

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/oci/data_safe/models/unified_audit_policy_definition.rb', line 103

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'policy_name': :'policyName',
    'is_seeded': :'isSeeded',
    'audit_policy_category': :'auditPolicyCategory',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'policy_definition_statement': :'policyDefinitionStatement',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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/unified_audit_policy_definition.rb', line 126

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'policy_name': :'String',
    'is_seeded': :'BOOLEAN',
    'audit_policy_category': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'policy_definition_statement': :'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



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/oci/data_safe/models/unified_audit_policy_definition.rb', line 291

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    description == other.description &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    policy_name == other.policy_name &&
    is_seeded == other.is_seeded &&
    audit_policy_category == other.audit_policy_category &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    policy_definition_statement == other.policy_definition_statement &&
    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



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/oci/data_safe/models/unified_audit_policy_definition.rb', line 335

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


315
316
317
 
# File 'lib/oci/data_safe/models/unified_audit_policy_definition.rb', line 315

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



324
325
326
 
# File 'lib/oci/data_safe/models/unified_audit_policy_definition.rb', line 324

def hash
  [id, compartment_id, display_name, description, lifecycle_state, lifecycle_details, policy_name, is_seeded, audit_policy_category, time_created, time_updated, policy_definition_statement, 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



368
369
370
371
372
373
374
375
376
377
 
# File 'lib/oci/data_safe/models/unified_audit_policy_definition.rb', line 368

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



362
363
364
 
# File 'lib/oci/data_safe/models/unified_audit_policy_definition.rb', line 362

def to_s
  to_hash.to_s
end