EmailRecipientsGroup¶

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

Bases: object

The recipients group to receive usage statement email.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a EmailRecipientsGroup.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a EmailRecipientsGroup.
`compartment_id`	[Required] Gets the compartment_id of this EmailRecipientsGroup.
`id`	[Required] Gets the id of this EmailRecipientsGroup.
`lifecycle_state`	[Required] Gets the lifecycle_state of this EmailRecipientsGroup.
`recipients_list`	[Required] Gets the recipients_list of this EmailRecipientsGroup.

Methods

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

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

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

__init__(**kwargs)¶

Initializes a new EmailRecipientsGroup 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 EmailRecipientsGroup.
compartment_id (str) – The value to assign to the compartment_id property of this EmailRecipientsGroup.
recipients_list (list[oci.usage_api.models.EmailRecipient]) – The value to assign to the recipients_list property of this EmailRecipientsGroup.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this EmailRecipientsGroup. 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’.

compartment_id¶

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

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

id¶

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

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this EmailRecipientsGroup. The email recipient group 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 EmailRecipientsGroup.
Return type:	str

recipients_list¶

[Required] Gets the recipients_list of this EmailRecipientsGroup. The list of recipient will receive the usage statement email.

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