Class: OCI::DataSafe::Models::ReportSummary

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

Overview

Description of 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 = {}) ⇒ ReportSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :display_name (String) —

    The value to assign to the #display_name property

  • :id (String) —

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

  • :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

  • :compartment_id (String) —

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

  • :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



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
 
# File 'lib/oci/data_safe/models/report_summary.rb', line 167

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

#compartment_id ⇒ String

[Required] The OCID of the compartment containing the report.

Returns:

  • (String) 


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

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


101
102
103
 
# File 'lib/oci/data_safe/models/report_summary.rb', line 101

def defined_tags
  @defined_tags
end

#description ⇒ String

Description of the report.

Returns:

  • (String) 


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

def description
  @description
end

#display_name ⇒ String

[Required] Name of the report.

Returns:

  • (String) 


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

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


95
96
97
 
# File 'lib/oci/data_safe/models/report_summary.rb', line 95

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the report.

Returns:

  • (String) 


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

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current state of the report.

Returns:

  • (String) 


80
81
82
 
# File 'lib/oci/data_safe/models/report_summary.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) 


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

def mime_type
  @mime_type
end

#report_definition_id ⇒ String

The OCID of the report definition.

Returns:

  • (String) 


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

def report_definition_id
  @report_definition_id
end

#time_created ⇒ DateTime

Specifies the time at which the report was created.

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#time_generated ⇒ DateTime

[Required] Specifies the time at which the report was generated.

Returns:

  • (DateTime) 


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

def time_generated
  @time_generated
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_updated
  @time_updated
end

#type ⇒ String

The type of the report.

Returns:

  • (String) 


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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/oci/data_safe/models/report_summary.rb', line 104

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

.swagger_types ⇒ Object

Attribute type mapping.



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_summary.rb', line 126

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

Parameters:

  • other (Object) —

    the other object to be compared



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/oci/data_safe/models/report_summary.rb', line 305

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

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



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/oci/data_safe/models/report_summary.rb', line 348

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


328
329
330
 
# File 'lib/oci/data_safe/models/report_summary.rb', line 328

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



337
338
339
 
# File 'lib/oci/data_safe/models/report_summary.rb', line 337

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



381
382
383
384
385
386
387
388
389
390
 
# File 'lib/oci/data_safe/models/report_summary.rb', line 381

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



375
376
377
 
# File 'lib/oci/data_safe/models/report_summary.rb', line 375

def to_s
  to_hash.to_s
end