CreateNewsReportDetails¶

class oci.opsi.models.CreateNewsReportDetails(**kwargs)¶

Bases: object

The information about the news report to be created.

Attributes

`DAY_OF_WEEK_FRIDAY`	A constant which can be used with the day_of_week property of a CreateNewsReportDetails.
`DAY_OF_WEEK_MONDAY`	A constant which can be used with the day_of_week property of a CreateNewsReportDetails.
`DAY_OF_WEEK_SATURDAY`	A constant which can be used with the day_of_week property of a CreateNewsReportDetails.
`DAY_OF_WEEK_SUNDAY`	A constant which can be used with the day_of_week property of a CreateNewsReportDetails.
`DAY_OF_WEEK_THURSDAY`	A constant which can be used with the day_of_week property of a CreateNewsReportDetails.
`DAY_OF_WEEK_TUESDAY`	A constant which can be used with the day_of_week property of a CreateNewsReportDetails.
`DAY_OF_WEEK_WEDNESDAY`	A constant which can be used with the day_of_week property of a CreateNewsReportDetails.
`LOCALE_EN`	A constant which can be used with the locale property of a CreateNewsReportDetails.
`NEWS_FREQUENCY_WEEKLY`	A constant which can be used with the news_frequency property of a CreateNewsReportDetails.
`STATUS_DISABLED`	A constant which can be used with the status property of a CreateNewsReportDetails.
`STATUS_ENABLED`	A constant which can be used with the status property of a CreateNewsReportDetails.
`STATUS_TERMINATED`	A constant which can be used with the status property of a CreateNewsReportDetails.
`are_child_compartments_included`	Gets the are_child_compartments_included of this CreateNewsReportDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateNewsReportDetails.
`content_types`	[Required] Gets the content_types of this CreateNewsReportDetails.
`day_of_week`	Gets the day_of_week of this CreateNewsReportDetails.
`defined_tags`	Gets the defined_tags of this CreateNewsReportDetails.
`description`	[Required] Gets the description of this CreateNewsReportDetails.
`freeform_tags`	Gets the freeform_tags of this CreateNewsReportDetails.
`locale`	[Required] Gets the locale of this CreateNewsReportDetails.
`name`	[Required] Gets the name of this CreateNewsReportDetails.
`news_frequency`	[Required] Gets the news_frequency of this CreateNewsReportDetails.
`ons_topic_id`	[Required] Gets the ons_topic_id of this CreateNewsReportDetails.
`status`	Gets the status of this CreateNewsReportDetails.

Methods

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

DAY_OF_WEEK_FRIDAY = 'FRIDAY'¶: A constant which can be used with the day_of_week property of a CreateNewsReportDetails. This constant has a value of “FRIDAY”

DAY_OF_WEEK_MONDAY = 'MONDAY'¶: A constant which can be used with the day_of_week property of a CreateNewsReportDetails. This constant has a value of “MONDAY”

DAY_OF_WEEK_SATURDAY = 'SATURDAY'¶: A constant which can be used with the day_of_week property of a CreateNewsReportDetails. This constant has a value of “SATURDAY”

DAY_OF_WEEK_SUNDAY = 'SUNDAY'¶: A constant which can be used with the day_of_week property of a CreateNewsReportDetails. This constant has a value of “SUNDAY”

DAY_OF_WEEK_THURSDAY = 'THURSDAY'¶: A constant which can be used with the day_of_week property of a CreateNewsReportDetails. This constant has a value of “THURSDAY”

DAY_OF_WEEK_TUESDAY = 'TUESDAY'¶: A constant which can be used with the day_of_week property of a CreateNewsReportDetails. This constant has a value of “TUESDAY”

DAY_OF_WEEK_WEDNESDAY = 'WEDNESDAY'¶: A constant which can be used with the day_of_week property of a CreateNewsReportDetails. This constant has a value of “WEDNESDAY”

LOCALE_EN = 'EN'¶: A constant which can be used with the locale property of a CreateNewsReportDetails. This constant has a value of “EN”

