Class: OCI::DataSafe::Models::ReportDefinition

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

Overview

Description 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_SECURITY_ASSESSMENT = 'SECURITY_ASSESSMENT'.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_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
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
SCHEDULED_REPORT_MIME_TYPE_ENUM = 
[
  SCHEDULED_REPORT_MIME_TYPE_PDF = 'PDF'.freeze,
  SCHEDULED_REPORT_MIME_TYPE_XLS = 'XLS'.freeze,
  SCHEDULED_REPORT_MIME_TYPE_JSON = 'JSON'.freeze,
  SCHEDULED_REPORT_MIME_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ReportDefinition

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
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
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/oci/data_safe/models/report_definition.rb', line 307

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

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

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

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

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

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

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

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

  self.column_info = attributes[:'columnInfo'] if attributes[:'columnInfo']

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

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

  self.column_filters = attributes[:'columnFilters'] if attributes[:'columnFilters']

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

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

  self.column_sortings = attributes[:'columnSortings'] if attributes[:'columnSortings']

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

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

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

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

  self.scheduled_report_mime_type = attributes[:'scheduledReportMimeType'] if attributes[:'scheduledReportMimeType']

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

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

  self.scheduled_report_row_limit = attributes[:'scheduledReportRowLimit'] if attributes[:'scheduledReportRowLimit']

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

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

  self.scheduled_report_name = attributes[:'scheduledReportName'] if attributes[:'scheduledReportName']

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

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

  self.scheduled_report_compartment_id = attributes[:'scheduledReportCompartmentId'] if attributes[:'scheduledReportCompartmentId']

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

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

  self.record_time_span = attributes[:'recordTimeSpan'] if attributes[:'recordTimeSpan']

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

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

  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.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.is_schedule_pagination_enabled = attributes[:'isSchedulePaginationEnabled'] unless attributes[:'isSchedulePaginationEnabled'].nil?
  self.is_schedule_pagination_enabled = false if is_schedule_pagination_enabled.nil? && !attributes.key?(:'isSchedulePaginationEnabled') # rubocop:disable Style/StringLiterals

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

  self.is_schedule_pagination_enabled = attributes[:'is_schedule_pagination_enabled'] unless attributes[:'is_schedule_pagination_enabled'].nil?
  self.is_schedule_pagination_enabled = false if is_schedule_pagination_enabled.nil? && !attributes.key?(:'isSchedulePaginationEnabled') && !attributes.key?(:'is_schedule_pagination_enabled') # rubocop:disable Style/StringLiterals

  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

#category ⇒ String

Specifies the name of the category that this report belongs to.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/data_safe/models/report_definition.rb', line 62

def category
  @category
end

#column_filters ⇒ Array<OCI::DataSafe::Models::ColumnFilter>

An array of columnFilter objects. A columnFilter object stores all information about a column filter including field name, an operator, one or more expressions, if the filter is enabled, or if the filter is hidden.

Returns:



98
99
100
 
# File 'lib/oci/data_safe/models/report_definition.rb', line 98

def column_filters
  @column_filters
end

#column_info ⇒ Array<OCI::DataSafe::Models::Column>

An array of column objects in the order (left to right) displayed in the report. A column object stores all information about a column, including the name displayed on the UI, corresponding field name in the data source, data type of the column, and column visibility (if the column is visible to the user).

Returns:



94
95
96
 
# File 'lib/oci/data_safe/models/report_definition.rb', line 94

def column_info
  @column_info
end

#column_sortings ⇒ Array<OCI::DataSafe::Models::ColumnSorting>

An array of column sorting objects. Each column sorting object stores the column name to be sorted and if the sorting is in ascending order; sorting is done by the first column in the array, then by the second column in the array, etc.

Returns:



102
103
104
 
# File 'lib/oci/data_safe/models/report_definition.rb', line 102

def column_sortings
  @column_sortings
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


110
111
112
 
# File 'lib/oci/data_safe/models/report_definition.rb', line 110

def compartment_id
  @compartment_id
end

#compliance_standards ⇒ Array<String>

The list of the data protection regulations/standards used in the report that will help demonstrate compliance.

Returns:

  • (Array<String>) 


166
167
168
 
# File 'lib/oci/data_safe/models/report_definition.rb', line 166

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.

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/data_safe/models/report_definition.rb', line 70

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


190
191
192
 
# File 'lib/oci/data_safe/models/report_definition.rb', line 190

def defined_tags
  @defined_tags
end

#description ⇒ String

A description of the report definition.

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/data_safe/models/report_definition.rb', line 66

def description
  @description
end

#display_name ⇒ String

[Required] Name of the report definition.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/data_safe/models/report_definition.rb', line 50

def display_name
  @display_name
end

#display_order ⇒ Integer

Specifies how the report definitions are ordered in the display.

Returns:

  • (Integer) 


78
79
80
 
# File 'lib/oci/data_safe/models/report_definition.rb', line 78

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

Returns:

  • (Hash<String, String>) 


184
185
186
 
# File 'lib/oci/data_safe/models/report_definition.rb', line 184

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the report definition.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/data_safe/models/report_definition.rb', line 54

def id
  @id
end

#is_schedule_pagination_enabled ⇒ BOOLEAN

Indicates if the reports being generated should be paginated. If set to true, multiple reports can be generated and the details of next and previous report are present in Report. Values can either be 'true' or 'false'.

Returns:

  • (BOOLEAN) 


177
178
179
 
# File 'lib/oci/data_safe/models/report_definition.rb', line 177

def is_schedule_pagination_enabled
  @is_schedule_pagination_enabled
end

#is_seeded ⇒ BOOLEAN

Signifies whether the definition is seeded or user defined. Values can either be 'true' or 'false'.

Returns:

  • (BOOLEAN) 


74
75
76
 
# File 'lib/oci/data_safe/models/report_definition.rb', line 74

def is_seeded
  @is_seeded
end

#lifecycle_details ⇒ String

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

Returns:

  • (String) 


170
171
172
 
# File 'lib/oci/data_safe/models/report_definition.rb', line 170

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the report.

Returns:

  • (String) 


114
115
116
 
# File 'lib/oci/data_safe/models/report_definition.rb', line 114

def lifecycle_state
  @lifecycle_state
end

#parent_id ⇒ String

The OCID of the parent report definition. In the case of seeded report definition, this is same as definition OCID.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/data_safe/models/report_definition.rb', line 58

def parent_id
  @parent_id
end

#record_time_span ⇒ String

The time span for the records in the report to be scheduled. <period-value><period> Allowed period strings - "H","D","M","Y" Each of the above fields potentially introduce constraints. A workRequest is created only when period-value satisfies all the constraints. Constraints introduced: 1. period = H (The allowed range for period-value is [1, 23]) 2. period = D (The allowed range for period-value is [1, 30]) 3. period = M (The allowed range for period-value is [1, 11]) 4. period = Y (The minimum period-value is 1)

Returns:

  • (String) 


162
163
164
 
# File 'lib/oci/data_safe/models/report_definition.rb', line 162

def record_time_span
  @record_time_span
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 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]) 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

