Class: OCI::DataSafe::Models::ReportDefinitionSummary
- Inherits:
-
Object
- Object
- OCI::DataSafe::Models::ReportDefinitionSummary
- Defined in:
- lib/oci/data_safe/models/report_definition_summary.rb
Overview
Summary of report definition.
Constant Summary collapse
- CATEGORY_ENUM =
[ CATEGORY_CUSTOM_REPORTS = 'CUSTOM_REPORTS'.freeze, CATEGORY_SUMMARY = 'SUMMARY'.freeze, CATEGORY_ACTIVITY_AUDITING = 'ACTIVITY_AUDITING'.freeze, CATEGORY_FIREWALL_VIOLATIONS = 'FIREWALL_VIOLATIONS'.freeze, CATEGORY_ALLOWED_SQL = 'ALLOWED_SQL'.freeze, CATEGORY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- DATA_SOURCE_ENUM =
[ DATA_SOURCE_EVENTS = 'EVENTS'.freeze, DATA_SOURCE_ALERTS = 'ALERTS'.freeze, DATA_SOURCE_VIOLATIONS = 'VIOLATIONS'.freeze, DATA_SOURCE_ALLOWED_SQL = 'ALLOWED_SQL'.freeze, DATA_SOURCE_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_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#category ⇒ String
Specifies the name of the category that this report belongs to.
-
#compartment_id ⇒ String
[Required] The OCID of the compartment containing the report definition.
-
#compliance_standards ⇒ Array<String>
The list of data protection regulations/standards used in the report that will help demonstrate compliance.
-
#data_source ⇒ String
Specifies the name of a resource that provides data for the report.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#description ⇒ String
A description of the report definition.
-
#display_name ⇒ String
[Required] Name of the report definition.
-
#display_order ⇒ Integer
Specifies how the report definitions are ordered in the display.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#id ⇒ String
[Required] The OCID of the report definition.
-
#is_seeded ⇒ BOOLEAN
Signifies whether the definition is seeded or user defined.
-
#lifecycle_state ⇒ String
[Required] The current state of the audit report.
-
#schedule ⇒ String
The schedule to generate the report periodically in the specified format: <version-string>;<version-specific-schedule>.
-
#time_created ⇒ DateTime
[Required] Specifies the time at which the report definition was created.
-
#time_updated ⇒ DateTime
The date and time of the report definition update in Data Safe.
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 = {}) ⇒ ReportDefinitionSummary
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 = {}) ⇒ ReportDefinitionSummary
Initializes the object
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 257 258 259 260 261 262 263 264 |
# File 'lib/oci/data_safe/models/report_definition_summary.rb', line 185 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.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.category = attributes[:'category'] if attributes[:'category'] self.description = attributes[:'description'] if attributes[:'description'] 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.display_order = attributes[:'displayOrder'] if attributes[:'displayOrder'] raise 'You cannot provide both :displayOrder and :display_order' if attributes.key?(:'displayOrder') && attributes.key?(:'display_order') self.display_order = attributes[:'display_order'] if attributes[:'display_order'] 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.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.data_source = attributes[:'dataSource'] if attributes[:'dataSource'] raise 'You cannot provide both :dataSource and :data_source' if attributes.key?(:'dataSource') && attributes.key?(:'data_source') self.data_source = attributes[:'data_source'] if attributes[:'data_source'] 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.schedule = attributes[:'schedule'] if attributes[:'schedule'] self.compliance_standards = attributes[:'complianceStandards'] if attributes[:'complianceStandards'] raise 'You cannot provide both :complianceStandards and :compliance_standards' if attributes.key?(:'complianceStandards') && attributes.key?(:'compliance_standards') self.compliance_standards = attributes[:'compliance_standards'] if attributes[:'compliance_standards'] 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
#category ⇒ String
Specifies the name of the category that this report belongs to.
48 49 50 |
# File 'lib/oci/data_safe/models/report_definition_summary.rb', line 48 def category @category end |
#compartment_id ⇒ String
[Required] The OCID of the compartment containing the report definition.
72 73 74 |
# File 'lib/oci/data_safe/models/report_definition_summary.rb', line 72 def compartment_id @compartment_id end |
#compliance_standards ⇒ Array<String>
The list of data protection regulations/standards used in the report that will help demonstrate compliance.
102 103 104 |
# File 'lib/oci/data_safe/models/report_definition_summary.rb', line 102 def compliance_standards @compliance_standards end |
#data_source ⇒ String
Specifies the name of a resource that provides data for the report. For example alerts, events.
76 77 78 |
# File 'lib/oci/data_safe/models/report_definition_summary.rb', line 76 def data_source @data_source 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\"}}
116 117 118 |
# File 'lib/oci/data_safe/models/report_definition_summary.rb', line 116 def @defined_tags end |
#description ⇒ String
A description of the report definition.
52 53 54 |
# File 'lib/oci/data_safe/models/report_definition_summary.rb', line 52 def description @description end |
#display_name ⇒ String
[Required] Name of the report definition.
40 41 42 |
# File 'lib/oci/data_safe/models/report_definition_summary.rb', line 40 def display_name @display_name end |
#display_order ⇒ Integer
Specifies how the report definitions are ordered in the display.
60 61 62 |
# File 'lib/oci/data_safe/models/report_definition_summary.rb', line 60 def display_order @display_order 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\"}
109 110 111 |
# File 'lib/oci/data_safe/models/report_definition_summary.rb', line 109 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the report definition.
44 45 46 |
# File 'lib/oci/data_safe/models/report_definition_summary.rb', line 44 def id @id end |
#is_seeded ⇒ BOOLEAN
Signifies whether the definition is seeded or user defined. Values can either be 'true' or 'false'.
56 57 58 |
# File 'lib/oci/data_safe/models/report_definition_summary.rb', line 56 def is_seeded @is_seeded end |
#lifecycle_state ⇒ String
[Required] The current state of the audit report.
80 81 82 |
# File 'lib/oci/data_safe/models/report_definition_summary.rb', line 80 def lifecycle_state @lifecycle_state end |
#schedule ⇒ String
The schedule to generate the report 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 work request 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]) 4. <day-of-week> can be either '' (without quotes or a number between 1(Monday) and 7(Sunday)) No constraint introduced when it is ''. When not, day of week must equal the given value. 5. <day-of-month> can be either '' (without quotes or a number between 1 and 28) No constraint introduced when it is ''. When not, day of month must equal the given value
98 99 100 |
# File 'lib/oci/data_safe/models/report_definition_summary.rb', line 98 def schedule @schedule end |
#time_created ⇒ DateTime
[Required] Specifies the time at which the report definition was created.
64 65 66 |
# File 'lib/oci/data_safe/models/report_definition_summary.rb', line 64 def time_created @time_created end |
#time_updated ⇒ DateTime
The date and time of the report definition update in Data Safe.
68 69 70 |
# File 'lib/oci/data_safe/models/report_definition_summary.rb', line 68 def time_updated @time_updated end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
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/report_definition_summary.rb', line 119 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'display_name': :'displayName', 'id': :'id', 'category': :'category', 'description': :'description', 'is_seeded': :'isSeeded', 'display_order': :'displayOrder', 'time_created': :'timeCreated', 'time_updated': :'timeUpdated', 'compartment_id': :'compartmentId', 'data_source': :'dataSource', 'lifecycle_state': :'lifecycleState', 'schedule': :'schedule', 'compliance_standards': :'complianceStandards', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags' # 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 |
# File 'lib/oci/data_safe/models/report_definition_summary.rb', line 142 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'display_name': :'String', 'id': :'String', 'category': :'String', 'description': :'String', 'is_seeded': :'BOOLEAN', 'display_order': :'Integer', 'time_created': :'DateTime', 'time_updated': :'DateTime', 'compartment_id': :'String', 'data_source': :'String', 'lifecycle_state': :'String', 'schedule': :'String', 'compliance_standards': :'Array<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.
312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 |
# File 'lib/oci/data_safe/models/report_definition_summary.rb', line 312 def ==(other) return true if equal?(other) self.class == other.class && display_name == other.display_name && id == other.id && category == other.category && description == other.description && is_seeded == other.is_seeded && display_order == other.display_order && time_created == other.time_created && time_updated == other.time_updated && compartment_id == other.compartment_id && data_source == other.data_source && lifecycle_state == other.lifecycle_state && schedule == other.schedule && compliance_standards == other.compliance_standards && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 |
# File 'lib/oci/data_safe/models/report_definition_summary.rb', line 356 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
336 337 338 |
# File 'lib/oci/data_safe/models/report_definition_summary.rb', line 336 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
345 346 347 |
# File 'lib/oci/data_safe/models/report_definition_summary.rb', line 345 def hash [display_name, id, category, description, is_seeded, display_order, time_created, time_updated, compartment_id, data_source, lifecycle_state, schedule, compliance_standards, , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
389 390 391 392 393 394 395 396 397 398 |
# File 'lib/oci/data_safe/models/report_definition_summary.rb', line 389 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
383 384 385 |
# File 'lib/oci/data_safe/models/report_definition_summary.rb', line 383 def to_s to_hash.to_s end |