GenerateReportDetails

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

Bases: object

Details for the report generation.

Attributes

MIME_TYPE_JSON A constant which can be used with the mime_type property of a GenerateReportDetails.
MIME_TYPE_PDF A constant which can be used with the mime_type property of a GenerateReportDetails.
MIME_TYPE_XLS A constant which can be used with the mime_type property of a GenerateReportDetails.
compartment_id [Required] Gets the compartment_id of this GenerateReportDetails.
description Gets the description of this GenerateReportDetails.
display_name [Required] Gets the display_name of this GenerateReportDetails.
mime_type [Required] Gets the mime_type of this GenerateReportDetails.
row_limit Gets the row_limit of this GenerateReportDetails.
target_ids Gets the target_ids of this GenerateReportDetails.
time_greater_than Gets the time_greater_than of this GenerateReportDetails.
time_less_than Gets the time_less_than of this GenerateReportDetails.

Methods

__init__(**kwargs) Initializes a new GenerateReportDetails object with values from keyword arguments.
MIME_TYPE_JSON = 'JSON'

A constant which can be used with the mime_type property of a GenerateReportDetails. This constant has a value of “JSON”

MIME_TYPE_PDF = 'PDF'

A constant which can be used with the mime_type property of a GenerateReportDetails. This constant has a value of “PDF”

MIME_TYPE_XLS = 'XLS'

A constant which can be used with the mime_type property of a GenerateReportDetails. This constant has a value of “XLS”

__init__(**kwargs)

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

Parameters:
  • display_name (str) – The value to assign to the display_name property of this GenerateReportDetails.
  • target_ids (list[str]) – The value to assign to the target_ids property of this GenerateReportDetails.
  • description (str) – The value to assign to the description property of this GenerateReportDetails.
  • compartment_id (str) – The value to assign to the compartment_id property of this GenerateReportDetails.
  • mime_type (str) – The value to assign to the mime_type property of this GenerateReportDetails. Allowed values for this property are: “PDF”, “XLS”, “JSON”
  • time_less_than (datetime) – The value to assign to the time_less_than property of this GenerateReportDetails.
  • time_greater_than (datetime) – The value to assign to the time_greater_than property of this GenerateReportDetails.
  • row_limit (int) – The value to assign to the row_limit property of this GenerateReportDetails.
compartment_id

[Required] Gets the compartment_id of this GenerateReportDetails. The OCID of the compartment into which the resource should be moved.

Returns:The compartment_id of this GenerateReportDetails.
Return type:str
description

Gets the description of this GenerateReportDetails. The description of the report to be generated

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

[Required] Gets the display_name of this GenerateReportDetails. The name of the report to be generated

Returns:The display_name of this GenerateReportDetails.
Return type:str
mime_type

[Required] Gets the mime_type of this GenerateReportDetails. Specifies the format of report to be .xls or .pdf or .json

Allowed values for this property are: “PDF”, “XLS”, “JSON”

Returns:The mime_type of this GenerateReportDetails.
Return type:str
row_limit

Gets the row_limit of this GenerateReportDetails. Specifies the limit on the number of rows in the report.

Returns:The row_limit of this GenerateReportDetails.
Return type:int
target_ids

Gets the target_ids of this GenerateReportDetails. Array of database target OCIDs.

Returns:The target_ids of this GenerateReportDetails.
Return type:list[str]
time_greater_than

Gets the time_greater_than of this GenerateReportDetails. Specifies the time after which the data needs to be reported.

Returns:The time_greater_than of this GenerateReportDetails.
Return type:datetime
time_less_than

Gets the time_less_than of this GenerateReportDetails. Specifies the time until which the data needs to be reported.

Returns:The time_less_than of this GenerateReportDetails.
Return type:datetime