Returns:

  • (String) 


132
133
134
 
# File 'lib/oci/data_safe/models/report_definition.rb', line 132

def schedule
  @schedule
end

#scheduled_report_compartment_id ⇒ String

The OCID of the compartment in which the scheduled resource will be created.

Returns:

  • (String) 


149
150
151
 
# File 'lib/oci/data_safe/models/report_definition.rb', line 149

def scheduled_report_compartment_id
  @scheduled_report_compartment_id
end

#scheduled_report_mime_type ⇒ String

Specifies the format of the report ( either .xls or .pdf or .json)

Returns:

  • (String) 


136
137
138
 
# File 'lib/oci/data_safe/models/report_definition.rb', line 136

def scheduled_report_mime_type
  @scheduled_report_mime_type
end

#scheduled_report_name ⇒ String

The name of the report to be scheduled.

Returns:

  • (String) 


144
145
146
 
# File 'lib/oci/data_safe/models/report_definition.rb', line 144

def scheduled_report_name
  @scheduled_report_name
end

#scheduled_report_row_limit ⇒ Integer

Specifies the limit on the number of rows in the report.

Returns:

  • (Integer) 


140
141
142
 
# File 'lib/oci/data_safe/models/report_definition.rb', line 140

def scheduled_report_row_limit
  @scheduled_report_row_limit
end

#scim_filter ⇒ String

Additional SCIM filters used to define the report.

Returns:

  • (String) 


90
91
92
 
# File 'lib/oci/data_safe/models/report_definition.rb', line 90

def scim_filter
  @scim_filter
end

#summary ⇒ Array<OCI::DataSafe::Models::Summary>

An array of report summary objects in the order (left to right) displayed in the report. A report summary object stores all information about summary of report to be displayed, including the name displayed on UI, the display order, corresponding group by and count of values, summary visibility (if the summary is visible to user).

Returns:



106
107
108
 
# File 'lib/oci/data_safe/models/report_definition.rb', line 106

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


196
197
198
 
# File 'lib/oci/data_safe/models/report_definition.rb', line 196

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

