Class: OCI::DataSafe::Models::UnifiedAuditPolicy

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

Overview

Resource represents a single unified audit policy on the target database.

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_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
STATUS_ENUM = 
[
  STATUS_ENABLED = 'ENABLED'.freeze,
  STATUS_DISABLED = 'DISABLED'.freeze,
  STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
ENABLED_ENTITIES_ENUM = 
[
  ENABLED_ENTITIES_ALL_USERS = 'ALL_USERS'.freeze,
  ENABLED_ENTITIES_INCLUDE_USERS = 'INCLUDE_USERS'.freeze,
  ENABLED_ENTITIES_INCLUDE_ROLES = 'INCLUDE_ROLES'.freeze,
  ENABLED_ENTITIES_EXCLUDE_USERS = 'EXCLUDE_USERS'.freeze,
  ENABLED_ENTITIES_INCLUDE_USERS_ROLES = 'INCLUDE_USERS_ROLES'.freeze,
  ENABLED_ENTITIES_DISABLED = 'DISABLED'.freeze,
  ENABLED_ENTITIES_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UnifiedAuditPolicy

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

  • :security_policy_id (String) —

    The value to assign to the #security_policy_id property

  • :unified_audit_policy_definition_id (String) —

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

  • :is_seeded (BOOLEAN) —

    The value to assign to the #is_seeded property

  • :status (String) —

    The value to assign to the #status property

  • :enabled_entities (String) —

    The value to assign to the #enabled_entities property

  • :conditions (Array<OCI::DataSafe::Models::PolicyCondition>) —

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

  • :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



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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/oci/data_safe/models/unified_audit_policy.rb', line 189

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

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

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

  self.unified_audit_policy_definition_id = attributes[:'unifiedAuditPolicyDefinitionId'] if attributes[:'unifiedAuditPolicyDefinitionId']

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

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

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

  self.enabled_entities = attributes[:'enabledEntities'] if attributes[:'enabledEntities']

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

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

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

  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.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

#compartment_id ⇒ String

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

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/data_safe/models/unified_audit_policy.rb', line 47

def compartment_id
  @compartment_id
end

#conditions ⇒ Array<OCI::DataSafe::Models::PolicyCondition>

Lists the audit policy provisioning conditions.

Returns:



87
88
89
 
# File 'lib/oci/data_safe/models/unified_audit_policy.rb', line 87

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


108
109
110
 
# File 'lib/oci/data_safe/models/unified_audit_policy.rb', line 108

def defined_tags
  @defined_tags
end

#description ⇒ String

The description of the unified audit policy.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/data_safe/models/unified_audit_policy.rb', line 55

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/data_safe/models/unified_audit_policy.rb', line 51

def display_name
  @display_name
end

#enabled_entities ⇒ String

Indicates on whom the audit policy is enabled.

Returns:

  • (String) 


83
84
85
 
# File 'lib/oci/data_safe/models/unified_audit_policy.rb', line 83

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


102
103
104
 
# File 'lib/oci/data_safe/models/unified_audit_policy.rb', line 102

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the unified audit policy.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/data_safe/models/unified_audit_policy.rb', line 43

def id
  @id
end

#is_seeded ⇒ BOOLEAN

Indicates whether the unified audit policy is seeded or not.

Returns:

  • (BOOLEAN) 


75
76
77
 
# File 'lib/oci/data_safe/models/unified_audit_policy.rb', line 75

def is_seeded
  @is_seeded
end

#lifecycle_details ⇒ String

The details of the current state of the unified audit policy in Data Safe.

Returns:

  • (String) 


71
72
73
 
# File 'lib/oci/data_safe/models/unified_audit_policy.rb', line 71

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

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

Returns:

  • (String) 


67
68
69
 
# File 'lib/oci/data_safe/models/unified_audit_policy.rb', line 67

def lifecycle_state
  @lifecycle_state
end

#security_policy_id ⇒ String

The OCID of the security policy corresponding to the unified audit policy.

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/data_safe/models/unified_audit_policy.rb', line 59

def security_policy_id
  @security_policy_id
end

#status ⇒ String

Indicates whether the policy has been enabled or disabled.

Returns:

  • (String) 


79
80
81
 
# File 'lib/oci/data_safe/models/unified_audit_policy.rb', line 79

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


114
115
116
 
# File 'lib/oci/data_safe/models/unified_audit_policy.rb', line 114

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


91
92
93
 
# File 'lib/oci/data_safe/models/unified_audit_policy.rb', line 91

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) 


95
96
97
 
# File 'lib/oci/data_safe/models/unified_audit_policy.rb', line 95

def time_updated
  @time_updated
end

#unified_audit_policy_definition_id ⇒ String

The OCID of the associated unified audit policy definition.

Returns:

  • (String) 


63
64
65
 
# File 'lib/oci/data_safe/models/unified_audit_policy.rb', line 63

def unified_audit_policy_definition_id
  @unified_audit_policy_definition_id
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'security_policy_id': :'securityPolicyId',
    'unified_audit_policy_definition_id': :'unifiedAuditPolicyDefinitionId',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'is_seeded': :'isSeeded',
    'status': :'status',
    'enabled_entities': :'enabledEntities',
    'conditions': :'conditions',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/oci/data_safe/models/unified_audit_policy.rb', line 142

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'security_policy_id': :'String',
    'unified_audit_policy_definition_id': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'is_seeded': :'BOOLEAN',
    'status': :'String',
    'enabled_entities': :'String',
    'conditions': :'Array<OCI::DataSafe::Models::PolicyCondition>',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    '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



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/oci/data_safe/models/unified_audit_policy.rb', line 328

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 &&
    security_policy_id == other.security_policy_id &&
    unified_audit_policy_definition_id == other.unified_audit_policy_definition_id &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    is_seeded == other.is_seeded &&
    status == other.status &&
    enabled_entities == other.enabled_entities &&
    conditions == other.conditions &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    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



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/oci/data_safe/models/unified_audit_policy.rb', line 374

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


354
355
356
 
# File 'lib/oci/data_safe/models/unified_audit_policy.rb', line 354

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



363
364
365
 
# File 'lib/oci/data_safe/models/unified_audit_policy.rb', line 363

def hash
  [id, compartment_id, display_name, description, security_policy_id, unified_audit_policy_definition_id, lifecycle_state, lifecycle_details, is_seeded, status, enabled_entities, conditions, time_created, time_updated, 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



407
408
409
410
411
412
413
414
415
416
 
# File 'lib/oci/data_safe/models/unified_audit_policy.rb', line 407

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



401
402
403
 
# File 'lib/oci/data_safe/models/unified_audit_policy.rb', line 401

def to_s
  to_hash.to_s
end