EmailRecipientsGroupSummary¶

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

Bases: object

The email recipients group summary for the recipients group list.

Methods

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

Attributes

`compartment_id`	[Required] Gets the compartment_id of this EmailRecipientsGroupSummary.
`defined_tags`	Gets the defined_tags of this EmailRecipientsGroupSummary.
`freeform_tags`	Gets the freeform_tags of this EmailRecipientsGroupSummary.
`id`	[Required] Gets the id of this EmailRecipientsGroupSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this EmailRecipientsGroupSummary.
`recipients_list`	[Required] Gets the recipients_list of this EmailRecipientsGroupSummary.
`system_tags`	Gets the system_tags of this EmailRecipientsGroupSummary.

__init__(**kwargs)¶

Initializes a new EmailRecipientsGroupSummary 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 EmailRecipientsGroupSummary.
compartment_id (str) – The value to assign to the compartment_id property of this EmailRecipientsGroupSummary.
recipients_list (list[oci.usage_api.models.EmailRecipient]) – The value to assign to the recipients_list property of this EmailRecipientsGroupSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this EmailRecipientsGroupSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this EmailRecipientsGroupSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this EmailRecipientsGroupSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this EmailRecipientsGroupSummary.

compartment_id¶

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

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

defined_tags¶

Gets the defined_tags of this EmailRecipientsGroupSummary. 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 EmailRecipientsGroupSummary.
Return type:	dict(str, dict(str, object))

freeform_tags¶

Gets the freeform_tags of this EmailRecipientsGroupSummary. 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 EmailRecipientsGroupSummary.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this EmailRecipientsGroupSummary. The usage statement email recipients group OCID.

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this EmailRecipientsGroupSummary. The email recipients group lifecycle state.

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

recipients_list¶

[Required] Gets the recipients_list of this EmailRecipientsGroupSummary. The list of recipients that will receive usage statement emails.

Returns:	The recipients_list of this EmailRecipientsGroupSummary.
Return type:	list[oci.usage_api.models.EmailRecipient]

system_tags¶

Gets the system_tags of this EmailRecipientsGroupSummary. 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 EmailRecipientsGroupSummary.
Return type:	dict(str, dict(str, object))