Specifies the date and time the report definition was created.

Returns:

  • (DateTime) 


82
83
84
 
# File 'lib/oci/data_safe/models/report_definition.rb', line 82

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The date and time the report definition was updated.

Returns:

  • (DateTime) 


86
87
88
 
# File 'lib/oci/data_safe/models/report_definition.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.



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'id': :'id',
    'parent_id': :'parentId',
    'category': :'category',
    'description': :'description',
    'data_source': :'dataSource',
    'is_seeded': :'isSeeded',
    'display_order': :'displayOrder',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'scim_filter': :'scimFilter',
    'column_info': :'columnInfo',
    'column_filters': :'columnFilters',
    'column_sortings': :'columnSortings',
    'summary': :'summary',
    'compartment_id': :'compartmentId',
    'lifecycle_state': :'lifecycleState',
    'schedule': :'schedule',
    'scheduled_report_mime_type': :'scheduledReportMimeType',
    'scheduled_report_row_limit': :'scheduledReportRowLimit',
    'scheduled_report_name': :'scheduledReportName',
    'scheduled_report_compartment_id': :'scheduledReportCompartmentId',
    'record_time_span': :'recordTimeSpan',
    'compliance_standards': :'complianceStandards',
    'lifecycle_details': :'lifecycleDetails',
    'is_schedule_pagination_enabled': :'isSchedulePaginationEnabled',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'id': :'String',
    'parent_id': :'String',
    'category': :'String',
    'description': :'String',
    'data_source': :'String',
    'is_seeded': :'BOOLEAN',
    'display_order': :'Integer',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'scim_filter': :'String',
    'column_info': :'Array<OCI::DataSafe::Models::Column>',
    'column_filters': :'Array<OCI::DataSafe::Models::ColumnFilter>',
    'column_sortings': :'Array<OCI::DataSafe::Models::ColumnSorting>',
    'summary': :'Array<OCI::DataSafe::Models::Summary>',
    'compartment_id': :'String',
    'lifecycle_state': :'String',
    'schedule': :'String',
    'scheduled_report_mime_type': :'String',
    'scheduled_report_row_limit': :'Integer',
    'scheduled_report_name': :'String',
    'scheduled_report_compartment_id': :'String',
    'record_time_span': :'String',
    'compliance_standards': :'Array<String>',
    'lifecycle_details': :'String',
    'is_schedule_pagination_enabled': :'BOOLEAN',
    '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



529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
 
# File 'lib/oci/data_safe/models/report_definition.rb', line 529

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

  self.class == other.class &&
    display_name == other.display_name &&
    id == other.id &&
    parent_id == other.parent_id &&
    category == other.category &&
    description == other.description &&
    data_source == other.data_source &&
    is_seeded == other.is_seeded &&
    display_order == other.display_order &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    scim_filter == other.scim_filter &&
    column_info == other.column_info &&
    column_filters == other.column_filters &&
    column_sortings == other.column_sortings &&
    summary == other.summary &&
    compartment_id == other.compartment_id &&
    lifecycle_state == other.lifecycle_state &&
    schedule == other.schedule &&
    scheduled_report_mime_type == other.scheduled_report_mime_type &&
    scheduled_report_row_limit == other.scheduled_report_row_limit &&
    scheduled_report_name == other.scheduled_report_name &&
    scheduled_report_compartment_id == other.scheduled_report_compartment_id &&
    record_time_span == other.record_time_span &&
    compliance_standards == other.compliance_standards &&
    lifecycle_details == other.lifecycle_details &&
    is_schedule_pagination_enabled == other.is_schedule_pagination_enabled &&
    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



587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
 
# File 'lib/oci/data_safe/models/report_definition.rb', line 587

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


567
568
569
 
# File 'lib/oci/data_safe/models/report_definition.rb', line 567

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



576
577
578
 
# File 'lib/oci/data_safe/models/report_definition.rb', line 576

def hash
  [display_name, id, parent_id, category, description, data_source, is_seeded, display_order, time_created, time_updated, scim_filter, column_info, column_filters, column_sortings, summary, compartment_id, lifecycle_state, schedule, scheduled_report_mime_type, scheduled_report_row_limit, scheduled_report_name, scheduled_report_compartment_id, record_time_span, compliance_standards, lifecycle_details, is_schedule_pagination_enabled, 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



620
621
622
623
624
625
626
627
628
629
 
# File 'lib/oci/data_safe/models/report_definition.rb', line 620

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



614
615
616
 
# File 'lib/oci/data_safe/models/report_definition.rb', line 614

def to_s
  to_hash.to_s
end