CreateReportDefinitionDetails

class oci.data_safe.models.CreateReportDefinitionDetails(**kwargs)

Bases: object

Description of a new report definition.

Methods

__init__(**kwargs) Initializes a new CreateReportDefinitionDetails object with values from keyword arguments.

Attributes

column_filters [Required] Gets the column_filters of this CreateReportDefinitionDetails.
column_info [Required] Gets the column_info of this CreateReportDefinitionDetails.
column_sortings [Required] Gets the column_sortings of this CreateReportDefinitionDetails.
compartment_id [Required] Gets the compartment_id of this CreateReportDefinitionDetails.
defined_tags Gets the defined_tags of this CreateReportDefinitionDetails.
description Gets the description of this CreateReportDefinitionDetails.
display_name [Required] Gets the display_name of this CreateReportDefinitionDetails.
freeform_tags Gets the freeform_tags of this CreateReportDefinitionDetails.
parent_id [Required] Gets the parent_id of this CreateReportDefinitionDetails.
summary [Required] Gets the summary of this CreateReportDefinitionDetails.
__init__(**kwargs)

Initializes a new CreateReportDefinitionDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • compartment_id (str) – The value to assign to the compartment_id property of this CreateReportDefinitionDetails.
  • display_name (str) – The value to assign to the display_name property of this CreateReportDefinitionDetails.
  • parent_id (str) – The value to assign to the parent_id property of this CreateReportDefinitionDetails.
  • description (str) – The value to assign to the description property of this CreateReportDefinitionDetails.
  • column_info (list[oci.data_safe.models.Column]) – The value to assign to the column_info property of this CreateReportDefinitionDetails.
  • column_filters (list[oci.data_safe.models.ColumnFilter]) – The value to assign to the column_filters property of this CreateReportDefinitionDetails.
  • column_sortings (list[oci.data_safe.models.ColumnSorting]) – The value to assign to the column_sortings property of this CreateReportDefinitionDetails.
  • summary (list[oci.data_safe.models.Summary]) – The value to assign to the summary property of this CreateReportDefinitionDetails.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateReportDefinitionDetails.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateReportDefinitionDetails.
column_filters

[Required] Gets the column_filters of this CreateReportDefinitionDetails. An array of column filter objects. A column Filter 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:The column_filters of this CreateReportDefinitionDetails.
Return type:list[oci.data_safe.models.ColumnFilter]
column_info

[Required] Gets the column_info of this CreateReportDefinitionDetails. 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:The column_info of this CreateReportDefinitionDetails.
Return type:list[oci.data_safe.models.Column]
column_sortings

[Required] Gets the column_sortings of this CreateReportDefinitionDetails. 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:The column_sortings of this CreateReportDefinitionDetails.
Return type:list[oci.data_safe.models.ColumnSorting]
compartment_id

[Required] Gets the compartment_id of this CreateReportDefinitionDetails. The OCID of the compartment containing the report definition.

Returns:The compartment_id of this CreateReportDefinitionDetails.
Return type:str
defined_tags

Gets the defined_tags of this CreateReportDefinitionDetails. 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:The defined_tags of this CreateReportDefinitionDetails.
Return type:dict(str, dict(str, object))
description

Gets the description of this CreateReportDefinitionDetails. A description of the report definition.

Returns:The description of this CreateReportDefinitionDetails.
Return type:str
display_name

[Required] Gets the display_name of this CreateReportDefinitionDetails. Specifies the name of the report definition.

Returns:The display_name of this CreateReportDefinitionDetails.
Return type:str
freeform_tags

Gets the freeform_tags of this CreateReportDefinitionDetails. 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:The freeform_tags of this CreateReportDefinitionDetails.
Return type:dict(str, str)
parent_id

[Required] Gets the parent_id of this CreateReportDefinitionDetails. The OCID of the parent report definition.

Returns:The parent_id of this CreateReportDefinitionDetails.
Return type:str
summary

[Required] Gets the summary of this CreateReportDefinitionDetails. 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:The summary of this CreateReportDefinitionDetails.
Return type:list[oci.data_safe.models.Summary]