Class ReportDefinition

Description of report definition.

Inheritance

object

ReportDefinition

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DatasafeService.Models

Assembly: OCI.DotNetSDK.Datasafe.dll

Syntax

public class ReportDefinition

Properties

Category

Declaration

[JsonProperty(PropertyName = "category")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ReportDefinition.CategoryEnum? Category { get; set; }

Property Value

Type	Description
ReportDefinition.CategoryEnum?	Specifies the name of the category that this report belongs to.

ColumnFilters

Declaration

[JsonProperty(PropertyName = "columnFilters")]
public List<ColumnFilter> ColumnFilters { get; set; }

Property Value

Type	Description
List<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.

ColumnInfo

Declaration

[JsonProperty(PropertyName = "columnInfo")]
public List<Column> ColumnInfo { get; set; }

Property Value

Type	Description
List<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).

ColumnSortings

Declaration

[JsonProperty(PropertyName = "columnSortings")]
public List<ColumnSorting> ColumnSortings { get; set; }

Property Value

Type	Description
List<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.

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment containing the report definition.

Remarks

Required

ComplianceStandards

Declaration

[JsonProperty(PropertyName = "complianceStandards")]
public List<string> ComplianceStandards { get; set; }

Property Value

Type	Description
List<string>	The list of the data protection regulations/standards used in the report that will help demonstrate compliance.

DataSource

Declaration

[JsonProperty(PropertyName = "dataSource")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ReportDefinitionDataSource? DataSource { get; set; }

Property Value

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

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<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"}}

Description

Declaration

[JsonProperty(PropertyName = "description")]
public string Description { get; set; }

Property Value

Type	Description
string	A description of the report definition.

DisplayName

Declaration

[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	Name of the report definition.

Remarks

Required

DisplayOrder

Declaration

[JsonProperty(PropertyName = "displayOrder")]
public int? DisplayOrder { get; set; }

Property Value

Type	Description
int?	Specifies how the report definitions are ordered in the display.

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<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"}

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the report definition.

Remarks

Required

IsSeeded

Declaration

[JsonProperty(PropertyName = "isSeeded")]
public bool? IsSeeded { get; set; }

Property Value

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

LifecycleDetails

Declaration

[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }

Property Value

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

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ReportDefinitionLifecycleState? LifecycleState { get; set; }

Property Value

Type	Description
ReportDefinitionLifecycleState?	The current state of the report.

Remarks

Required

ParentId

Declaration

[JsonProperty(PropertyName = "parentId")]
public string ParentId { get; set; }

Property Value

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

RecordTimeSpan

Declaration

[JsonProperty(PropertyName = "recordTimeSpan")]
public string RecordTimeSpan { get; set; }

Property Value

Type	Description
string

Schedule

Declaration

[JsonProperty(PropertyName = "schedule")]
public string Schedule { get; set; }

Property Value

Type	Description
string

ScheduledReportCompartmentId

Declaration

[JsonProperty(PropertyName = "scheduledReportCompartmentId")]
public string ScheduledReportCompartmentId { get; set; }

Property Value

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

ScheduledReportMimeType

Declaration

[JsonProperty(PropertyName = "scheduledReportMimeType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ReportDefinition.ScheduledReportMimeTypeEnum? ScheduledReportMimeType { get; set; }

Property Value

Type	Description
ReportDefinition.ScheduledReportMimeTypeEnum?	Specifies the format of the report ( either .xls or .pdf or .json)

ScheduledReportName

Declaration

[JsonProperty(PropertyName = "scheduledReportName")]
public string ScheduledReportName { get; set; }

Property Value

Type	Description
string	The name of the report to be scheduled.

ScheduledReportRowLimit

Declaration

[JsonProperty(PropertyName = "scheduledReportRowLimit")]
public int? ScheduledReportRowLimit { get; set; }

Property Value

Type	Description
int?	Specifies the limit on the number of rows in the report.

ScimFilter

Declaration

[JsonProperty(PropertyName = "scimFilter")]
public string ScimFilter { get; set; }

Property Value

Type	Description
string	Additional SCIM filters used to define the report.

Summary

Declaration

[JsonProperty(PropertyName = "summary")]
public List<Summary> Summary { get; set; }

Property Value

Type	Description
List<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).

SystemTags

Declaration

[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<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"}}

TimeCreated

Declaration

[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	Specifies the date and time the report definition was created.

TimeUpdated

Declaration

[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the report definition was updated.