NEWS_FREQUENCY_WEEKLY = 'WEEKLY'¶: A constant which can be used with the news_frequency property of a CreateNewsReportDetails. This constant has a value of “WEEKLY”

STATUS_DISABLED = 'DISABLED'¶: A constant which can be used with the status property of a CreateNewsReportDetails. This constant has a value of “DISABLED”

STATUS_ENABLED = 'ENABLED'¶: A constant which can be used with the status property of a CreateNewsReportDetails. This constant has a value of “ENABLED”

STATUS_TERMINATED = 'TERMINATED'¶: A constant which can be used with the status property of a CreateNewsReportDetails. This constant has a value of “TERMINATED”

__init__(**kwargs)¶

Initializes a new CreateNewsReportDetails 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 CreateNewsReportDetails.
news_frequency (str) – The value to assign to the news_frequency property of this CreateNewsReportDetails. Allowed values for this property are: “WEEKLY”
description (str) – The value to assign to the description property of this CreateNewsReportDetails.
ons_topic_id (str) – The value to assign to the ons_topic_id property of this CreateNewsReportDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateNewsReportDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateNewsReportDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateNewsReportDetails.
content_types (oci.opsi.models.NewsContentTypes) – The value to assign to the content_types property of this CreateNewsReportDetails.
locale (str) – The value to assign to the locale property of this CreateNewsReportDetails. Allowed values for this property are: “EN”
status (str) – The value to assign to the status property of this CreateNewsReportDetails. Allowed values for this property are: “DISABLED”, “ENABLED”, “TERMINATED”
day_of_week (str) – The value to assign to the day_of_week property of this CreateNewsReportDetails. Allowed values for this property are: “MONDAY”, “TUESDAY”, “WEDNESDAY”, “THURSDAY”, “FRIDAY”, “SATURDAY”, “SUNDAY”
are_child_compartments_included (bool) – The value to assign to the are_child_compartments_included property of this CreateNewsReportDetails.

are_child_compartments_included¶

Gets the are_child_compartments_included of this CreateNewsReportDetails. A flag to consider the resources within a given compartment and all sub-compartments.

Returns:	The are_child_compartments_included of this CreateNewsReportDetails.
Return type:	bool

compartment_id¶

[Required] Gets the compartment_id of this CreateNewsReportDetails. Compartment Identifier where the news report will be created.

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

content_types¶

[Required] Gets the content_types of this CreateNewsReportDetails.

Returns:	The content_types of this CreateNewsReportDetails.
Return type:	oci.opsi.models.NewsContentTypes

day_of_week¶

Gets the day_of_week of this CreateNewsReportDetails. Day of the week in which the news report will be sent if the frequency is set to WEEKLY.

Allowed values for this property are: “MONDAY”, “TUESDAY”, “WEDNESDAY”, “THURSDAY”, “FRIDAY”, “SATURDAY”, “SUNDAY”

Returns:	The day_of_week of this CreateNewsReportDetails.
Return type:	str

defined_tags¶

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

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

description¶

[Required] Gets the description of this CreateNewsReportDetails. The description of the news report.

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

freeform_tags¶

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

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

locale¶

[Required] Gets the locale of this CreateNewsReportDetails. Language of the news report.

Allowed values for this property are: “EN”

Returns:	The locale of this CreateNewsReportDetails.
Return type:	str

name¶

[Required] Gets the name of this CreateNewsReportDetails. The news report name.

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

news_frequency¶

[Required] Gets the news_frequency of this CreateNewsReportDetails. News report frequency.

Allowed values for this property are: “WEEKLY”

Returns:	The news_frequency of this CreateNewsReportDetails.
Return type:	str

ons_topic_id¶

[Required] Gets the ons_topic_id of this CreateNewsReportDetails. The OCID of the ONS topic.

Returns:	The ons_topic_id of this CreateNewsReportDetails.
Return type:	str

status¶

Gets the status of this CreateNewsReportDetails. Defines if the news report will be enabled or disabled.

Allowed values for this property are: “DISABLED”, “ENABLED”, “TERMINATED”

Returns:	The status of this CreateNewsReportDetails.
Return type:	str