Class: OCI::DataSafe::Models::Report

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

Overview

The description of the report.

Constant Summary collapse

MIME_TYPE_ENUM = 
[
  MIME_TYPE_PDF = 'PDF'.freeze,
  MIME_TYPE_XLS = 'XLS'.freeze,
  MIME_TYPE_JSON = 'JSON'.freeze,
  MIME_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
TYPE_ENUM = 
[
  TYPE_GENERATED = 'GENERATED'.freeze,
  TYPE_SCHEDULED = 'SCHEDULED'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
DATA_SOURCE_ENUM = 
[
  DATA_SOURCE_EVENTS = 'EVENTS'.freeze,
  DATA_SOURCE_ALERTS = 'ALERTS'.freeze,
  DATA_SOURCE_SECURITY_ASSESSMENT = 'SECURITY_ASSESSMENT'.freeze,
  DATA_SOURCE_VIOLATIONS = 'VIOLATIONS'.freeze,
  DATA_SOURCE_ALLOWED_SQL = 'ALLOWED_SQL'.freeze,
  DATA_SOURCE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Report

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

  • :display_name (String) —

    The value to assign to the #display_name property

  • :report_definition_id (String) —

    The value to assign to the #report_definition_id property

  • :description (String) —

    The value to assign to the #description property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :mime_type (String) —

    The value to assign to the #mime_type property

  • :time_generated (DateTime) —

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

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :type (String) —

    The value to assign to the #type property

  • :data_source (String) —

    The value to assign to the #data_source property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :previous_report_id (String) —

    The value to assign to the #previous_report_id property

  • :next_report_id (String) —

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



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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/oci/data_safe/models/report.rb', line 197

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

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

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

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

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

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

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

  self.time_generated = attributes[:'timeGenerated'] if attributes[:'timeGenerated']

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

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

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

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

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

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

  self.next_report_id = attributes[:'nextReportId'] if attributes[:'nextReportId']

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

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

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

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/data_safe/models/report.rb', line 60

def compartment_id
  @compartment_id
end

#data_source ⇒ String

Specifies the name of a resource that provides data for the report. For example alerts, events.

Returns:

  • (String) 


88
89
90
 
# File 'lib/oci/data_safe/models/report.rb', line 88

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\"}}

Returns:

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


113
114
115
 
# File 'lib/oci/data_safe/models/report.rb', line 113

def defined_tags
  @defined_tags
end

#description ⇒ String

Specifies a description of the report.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/data_safe/models/report.rb', line 56

def description
  @description
end

#display_name ⇒ String

[Required] Name of the report.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/data_safe/models/report.rb', line 48

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


107
108
109
 
# File 'lib/oci/data_safe/models/report.rb', line 107

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the report.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/data_safe/models/report.rb', line 44

def id
  @id
end

#lifecycle_details ⇒ String

Details about the current state of the report in Data Safe.

Returns:

  • (String) 


92
93
94
 
# File 'lib/oci/data_safe/models/report.rb', line 92

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the audit report.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#mime_type ⇒ String

Specifies the format of report to be .xls or .pdf or .json

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/data_safe/models/report.rb', line 64

def mime_type
  @mime_type
end

#next_report_id ⇒ String

The OCID of the next report generated.

Returns:

  • (String) 


100
101
102
 
# File 'lib/oci/data_safe/models/report.rb', line 100

def next_report_id
  @next_report_id
end

#previous_report_id ⇒ String

The OCID of the previous report generated.

Returns:

  • (String) 


96
97
98
 
# File 'lib/oci/data_safe/models/report.rb', line 96

def previous_report_id
  @previous_report_id
end

#report_definition_id ⇒ String

The OCID of the report definition.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/data_safe/models/report.rb', line 52

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


119
120
121
 
# File 'lib/oci/data_safe/models/report.rb', line 119

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

Specifies the time at which the report was created.

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#time_generated ⇒ DateTime

[Required] Specifies the date and time the report was generated.

Returns:

  • (DateTime) 


68
69
70
 
# File 'lib/oci/data_safe/models/report.rb', line 68

def time_generated
  @time_generated
end

#time_updated ⇒ DateTime

The date and time of the report update in Data Safe.

Returns:

  • (DateTime) 


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

def time_updated
  @time_updated
end

#type ⇒ String

The type of the audit report.

Returns:

  • (String) 


84
85
86
 
# File 'lib/oci/data_safe/models/report.rb', line 84

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/oci/data_safe/models/report.rb', line 122

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'report_definition_id': :'reportDefinitionId',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'mime_type': :'mimeType',
    'time_generated': :'timeGenerated',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'type': :'type',
    'data_source': :'dataSource',
    'lifecycle_details': :'lifecycleDetails',
    'previous_report_id': :'previousReportId',
    'next_report_id': :'nextReportId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/oci/data_safe/models/report.rb', line 148

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'report_definition_id': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'mime_type': :'String',
    'time_generated': :'DateTime',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'type': :'String',
    'data_source': :'String',
    'lifecycle_details': :'String',
    'previous_report_id': :'String',
    'next_report_id': :'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



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/oci/data_safe/models/report.rb', line 359

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    report_definition_id == other.report_definition_id &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    mime_type == other.mime_type &&
    time_generated == other.time_generated &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    type == other.type &&
    data_source == other.data_source &&
    lifecycle_details == other.lifecycle_details &&
    previous_report_id == other.previous_report_id &&
    next_report_id == other.next_report_id &&
    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



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/oci/data_safe/models/report.rb', line 406

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


386
387
388
 
# File 'lib/oci/data_safe/models/report.rb', line 386

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



395
396
397
 
# File 'lib/oci/data_safe/models/report.rb', line 395

def hash
  [id, display_name, report_definition_id, description, compartment_id, mime_type, time_generated, time_created, time_updated, lifecycle_state, type, data_source, lifecycle_details, previous_report_id, next_report_id, 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



439
440
441
442
443
444
445
446
447
448
 
# File 'lib/oci/data_safe/models/report.rb', line 439

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



433
434
435
 
# File 'lib/oci/data_safe/models/report.rb', line 433

def to_s
  to_hash.to_s
end