Class: OCI::FleetAppsManagement::Models::CompliancePolicyRule

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/fleet_apps_management/models/compliance_policy_rule.rb

Overview

Set of rules that are used to calculate the compliance status of the product. Specific rules will take precedence over broader rules.

Constant Summary collapse

SEVERITY_ENUM = 
[
  SEVERITY_CRITICAL = 'CRITICAL'.freeze,
  SEVERITY_HIGH = 'HIGH'.freeze,
  SEVERITY_MEDIUM = 'MEDIUM'.freeze,
  SEVERITY_LOW = 'LOW'.freeze,
  SEVERITY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.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 = {}) ⇒ CompliancePolicyRule

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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

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

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

  self.product_version = attributes[:'productVersion'] if attributes[:'productVersion']

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

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

  self.patch_type_id = attributes[:'patchTypeId'] if attributes[:'patchTypeId']

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

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

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

  self.patch_selection = attributes[:'patchSelection'] if attributes[:'patchSelection']

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

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

  self.grace_period = attributes[:'gracePeriod'] if attributes[:'gracePeriod']

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

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

  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.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.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 the CompliancePolicyRule belongs to.

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/fleet_apps_management/models/compliance_policy_rule.rb', line 72

def compartment_id
  @compartment_id
end

#compliance_policy_id ⇒ String

[Required] Unique OCID of the CompliancePolicy.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/fleet_apps_management/models/compliance_policy_rule.rb', line 46

def compliance_policy_id
  @compliance_policy_id
end

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

[Required] Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


108
109
110
 
# File 'lib/oci/fleet_apps_management/models/compliance_policy_rule.rb', line 108

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Example: My new resource

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/fleet_apps_management/models/compliance_policy_rule.rb', line 42

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

[Required] Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


102
103
104
 
# File 'lib/oci/fleet_apps_management/models/compliance_policy_rule.rb', line 102

def freeform_tags
  @freeform_tags
end

#grace_period ⇒ String

Grace period in days,weeks,months or years the exemption is applicable for the rule. This enables a grace period when Fleet Application Management doesn't report the product as noncompliant when patch is not applied.

Returns:

  • (String) 


68
69
70
 
# File 'lib/oci/fleet_apps_management/models/compliance_policy_rule.rb', line 68

def grace_period
  @grace_period
end

#id ⇒ String

[Required] Unique OCID of the CompliancePolicyRule.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/fleet_apps_management/models/compliance_policy_rule.rb', line 34

def id
  @id
end

#lifecycle_details ⇒ String

A message that describes the current state of the CompliancePolicyRule in more detail. For example, can be used to provide actionable information for a resource in the Failed state.

Returns:

  • (String) 


96
97
98
 
# File 'lib/oci/fleet_apps_management/models/compliance_policy_rule.rb', line 96

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the CompliancePolicyRule.

Returns:

  • (String) 


90
91
92
 
# File 'lib/oci/fleet_apps_management/models/compliance_policy_rule.rb', line 90

def lifecycle_state
  @lifecycle_state
end

#patch_selection ⇒ OCI::FleetAppsManagement::Models::PatchSelectionDetails

This attribute is required.

Returns:



62
63
64
 
# File 'lib/oci/fleet_apps_management/models/compliance_policy_rule.rb', line 62

def patch_selection
  @patch_selection
end

#patch_type_id ⇒ Array<String>

[Required] PlatformConfiguration OCID for the patch type to which this CompliancePolicyRule applies.

Returns:

  • (Array<String>) 


54
55
56
 
# File 'lib/oci/fleet_apps_management/models/compliance_policy_rule.rb', line 54

def patch_type_id
  @patch_type_id
end

#product_version ⇒ OCI::FleetAppsManagement::Models::ProductVersionDetails

This attribute is required.

Returns:



50
51
52
 
# File 'lib/oci/fleet_apps_management/models/compliance_policy_rule.rb', line 50

def product_version
  @product_version
end

#severity ⇒ Array<String>

Severity to which this CompliancePolicyRule applies.

Returns:

  • (Array<String>) 


58
59
60
 
# File 'lib/oci/fleet_apps_management/models/compliance_policy_rule.rb', line 58

def severity
  @severity
end

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

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

Returns:

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


114
115
116
 
# File 'lib/oci/fleet_apps_management/models/compliance_policy_rule.rb', line 114

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time the CompliancePolicyRule was created, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


79
80
81
 
# File 'lib/oci/fleet_apps_management/models/compliance_policy_rule.rb', line 79

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The date and time the CompliancePolicyRule was updated, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


86
87
88
 
# File 'lib/oci/fleet_apps_management/models/compliance_policy_rule.rb', line 86

def time_updated
  @time_updated
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
 
# File 'lib/oci/fleet_apps_management/models/compliance_policy_rule.rb', line 117

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compliance_policy_id': :'compliancePolicyId',
    'product_version': :'productVersion',
    'patch_type_id': :'patchTypeId',
    'severity': :'severity',
    'patch_selection': :'patchSelection',
    'grace_period': :'gracePeriod',
    'compartment_id': :'compartmentId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compliance_policy_id': :'String',
    'product_version': :'OCI::FleetAppsManagement::Models::ProductVersionDetails',
    'patch_type_id': :'Array<String>',
    'severity': :'Array<String>',
    'patch_selection': :'OCI::FleetAppsManagement::Models::PatchSelectionDetails',
    'grace_period': :'String',
    'compartment_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'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



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/oci/fleet_apps_management/models/compliance_policy_rule.rb', line 321

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compliance_policy_id == other.compliance_policy_id &&
    product_version == other.product_version &&
    patch_type_id == other.patch_type_id &&
    severity == other.severity &&
    patch_selection == other.patch_selection &&
    grace_period == other.grace_period &&
    compartment_id == other.compartment_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    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



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/oci/fleet_apps_management/models/compliance_policy_rule.rb', line 366

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


346
347
348
 
# File 'lib/oci/fleet_apps_management/models/compliance_policy_rule.rb', line 346

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



355
356
357
 
# File 'lib/oci/fleet_apps_management/models/compliance_policy_rule.rb', line 355

def hash
  [id, display_name, compliance_policy_id, product_version, patch_type_id, severity, patch_selection, grace_period, compartment_id, time_created, time_updated, lifecycle_state, lifecycle_details, 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



399
400
401
402
403
404
405
406
407
408
 
# File 'lib/oci/fleet_apps_management/models/compliance_policy_rule.rb', line 399

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



393
394
395
 
# File 'lib/oci/fleet_apps_management/models/compliance_policy_rule.rb', line 393

def to_s
  to_hash.to_s
end