CreateScheduleDetails

class oci.usage_api.models.CreateScheduleDetails(**kwargs)

Bases: object

The saved schedule.

Attributes:

OUTPUT_FILE_FORMAT_CSV

A constant which can be used with the output_file_format property of a CreateScheduleDetails.

OUTPUT_FILE_FORMAT_PDF

A constant which can be used with the output_file_format property of a CreateScheduleDetails.

compartment_id

[Required] Gets the compartment_id of this CreateScheduleDetails.

defined_tags

Gets the defined_tags of this CreateScheduleDetails.

description

Gets the description of this CreateScheduleDetails.

freeform_tags

Gets the freeform_tags of this CreateScheduleDetails.

name

[Required] Gets the name of this CreateScheduleDetails.

output_file_format

Gets the output_file_format of this CreateScheduleDetails.

query_properties

Gets the query_properties of this CreateScheduleDetails.

result_location

[Required] Gets the result_location of this CreateScheduleDetails.

saved_report_id

Gets the saved_report_id of this CreateScheduleDetails.

schedule_recurrences

[Required] Gets the schedule_recurrences of this CreateScheduleDetails.

time_scheduled

[Required] Gets the time_scheduled of this CreateScheduleDetails.

Methods:

__init__(**kwargs)

Initializes a new CreateScheduleDetails object with values from keyword arguments.

OUTPUT_FILE_FORMAT_CSV = 'CSV'

A constant which can be used with the output_file_format property of a CreateScheduleDetails. 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 CreateScheduleDetails. This constant has a value of “PDF”

__init__(**kwargs)

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

Parameters
  • name (str) – The value to assign to the name property of this CreateScheduleDetails.

  • compartment_id (str) – The value to assign to the compartment_id property of this CreateScheduleDetails.

  • description (str) – The value to assign to the description property of this CreateScheduleDetails.

  • output_file_format (str) – The value to assign to the output_file_format property of this CreateScheduleDetails. Allowed values for this property are: “CSV”, “PDF”

  • saved_report_id (str) – The value to assign to the saved_report_id property of this CreateScheduleDetails.

  • result_location (oci.usage_api.models.ResultLocation) – The value to assign to the result_location property of this CreateScheduleDetails.

  • schedule_recurrences (str) – The value to assign to the schedule_recurrences property of this CreateScheduleDetails.

  • time_scheduled (datetime) – The value to assign to the time_scheduled property of this CreateScheduleDetails.

  • query_properties (oci.usage_api.models.QueryProperties) – The value to assign to the query_properties property of this CreateScheduleDetails.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateScheduleDetails.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateScheduleDetails.

property compartment_id

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

Returns

The compartment_id of this CreateScheduleDetails.

Return type

str

property defined_tags

Gets the defined_tags of this CreateScheduleDetails. 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 CreateScheduleDetails.

Return type

dict(str, dict(str, object))

property description

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

Returns

The description of this CreateScheduleDetails.

Return type

str

property freeform_tags

Gets the freeform_tags of this CreateScheduleDetails. 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 CreateScheduleDetails.

Return type

dict(str, str)

property name

[Required] Gets the name of this CreateScheduleDetails. The unique name of the user-created schedule.

Returns

The name of this CreateScheduleDetails.

Return type

str

property output_file_format

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

Allowed values for this property are: “CSV”, “PDF”

Returns

The output_file_format of this CreateScheduleDetails.

Return type

str

property query_properties

Gets the query_properties of this CreateScheduleDetails.

Returns

The query_properties of this CreateScheduleDetails.

Return type

oci.usage_api.models.QueryProperties

property result_location

[Required] Gets the result_location of this CreateScheduleDetails.

Returns

The result_location of this CreateScheduleDetails.

Return type

oci.usage_api.models.ResultLocation

property saved_report_id

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

Returns

The saved_report_id of this CreateScheduleDetails.

Return type

str

property schedule_recurrences

[Required] Gets the schedule_recurrences of this CreateScheduleDetails. 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 CreateScheduleDetails.

Return type

str

property time_scheduled

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

Returns

The time_scheduled of this CreateScheduleDetails.

Return type

datetime