Class: OCI::DataSafe::Models::UserAssessmentSummary
- Inherits:
-
Object
- Object
- OCI::DataSafe::Models::UserAssessmentSummary
- Defined in:
- lib/oci/data_safe/models/user_assessment_summary.rb
Overview
The summary of the user assessment.
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_CREATING = 'CREATING'.freeze, LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'.freeze, LIFECYCLE_STATE_UPDATING = 'UPDATING'.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
- TRIGGERED_BY_ENUM =
[ TRIGGERED_BY_USER = 'USER'.freeze, TRIGGERED_BY_SYSTEM = 'SYSTEM'.freeze, TRIGGERED_BY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- TYPE_ENUM =
[ TYPE_LATEST = 'LATEST'.freeze, TYPE_SAVED = 'SAVED'.freeze, TYPE_SAVE_SCHEDULE = 'SAVE_SCHEDULE'.freeze, TYPE_COMPARTMENT = 'COMPARTMENT'.freeze, TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the user assessment.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#description ⇒ String
The description of the user assessment.
-
#display_name ⇒ String
[Required] The display name of the user assessment.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#id ⇒ String
[Required] The OCID of the user assessment.
-
#ignored_assessment_ids ⇒ Array<Object>
List containing maps as values.
-
#ignored_targets ⇒ Array<Object>
List containing maps as values.
-
#is_baseline ⇒ BOOLEAN
Indicates if the assessment is a baseline assessment.
-
#is_deviated_from_baseline ⇒ BOOLEAN
Indicates if the assessment has deviated from the baseline.
-
#last_compared_baseline_id ⇒ String
The OCID of the last user assessment baseline against which the latest assessment was compared.
-
#lifecycle_details ⇒ String
Details about the current state of the user assessment.
-
#lifecycle_state ⇒ String
[Required] The current state of the user assessment.
-
#schedule ⇒ String
Schedule to save the assessment periodically in the specified format: <version-string>;<version-specific-schedule>.
-
#schedule_assessment_id ⇒ String
The OCID of the user assessment that created this scheduled save assessment.
-
#statistics ⇒ Hash<String, Hash<String, Object>>
Map that contains maps of values.
-
#target_ids ⇒ Array<String>
Array of database target OCIDs.
-
#time_created ⇒ DateTime
[Required] The date and time the user assessment was created, in the format defined by RFC3339.
-
#time_last_assessed ⇒ DateTime
The date and time the user assessment was last executed, in the format defined by RFC3339.
-
#time_updated ⇒ DateTime
[Required] The last date and time the user assessment was updated, in the format defined by RFC3339.
-
#triggered_by ⇒ String
Indicates whether the user assessment was created by the system or the user.
-
#type ⇒ String
[Required] The type of the user assessment.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ UserAssessmentSummary
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ UserAssessmentSummary
Initializes the object
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 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 |
# File 'lib/oci/data_safe/models/user_assessment_summary.rb', line 245 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.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.description = attributes[:'description'] if attributes[:'description'] 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.id = attributes[:'id'] if attributes[:'id'] self.ignored_targets = attributes[:'ignoredTargets'] if attributes[:'ignoredTargets'] raise 'You cannot provide both :ignoredTargets and :ignored_targets' if attributes.key?(:'ignoredTargets') && attributes.key?(:'ignored_targets') self.ignored_targets = attributes[:'ignored_targets'] if attributes[:'ignored_targets'] self.ignored_assessment_ids = attributes[:'ignoredAssessmentIds'] if attributes[:'ignoredAssessmentIds'] raise 'You cannot provide both :ignoredAssessmentIds and :ignored_assessment_ids' if attributes.key?(:'ignoredAssessmentIds') && attributes.key?(:'ignored_assessment_ids') self.ignored_assessment_ids = attributes[:'ignored_assessment_ids'] if attributes[:'ignored_assessment_ids'] self.is_baseline = attributes[:'isBaseline'] unless attributes[:'isBaseline'].nil? raise 'You cannot provide both :isBaseline and :is_baseline' if attributes.key?(:'isBaseline') && attributes.key?(:'is_baseline') self.is_baseline = attributes[:'is_baseline'] unless attributes[:'is_baseline'].nil? self.is_deviated_from_baseline = attributes[:'isDeviatedFromBaseline'] unless attributes[:'isDeviatedFromBaseline'].nil? raise 'You cannot provide both :isDeviatedFromBaseline and :is_deviated_from_baseline' if attributes.key?(:'isDeviatedFromBaseline') && attributes.key?(:'is_deviated_from_baseline') self.is_deviated_from_baseline = attributes[:'is_deviated_from_baseline'] unless attributes[:'is_deviated_from_baseline'].nil? self.last_compared_baseline_id = attributes[:'lastComparedBaselineId'] if attributes[:'lastComparedBaselineId'] raise 'You cannot provide both :lastComparedBaselineId and :last_compared_baseline_id' if attributes.key?(:'lastComparedBaselineId') && attributes.key?(:'last_compared_baseline_id') self.last_compared_baseline_id = attributes[:'last_compared_baseline_id'] if attributes[:'last_compared_baseline_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.schedule_assessment_id = attributes[:'scheduleAssessmentId'] if attributes[:'scheduleAssessmentId'] raise 'You cannot provide both :scheduleAssessmentId and :schedule_assessment_id' if attributes.key?(:'scheduleAssessmentId') && attributes.key?(:'schedule_assessment_id') self.schedule_assessment_id = attributes[:'schedule_assessment_id'] if attributes[:'schedule_assessment_id'] self.schedule = attributes[:'schedule'] if attributes[:'schedule'] self.statistics = attributes[:'statistics'] if attributes[:'statistics'] self.target_ids = attributes[:'targetIds'] if attributes[:'targetIds'] raise 'You cannot provide both :targetIds and :target_ids' if attributes.key?(:'targetIds') && attributes.key?(:'target_ids') self.target_ids = attributes[:'target_ids'] if attributes[:'target_ids'] 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.time_last_assessed = attributes[:'timeLastAssessed'] if attributes[:'timeLastAssessed'] raise 'You cannot provide both :timeLastAssessed and :time_last_assessed' if attributes.key?(:'timeLastAssessed') && attributes.key?(:'time_last_assessed') self.time_last_assessed = attributes[:'time_last_assessed'] if attributes[:'time_last_assessed'] self.triggered_by = attributes[:'triggeredBy'] if attributes[:'triggeredBy'] raise 'You cannot provide both :triggeredBy and :triggered_by' if attributes.key?(:'triggeredBy') && attributes.key?(:'triggered_by') self.triggered_by = attributes[:'triggered_by'] if attributes[:'triggered_by'] self.type = attributes[:'type'] if attributes[:'type'] self. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the user assessment.
38 39 40 |
# File 'lib/oci/data_safe/models/user_assessment_summary.rb', line 38 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\"}}
155 156 157 |
# File 'lib/oci/data_safe/models/user_assessment_summary.rb', line 155 def @defined_tags end |
#description ⇒ String
The description of the user assessment.
42 43 44 |
# File 'lib/oci/data_safe/models/user_assessment_summary.rb', line 42 def description @description end |
#display_name ⇒ String
[Required] The display name of the user assessment.
46 47 48 |
# File 'lib/oci/data_safe/models/user_assessment_summary.rb', line 46 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\"}
148 149 150 |
# File 'lib/oci/data_safe/models/user_assessment_summary.rb', line 148 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the user assessment.
50 51 52 |
# File 'lib/oci/data_safe/models/user_assessment_summary.rb', line 50 def id @id end |
#ignored_assessment_ids ⇒ Array<Object>
List containing maps as values. Example: {\"Operations\": [ {\"CostCenter\": \"42\"} ] }
62 63 64 |
# File 'lib/oci/data_safe/models/user_assessment_summary.rb', line 62 def ignored_assessment_ids @ignored_assessment_ids end |
#ignored_targets ⇒ Array<Object>
List containing maps as values. Example: {\"Operations\": [ {\"CostCenter\": \"42\"} ] }
56 57 58 |
# File 'lib/oci/data_safe/models/user_assessment_summary.rb', line 56 def ignored_targets @ignored_targets end |
#is_baseline ⇒ BOOLEAN
Indicates if the assessment is a baseline assessment. This applies to saved user assessments only.
66 67 68 |
# File 'lib/oci/data_safe/models/user_assessment_summary.rb', line 66 def is_baseline @is_baseline end |
#is_deviated_from_baseline ⇒ BOOLEAN
Indicates if the assessment has deviated from the baseline.
70 71 72 |
# File 'lib/oci/data_safe/models/user_assessment_summary.rb', line 70 def is_deviated_from_baseline @is_deviated_from_baseline end |
#last_compared_baseline_id ⇒ String
The OCID of the last user assessment baseline against which the latest assessment was compared.
74 75 76 |
# File 'lib/oci/data_safe/models/user_assessment_summary.rb', line 74 def last_compared_baseline_id @last_compared_baseline_id end |
#lifecycle_details ⇒ String
Details about the current state of the user assessment.
82 83 84 |
# File 'lib/oci/data_safe/models/user_assessment_summary.rb', line 82 def lifecycle_details @lifecycle_details end |
#lifecycle_state ⇒ String
[Required] The current state of the user assessment.
78 79 80 |
# File 'lib/oci/data_safe/models/user_assessment_summary.rb', line 78 def lifecycle_state @lifecycle_state end |
#schedule ⇒ String
Schedule to save the assessment periodically in the specified format: <version-string>;<version-specific-schedule>
Allowed version strings - "v1" v1's version specific schedule -<ss> <mm> <hh> <day-of-week> <day-of-month> Each of the above fields potentially introduce constraints. A workrequest is created only when clock time satisfies all the constraints. Constraints introduced: 1. seconds = <ss> (So, the allowed range for <ss> is [0, 59]) 2. minutes = <mm> (So, the allowed range for <mm> is [0, 59]) 3. hours = <hh> (So, the allowed range for <hh> is [0, 23]) <day-of-week> can be either '' (without quotes or a number between 1(Monday) and 7(Sunday)) 4. No constraint introduced when it is ''. When not, day of week must equal the given value <day-of-month> can be either '' (without quotes or a number between 1 and 28) 5. No constraint introduced when it is ''. When not, day of month must equal the given value
104 105 106 |
# File 'lib/oci/data_safe/models/user_assessment_summary.rb', line 104 def schedule @schedule end |
#schedule_assessment_id ⇒ String
The OCID of the user assessment that created this scheduled save assessment.
86 87 88 |
# File 'lib/oci/data_safe/models/user_assessment_summary.rb', line 86 def schedule_assessment_id @schedule_assessment_id end |
#statistics ⇒ Hash<String, Hash<String, Object>>
Map that contains maps of values. Example: {\"Operations\": {\"CostCenter\": \"42\"}}
110 111 112 |
# File 'lib/oci/data_safe/models/user_assessment_summary.rb', line 110 def statistics @statistics end |
#target_ids ⇒ Array<String>
Array of database target OCIDs.
114 115 116 |
# File 'lib/oci/data_safe/models/user_assessment_summary.rb', line 114 def target_ids @target_ids end |
#time_created ⇒ DateTime
[Required] The date and time the user assessment was created, in the format defined by RFC3339.
118 119 120 |
# File 'lib/oci/data_safe/models/user_assessment_summary.rb', line 118 def time_created @time_created end |
#time_last_assessed ⇒ DateTime
The date and time the user assessment was last executed, in the format defined by RFC3339.
126 127 128 |
# File 'lib/oci/data_safe/models/user_assessment_summary.rb', line 126 def time_last_assessed @time_last_assessed end |
#time_updated ⇒ DateTime
[Required] The last date and time the user assessment was updated, in the format defined by RFC3339.
122 123 124 |
# File 'lib/oci/data_safe/models/user_assessment_summary.rb', line 122 def time_updated @time_updated end |
#triggered_by ⇒ String
Indicates whether the user assessment was created by the system or the user.
130 131 132 |
# File 'lib/oci/data_safe/models/user_assessment_summary.rb', line 130 def triggered_by @triggered_by end |
#type ⇒ String
[Required] The type of the user assessment. The possible types are:
LATEST: The latest assessment that was executed for a target. It can either be system generated as part of the scheduled assessments or user driven by refreshing the latest assessment. SAVED: A saved user assessment. All user assessments are saved in the user assessment history. SAVE_SCHEDULE: The schedule to periodically save the LATEST assessment of a target database. COMPARTMENT: An automatic managed assessment type that stores all details of the targets in one compartment. This will keep an up-to-date status of all potential risks identified in the compartment. It is automatically updated once the latest assessment or refresh action is executed, as well as when a target is deleted or moved to a different compartment.
141 142 143 |
# File 'lib/oci/data_safe/models/user_assessment_summary.rb', line 141 def type @type end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
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 184 185 |
# File 'lib/oci/data_safe/models/user_assessment_summary.rb', line 158 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'compartmentId', 'description': :'description', 'display_name': :'displayName', 'id': :'id', 'ignored_targets': :'ignoredTargets', 'ignored_assessment_ids': :'ignoredAssessmentIds', 'is_baseline': :'isBaseline', 'is_deviated_from_baseline': :'isDeviatedFromBaseline', 'last_compared_baseline_id': :'lastComparedBaselineId', 'lifecycle_state': :'lifecycleState', 'lifecycle_details': :'lifecycleDetails', 'schedule_assessment_id': :'scheduleAssessmentId', 'schedule': :'schedule', 'statistics': :'statistics', 'target_ids': :'targetIds', 'time_created': :'timeCreated', 'time_updated': :'timeUpdated', 'time_last_assessed': :'timeLastAssessed', 'triggered_by': :'triggeredBy', 'type': :'type', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
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 |
# File 'lib/oci/data_safe/models/user_assessment_summary.rb', line 188 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'String', 'description': :'String', 'display_name': :'String', 'id': :'String', 'ignored_targets': :'Array<Object>', 'ignored_assessment_ids': :'Array<Object>', 'is_baseline': :'BOOLEAN', 'is_deviated_from_baseline': :'BOOLEAN', 'last_compared_baseline_id': :'String', 'lifecycle_state': :'String', 'lifecycle_details': :'String', 'schedule_assessment_id': :'String', 'schedule': :'String', 'statistics': :'Hash<String, Hash<String, Object>>', 'target_ids': :'Array<String>', 'time_created': :'DateTime', 'time_updated': :'DateTime', 'time_last_assessed': :'DateTime', 'triggered_by': :'String', 'type': :'String', '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.
410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 |
# File 'lib/oci/data_safe/models/user_assessment_summary.rb', line 410 def ==(other) return true if equal?(other) self.class == other.class && compartment_id == other.compartment_id && description == other.description && display_name == other.display_name && id == other.id && ignored_targets == other.ignored_targets && ignored_assessment_ids == other.ignored_assessment_ids && is_baseline == other.is_baseline && is_deviated_from_baseline == other.is_deviated_from_baseline && last_compared_baseline_id == other.last_compared_baseline_id && lifecycle_state == other.lifecycle_state && lifecycle_details == other.lifecycle_details && schedule_assessment_id == other.schedule_assessment_id && schedule == other.schedule && statistics == other.statistics && target_ids == other.target_ids && time_created == other.time_created && time_updated == other.time_updated && time_last_assessed == other.time_last_assessed && triggered_by == other.triggered_by && type == other.type && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 |
# File 'lib/oci/data_safe/models/user_assessment_summary.rb', line 461 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
441 442 443 |
# File 'lib/oci/data_safe/models/user_assessment_summary.rb', line 441 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
450 451 452 |
# File 'lib/oci/data_safe/models/user_assessment_summary.rb', line 450 def hash [compartment_id, description, display_name, id, ignored_targets, ignored_assessment_ids, is_baseline, is_deviated_from_baseline, last_compared_baseline_id, lifecycle_state, lifecycle_details, schedule_assessment_id, schedule, statistics, target_ids, time_created, time_updated, time_last_assessed, triggered_by, type, , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
494 495 496 497 498 499 500 501 502 503 |
# File 'lib/oci/data_safe/models/user_assessment_summary.rb', line 494 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
488 489 490 |
# File 'lib/oci/data_safe/models/user_assessment_summary.rb', line 488 def to_s to_hash.to_s end |