Schedule¶

class oci.usage_api.models.Schedule(**kwargs)¶

Bases: object

The schedule.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a Schedule.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a Schedule.
`OUTPUT_FILE_FORMAT_CSV`	A constant which can be used with the output_file_format property of a Schedule.
`OUTPUT_FILE_FORMAT_PDF`	A constant which can be used with the output_file_format property of a Schedule.
`compartment_id`	[Required] Gets the compartment_id of this Schedule.
`defined_tags`	Gets the defined_tags of this Schedule.
`description`	Gets the description of this Schedule.
`freeform_tags`	Gets the freeform_tags of this Schedule.
`id`	[Required] Gets the id of this Schedule.
`lifecycle_state`	[Required] Gets the lifecycle_state of this Schedule.
`name`	[Required] Gets the name of this Schedule.
`output_file_format`	Gets the output_file_format of this Schedule.
`query_properties`	Gets the query_properties of this Schedule.
`result_location`	[Required] Gets the result_location of this Schedule.
`saved_report_id`	Gets the saved_report_id of this Schedule.
`schedule_recurrences`	[Required] Gets the schedule_recurrences of this Schedule.
`system_tags`	Gets the system_tags of this Schedule.
`time_created`	[Required] Gets the time_created of this Schedule.
`time_next_run`	Gets the time_next_run of this Schedule.
`time_scheduled`	[Required] Gets the time_scheduled of this Schedule.

Methods

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a Schedule. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a Schedule. This constant has a value of “INACTIVE”

OUTPUT_FILE_FORMAT_CSV = 'CSV'¶: A constant which can be used with the output_file_format property of a Schedule. This constant has a value of “CSV”

OUTPUT_FILE_FORMAT_PDF = 'PDF'¶: A constant which can be used with the output_file_format property of a Schedule. This constant has a value of “PDF”

__init__(**kwargs)¶

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

Parameters:

id (str) – The value to assign to the id property of this Schedule.
name (str) – The value to assign to the name property of this Schedule.
compartment_id (str) – The value to assign to the compartment_id property of this Schedule.
result_location (oci.usage_api.models.ResultLocation) – The value to assign to the result_location property of this Schedule.
description (str) – The value to assign to the description property of this Schedule.
time_next_run (datetime) – The value to assign to the time_next_run property of this Schedule.
output_file_format (str) – The value to assign to the output_file_format property of this Schedule. Allowed values for this property are: “CSV”, “PDF”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
saved_report_id (str) – The value to assign to the saved_report_id property of this Schedule.
schedule_recurrences (str) – The value to assign to the schedule_recurrences property of this Schedule.
time_scheduled (datetime) – The value to assign to the time_scheduled property of this Schedule.
query_properties (oci.usage_api.models.QueryProperties) – The value to assign to the query_properties property of this Schedule.
time_created (datetime) – The value to assign to the time_created property of this Schedule.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Schedule. Allowed values for this property are: “ACTIVE”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Schedule.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Schedule.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Schedule.

compartment_id¶

[Required] Gets the compartment_id of this Schedule. The customer tenancy.

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

defined_tags¶

Gets the defined_tags of this Schedule. Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this Schedule.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this Schedule. The description of the schedule.

Returns:	The description of this Schedule.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this Schedule. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this Schedule.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this Schedule. The OCID representing a unique shedule.

Returns:	The id of this Schedule.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this Schedule. The schedule lifecycle state.

Allowed values for this property are: “ACTIVE”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this Schedule.
Return type:	str

name¶

[Required] Gets the name of this Schedule. The unique name of the schedule created by the user.

Returns:	The name of this Schedule.
Return type:	str

output_file_format¶

Gets the output_file_format of this Schedule. Specifies the supported output file format.

Allowed values for this property are: “CSV”, “PDF”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The output_file_format of this Schedule.
Return type:	str

query_properties¶

Gets the query_properties of this Schedule.

Returns:	The query_properties of this Schedule.
Return type:	oci.usage_api.models.QueryProperties

result_location¶

[Required] Gets the result_location of this Schedule.

Returns:	The result_location of this Schedule.
Return type:	oci.usage_api.models.ResultLocation

saved_report_id¶

Gets the saved_report_id of this Schedule. The saved report ID which can also be used to generate a query.

Returns:	The saved_report_id of this Schedule.
Return type:	str

schedule_recurrences¶

[Required] Gets the schedule_recurrences of this Schedule. Specifies the frequency according to when the schedule will be run, in the x-obmcs-recurring-time format described in RFC 5545 section 3.3.10. Supported values are : ONE_TIME, DAILY, WEEKLY and MONTHLY.

Returns:	The schedule_recurrences of this Schedule.
Return type:	str

system_tags¶

Gets the system_tags of this Schedule. Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this Schedule.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this Schedule. The date and time the schedule was created.

Returns:	The time_created of this Schedule.
Return type:	datetime

time_next_run¶

Gets the time_next_run of this Schedule. The date and time of the next job execution.

Returns:	The time_next_run of this Schedule.
Return type:	datetime

time_scheduled¶

[Required] Gets the time_scheduled of this Schedule. The date and time of the first time job execution.

Returns:	The time_scheduled of this Schedule.
Return type:	datetime