ScheduleReportDetails¶

class oci.data_safe.models.ScheduleReportDetails(**kwargs)¶

Bases: object

The details of the report schedule.

Attributes

`MIME_TYPE_JSON`	A constant which can be used with the mime_type property of a ScheduleReportDetails.
`MIME_TYPE_PDF`	A constant which can be used with the mime_type property of a ScheduleReportDetails.
`MIME_TYPE_XLS`	A constant which can be used with the mime_type property of a ScheduleReportDetails.
`compartment_id`	[Required] Gets the compartment_id of this ScheduleReportDetails.
`display_name`	Gets the display_name of this ScheduleReportDetails.
`mime_type`	[Required] Gets the mime_type of this ScheduleReportDetails.
`report_details`	[Required] Gets the report_details of this ScheduleReportDetails.
`schedule`	[Required] Gets the schedule of this ScheduleReportDetails.

Methods

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

MIME_TYPE_JSON = 'JSON'¶: A constant which can be used with the mime_type property of a ScheduleReportDetails. This constant has a value of “JSON”

MIME_TYPE_PDF = 'PDF'¶: A constant which can be used with the mime_type property of a ScheduleReportDetails. This constant has a value of “PDF”

MIME_TYPE_XLS = 'XLS'¶: A constant which can be used with the mime_type property of a ScheduleReportDetails. This constant has a value of “XLS”

__init__(**kwargs)¶

Initializes a new ScheduleReportDetails 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 ScheduleReportDetails.
schedule (str) – The value to assign to the schedule property of this ScheduleReportDetails.
mime_type (str) – The value to assign to the mime_type property of this ScheduleReportDetails. Allowed values for this property are: “PDF”, “XLS”, “JSON”
compartment_id (str) – The value to assign to the compartment_id property of this ScheduleReportDetails.
report_details (oci.data_safe.models.ReportDetails) – The value to assign to the report_details property of this ScheduleReportDetails.

compartment_id¶

[Required] Gets the compartment_id of this ScheduleReportDetails. The OCID of the compartment in which the resource should be created.

Returns:	The compartment_id of this ScheduleReportDetails.
Return type:	str

display_name¶

Gets the display_name of this ScheduleReportDetails. The name of the report to be scheduled

Returns:	The display_name of this ScheduleReportDetails.
Return type:	str

mime_type¶

[Required] Gets the mime_type of this ScheduleReportDetails. Specifies if the report will be in .xls or .pdf or .json format

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

Returns:	The mime_type of this ScheduleReportDetails.
Return type:	str

report_details¶

[Required] Gets the report_details of this ScheduleReportDetails.

Returns:	The report_details of this ScheduleReportDetails.
Return type:	oci.data_safe.models.ReportDetails

schedule¶

[Required] Gets the schedule of this ScheduleReportDetails. 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:	The schedule of this ScheduleReportDetails.
Return type:	str