NewsReportSummary

class oci.opsi.models.NewsReportSummary(**kwargs)

Bases: object

Summary of a news report resource.

Attributes:

DAY_OF_WEEK_FRIDAY

A constant which can be used with the day_of_week property of a NewsReportSummary.

DAY_OF_WEEK_MONDAY

A constant which can be used with the day_of_week property of a NewsReportSummary.

DAY_OF_WEEK_SATURDAY

A constant which can be used with the day_of_week property of a NewsReportSummary.

DAY_OF_WEEK_SUNDAY

A constant which can be used with the day_of_week property of a NewsReportSummary.

DAY_OF_WEEK_THURSDAY

A constant which can be used with the day_of_week property of a NewsReportSummary.

DAY_OF_WEEK_TUESDAY

A constant which can be used with the day_of_week property of a NewsReportSummary.

DAY_OF_WEEK_WEDNESDAY

A constant which can be used with the day_of_week property of a NewsReportSummary.

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a NewsReportSummary.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a NewsReportSummary.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a NewsReportSummary.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a NewsReportSummary.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a NewsReportSummary.

LIFECYCLE_STATE_NEEDS_ATTENTION

A constant which can be used with the lifecycle_state property of a NewsReportSummary.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a NewsReportSummary.

LOCALE_EN

A constant which can be used with the locale property of a NewsReportSummary.

MATCH_RULE_MATCH_ALL

A constant which can be used with the match_rule property of a NewsReportSummary.

MATCH_RULE_MATCH_ANY

A constant which can be used with the match_rule property of a NewsReportSummary.

MATCH_RULE_MATCH_NONE

A constant which can be used with the match_rule property of a NewsReportSummary.

NEWS_FREQUENCY_DAILY

A constant which can be used with the news_frequency property of a NewsReportSummary.

NEWS_FREQUENCY_HOURLY

A constant which can be used with the news_frequency property of a NewsReportSummary.

NEWS_FREQUENCY_WEEKLY

A constant which can be used with the news_frequency property of a NewsReportSummary.

STATUS_DISABLED

A constant which can be used with the status property of a NewsReportSummary.

STATUS_ENABLED

A constant which can be used with the status property of a NewsReportSummary.

STATUS_TERMINATED

A constant which can be used with the status property of a NewsReportSummary.

are_child_compartments_included

Gets the are_child_compartments_included of this NewsReportSummary.

compartment_id

[Required] Gets the compartment_id of this NewsReportSummary.

content_types

[Required] Gets the content_types of this NewsReportSummary.

day_of_week

Gets the day_of_week of this NewsReportSummary.

defined_tags

Gets the defined_tags of this NewsReportSummary.

description

Gets the description of this NewsReportSummary.

freeform_tags

Gets the freeform_tags of this NewsReportSummary.

id

[Required] Gets the id of this NewsReportSummary.

lifecycle_details

Gets the lifecycle_details of this NewsReportSummary.

lifecycle_state

Gets the lifecycle_state of this NewsReportSummary.

locale

Gets the locale of this NewsReportSummary.

match_rule

Gets the match_rule of this NewsReportSummary.

name

Gets the name of this NewsReportSummary.

news_frequency

[Required] Gets the news_frequency of this NewsReportSummary.

ons_topic_id

Gets the ons_topic_id of this NewsReportSummary.

status

Gets the status of this NewsReportSummary.

system_tags

Gets the system_tags of this NewsReportSummary.

tag_filters

Gets the tag_filters of this NewsReportSummary.

time_created

Gets the time_created of this NewsReportSummary.

time_updated

Gets the time_updated of this NewsReportSummary.

Methods:

__init__(**kwargs)

Initializes a new NewsReportSummary 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 NewsReportSummary. 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 NewsReportSummary. 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 NewsReportSummary. 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 NewsReportSummary. 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 NewsReportSummary. 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 NewsReportSummary. 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 NewsReportSummary. This constant has a value of “WEDNESDAY”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a NewsReportSummary. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a NewsReportSummary. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a NewsReportSummary. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a NewsReportSummary. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a NewsReportSummary. This constant has a value of “FAILED”

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'

A constant which can be used with the lifecycle_state property of a NewsReportSummary. This constant has a value of “NEEDS_ATTENTION”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a NewsReportSummary. This constant has a value of “UPDATING”

LOCALE_EN = 'EN'

A constant which can be used with the locale property of a NewsReportSummary. This constant has a value of “EN”

MATCH_RULE_MATCH_ALL = 'MATCH_ALL'

A constant which can be used with the match_rule property of a NewsReportSummary. This constant has a value of “MATCH_ALL”

MATCH_RULE_MATCH_ANY = 'MATCH_ANY'

A constant which can be used with the match_rule property of a NewsReportSummary. This constant has a value of “MATCH_ANY”

MATCH_RULE_MATCH_NONE = 'MATCH_NONE'

A constant which can be used with the match_rule property of a NewsReportSummary. This constant has a value of “MATCH_NONE”

NEWS_FREQUENCY_DAILY = 'DAILY'

A constant which can be used with the news_frequency property of a NewsReportSummary. This constant has a value of “DAILY”

NEWS_FREQUENCY_HOURLY = 'HOURLY'

A constant which can be used with the news_frequency property of a NewsReportSummary. This constant has a value of “HOURLY”

NEWS_FREQUENCY_WEEKLY = 'WEEKLY'

