Class: OCI::DataSafe::Models::AuditPolicySummary

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

Overview

The resource represents all available audit policies relevant for the target database with their corresponding audit conditions. The audit policies could be in any one of the following 3 states in the target database 1) Created and enabled 2) Created but not enabled 3) Not created For more details on available audit policies, refer to documentation.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AuditPolicySummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



163
164
165
166
167
168
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
 
# File 'lib/oci/data_safe/models/audit_policy_summary.rb', line 163

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

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

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

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

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

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

  self.audit_specifications = attributes[:'auditSpecifications'] if attributes[:'auditSpecifications']

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

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

  self.time_last_provisioned = attributes[:'timeLastProvisioned'] if attributes[:'timeLastProvisioned']

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

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

  self.time_last_retrieved = attributes[:'timeLastRetrieved'] if attributes[:'timeLastRetrieved']

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

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

  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']
end

Instance Attribute Details

#audit_specifications ⇒ Array<OCI::DataSafe::Models::AuditSpecification>

Represents all available audit policy specifications relevant for the target database. For more details on available audit polcies, refer to documentation.

Returns:



72
73
74
 
# File 'lib/oci/data_safe/models/audit_policy_summary.rb', line 72

def audit_specifications
  @audit_specifications
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/data_safe/models/audit_policy_summary.rb', line 35

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/audit_policy_summary.rb', line 94

def defined_tags
  @defined_tags
end

#description ⇒ String

Description of the audit policy.

Returns:

  • (String) 


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

def description
  @description
end

#display_name ⇒ String

[Required] The display name of the audit policy.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/data_safe/models/audit_policy_summary.rb', line 39

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


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the audit policy.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/data_safe/models/audit_policy_summary.rb', line 31

def id
  @id
end

#is_data_safe_service_account_excluded ⇒ BOOLEAN

[Required] Option provided to users at the target to indicate whether the Data Safe service account has to be excluded while provisioning the audit policies.

Returns:

  • (BOOLEAN) 


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

def 
  @is_data_safe_service_account_excluded
end

#lifecycle_details ⇒ String

Details about the current state of the audit policy in Data Safe.

Returns:

  • (String) 


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

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the audit policy.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#target_id ⇒ String

[Required] The OCID of the target for which the audit policy is created.

Returns:

  • (String) 


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

def target_id
  @target_id
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#time_last_provisioned ⇒ DateTime

Indicates the last provisioning time of audit policies on the target, in the format defined by RFC3339.

Returns:

  • (DateTime) 


76
77
78
 
# File 'lib/oci/data_safe/models/audit_policy_summary.rb', line 76

def time_last_provisioned
  @time_last_provisioned
end

#time_last_retrieved ⇒ DateTime

The time when the audit policies was last retrieved from this target, in the format defined by RFC3339.

Returns:

  • (DateTime) 


80
81
82
 
# File 'lib/oci/data_safe/models/audit_policy_summary.rb', line 80

def time_last_retrieved
  @time_last_retrieved
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/oci/data_safe/models/audit_policy_summary.rb', line 97

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'target_id': :'targetId',
    'is_data_safe_service_account_excluded': :'isDataSafeServiceAccountExcluded',
    'audit_specifications': :'auditSpecifications',
    'time_last_provisioned': :'timeLastProvisioned',
    'time_last_retrieved': :'timeLastRetrieved',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'target_id': :'String',
    'is_data_safe_service_account_excluded': :'BOOLEAN',
    'audit_specifications': :'Array<OCI::DataSafe::Models::AuditSpecification>',
    'time_last_provisioned': :'DateTime',
    'time_last_retrieved': :'DateTime',
    'freeform_tags': :'Hash<String, String>',
    'defined_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



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/oci/data_safe/models/audit_policy_summary.rb', line 272

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 &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    target_id == other.target_id &&
     == other. &&
    audit_specifications == other.audit_specifications &&
    time_last_provisioned == other.time_last_provisioned &&
    time_last_retrieved == other.time_last_retrieved &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/oci/data_safe/models/audit_policy_summary.rb', line 316

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


296
297
298
 
# File 'lib/oci/data_safe/models/audit_policy_summary.rb', line 296

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



305
306
307
 
# File 'lib/oci/data_safe/models/audit_policy_summary.rb', line 305

def hash
  [id, compartment_id, display_name, description, time_created, time_updated, lifecycle_state, lifecycle_details, target_id, , audit_specifications, time_last_provisioned, time_last_retrieved, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



349
350
351
352
353
354
355
356
357
358
 
# File 'lib/oci/data_safe/models/audit_policy_summary.rb', line 349

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



343
344
345
 
# File 'lib/oci/data_safe/models/audit_policy_summary.rb', line 343

def to_s
  to_hash.to_s
end