Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ReportDefinitionSummary

Summary of report definition.

Properties

Optional category

category: Category

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

compartmentId

compartmentId: string

The OCID of the compartment containing the report definition.

Optional complianceStandards

complianceStandards: Array<string>

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

Optional dataSource

dataSource: model.ReportDefinitionDataSource

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

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

Optional description

description: undefined | string

A description of the report definition.

displayName

displayName: string

Name of the report definition.

Optional displayOrder

displayOrder: undefined | number

Specifies how the report definitions are ordered in the display. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional freeformTags

freeformTags: undefined | object

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: {@code {\"Department\": \"Finance\"}}

id

id: string

The OCID of the report definition.

Optional isSeeded

isSeeded: undefined | false | true

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

lifecycleState

The current state of the audit report.

Optional schedule

schedule: undefined | string

The schedule to generate the report periodically in the specified format: ;

Allowed version strings - \"v1\" v1's version specific schedule - 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 = (So, the allowed range for is [0, 59]) 2. minutes = (So, the allowed range for is [0, 59]) 3. hours = (So, the allowed range for is [0, 23]) 4. 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. 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

timeCreated

timeCreated: Date

Specifies the time at which the report definition was created.

Optional timeUpdated

timeUpdated: Date

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

Functions

getDeserializedJsonObj

getJsonObj