A constant which can be used with the news_frequency property of a NewsReportSummary. This constant has a value of “WEEKLY”

STATUS_DISABLED = 'DISABLED'

A constant which can be used with the status property of a NewsReportSummary. This constant has a value of “DISABLED”

STATUS_ENABLED = 'ENABLED'

A constant which can be used with the status property of a NewsReportSummary. This constant has a value of “ENABLED”

STATUS_TERMINATED = 'TERMINATED'

A constant which can be used with the status property of a NewsReportSummary. This constant has a value of “TERMINATED”

__init__(**kwargs)

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

Parameters
  • news_frequency (str) – The value to assign to the news_frequency property of this NewsReportSummary. Allowed values for this property are: “WEEKLY”, “DAILY”, “HOURLY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • content_types (oci.opsi.models.NewsContentTypes) – The value to assign to the content_types property of this NewsReportSummary.

  • locale (str) – The value to assign to the locale property of this NewsReportSummary. Allowed values for this property are: “EN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • id (str) – The value to assign to the id property of this NewsReportSummary.

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

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

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

  • ons_topic_id (str) – The value to assign to the ons_topic_id property of this NewsReportSummary.

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

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

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

  • status (str) – The value to assign to the status property of this NewsReportSummary. Allowed values for this property are: “DISABLED”, “ENABLED”, “TERMINATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • time_created (datetime) – The value to assign to the time_created property of this NewsReportSummary.

  • time_updated (datetime) – The value to assign to the time_updated property of this NewsReportSummary.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this NewsReportSummary. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this NewsReportSummary.

  • day_of_week (str) – The value to assign to the day_of_week property of this NewsReportSummary. Allowed values for this property are: “MONDAY”, “TUESDAY”, “WEDNESDAY”, “THURSDAY”, “FRIDAY”, “SATURDAY”, “SUNDAY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • are_child_compartments_included (bool) – The value to assign to the are_child_compartments_included property of this NewsReportSummary.

  • tag_filters (list[str]) – The value to assign to the tag_filters property of this NewsReportSummary.

  • match_rule (str) – The value to assign to the match_rule property of this NewsReportSummary. Allowed values for this property are: “MATCH_ANY”, “MATCH_ALL”, “MATCH_NONE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

property are_child_compartments_included

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

Returns

The are_child_compartments_included of this NewsReportSummary.

Return type

bool

property compartment_id

[Required] Gets the compartment_id of this NewsReportSummary. The OCID of the compartment.

Returns

The compartment_id of this NewsReportSummary.

Return type

str

property content_types

[Required] Gets the content_types of this NewsReportSummary.

Returns

The content_types of this NewsReportSummary.

Return type

oci.opsi.models.NewsContentTypes

property day_of_week

Gets the day_of_week of this NewsReportSummary. 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”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The day_of_week of this NewsReportSummary.

Return type

str

property defined_tags

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

Return type

dict(str, dict(str, object))

property description

Gets the description of this NewsReportSummary. The description of the news report.

Returns

The description of this NewsReportSummary.

Return type

str

property freeform_tags

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

Return type

dict(str, str)

property id

[Required] Gets the id of this NewsReportSummary. The OCID of the news report resource.

Returns

The id of this NewsReportSummary.

Return type

str

property lifecycle_details

Gets the lifecycle_details of this NewsReportSummary. A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Returns

The lifecycle_details of this NewsReportSummary.

Return type

str

property lifecycle_state

Gets the lifecycle_state of this NewsReportSummary. The current state of the news report.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_state of this NewsReportSummary.

Return type

str

property locale

Gets the locale of this NewsReportSummary. Language of the news report.

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

Returns

The locale of this NewsReportSummary.

Return type

str

property match_rule

Gets the match_rule of this NewsReportSummary. Match rule used for tag filters.

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

Returns

The match_rule of this NewsReportSummary.

Return type

str

property name

Gets the name of this NewsReportSummary. The news report name.

Returns

The name of this NewsReportSummary.

Return type

str

property news_frequency

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

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

Returns

The news_frequency of this NewsReportSummary.

Return type

str

property ons_topic_id

Gets the ons_topic_id of this NewsReportSummary. The OCID of the ONS topic.

Returns

The ons_topic_id of this NewsReportSummary.

Return type

str

property status

Gets the status of this NewsReportSummary. Indicates the status of a news report in Ops Insights.

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

Returns

The status of this NewsReportSummary.

Return type

str

property system_tags

Gets the system_tags of this NewsReportSummary. System tags for this resource. Each key is predefined and scoped to a namespace. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns

The system_tags of this NewsReportSummary.

Return type

dict(str, dict(str, object))

property tag_filters

Gets the tag_filters of this NewsReportSummary. List of tag filters; each filter composed by a namespace, key, and value. Example for defined tags - ‘<TagNamespace>.<TagKey>=<TagValue>’. Example for freeform tags - ‘<TagKey>=<TagValue>’.

Returns

The tag_filters of this NewsReportSummary.

Return type

list[str]

property time_created

Gets the time_created of this NewsReportSummary. The time the the news report was first enabled. An RFC3339 formatted datetime string.

Returns

The time_created of this NewsReportSummary.

Return type

datetime

property time_updated

Gets the time_updated of this NewsReportSummary. The time the news report was updated. An RFC3339 formatted datetime string.

Returns

The time_updated of this NewsReportSummary.

Return type

datetime