RecipientInvitation¶
-
class
oci.tenant_manager_control_plane.models.
RecipientInvitation
(**kwargs)¶ Bases:
object
The invitation model that the recipient owns.
Attributes
LIFECYCLE_STATE_ACTIVE
A constant which can be used with the lifecycle_state property of a RecipientInvitation. LIFECYCLE_STATE_CREATING
A constant which can be used with the lifecycle_state property of a RecipientInvitation. LIFECYCLE_STATE_FAILED
A constant which can be used with the lifecycle_state property of a RecipientInvitation. LIFECYCLE_STATE_INACTIVE
A constant which can be used with the lifecycle_state property of a RecipientInvitation. LIFECYCLE_STATE_TERMINATED
A constant which can be used with the lifecycle_state property of a RecipientInvitation. LIFECYCLE_STATE_UPDATING
A constant which can be used with the lifecycle_state property of a RecipientInvitation. STATUS_ACCEPTED
A constant which can be used with the status property of a RecipientInvitation. STATUS_CANCELED
A constant which can be used with the status property of a RecipientInvitation. STATUS_EXPIRED
A constant which can be used with the status property of a RecipientInvitation. STATUS_FAILED
A constant which can be used with the status property of a RecipientInvitation. STATUS_IGNORED
A constant which can be used with the status property of a RecipientInvitation. STATUS_PENDING
A constant which can be used with the status property of a RecipientInvitation. compartment_id
[Required] Gets the compartment_id of this RecipientInvitation. defined_tags
Gets the defined_tags of this RecipientInvitation. display_name
Gets the display_name of this RecipientInvitation. freeform_tags
Gets the freeform_tags of this RecipientInvitation. id
[Required] Gets the id of this RecipientInvitation. lifecycle_state
[Required] Gets the lifecycle_state of this RecipientInvitation. recipient_email_address
Gets the recipient_email_address of this RecipientInvitation. sender_invitation_id
[Required] Gets the sender_invitation_id of this RecipientInvitation. sender_tenancy_id
[Required] Gets the sender_tenancy_id of this RecipientInvitation. status
[Required] Gets the status of this RecipientInvitation. subjects
[Required] Gets the subjects of this RecipientInvitation. system_tags
Gets the system_tags of this RecipientInvitation. time_created
[Required] Gets the time_created of this RecipientInvitation. time_updated
Gets the time_updated of this RecipientInvitation. Methods
__init__
(**kwargs)Initializes a new RecipientInvitation object with values from keyword arguments. -
LIFECYCLE_STATE_ACTIVE
= 'ACTIVE'¶ A constant which can be used with the lifecycle_state property of a RecipientInvitation. This constant has a value of “ACTIVE”
-
LIFECYCLE_STATE_CREATING
= 'CREATING'¶ A constant which can be used with the lifecycle_state property of a RecipientInvitation. This constant has a value of “CREATING”
-
LIFECYCLE_STATE_FAILED
= 'FAILED'¶ A constant which can be used with the lifecycle_state property of a RecipientInvitation. This constant has a value of “FAILED”
-
LIFECYCLE_STATE_INACTIVE
= 'INACTIVE'¶ A constant which can be used with the lifecycle_state property of a RecipientInvitation. This constant has a value of “INACTIVE”
-
LIFECYCLE_STATE_TERMINATED
= 'TERMINATED'¶ A constant which can be used with the lifecycle_state property of a RecipientInvitation. This constant has a value of “TERMINATED”
-
LIFECYCLE_STATE_UPDATING
= 'UPDATING'¶ A constant which can be used with the lifecycle_state property of a RecipientInvitation. This constant has a value of “UPDATING”
-
STATUS_ACCEPTED
= 'ACCEPTED'¶ A constant which can be used with the status property of a RecipientInvitation. This constant has a value of “ACCEPTED”
-
STATUS_CANCELED
= 'CANCELED'¶ A constant which can be used with the status property of a RecipientInvitation. This constant has a value of “CANCELED”
-
STATUS_EXPIRED
= 'EXPIRED'¶ A constant which can be used with the status property of a RecipientInvitation. This constant has a value of “EXPIRED”
-
STATUS_FAILED
= 'FAILED'¶ A constant which can be used with the status property of a RecipientInvitation. This constant has a value of “FAILED”
-
STATUS_IGNORED
= 'IGNORED'¶ A constant which can be used with the status property of a RecipientInvitation. This constant has a value of “IGNORED”
-
STATUS_PENDING
= 'PENDING'¶ A constant which can be used with the status property of a RecipientInvitation. This constant has a value of “PENDING”
-
__init__
(**kwargs)¶ Initializes a new RecipientInvitation 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 RecipientInvitation.
- compartment_id (str) – The value to assign to the compartment_id property of this RecipientInvitation.
- subjects (list[oci.tenant_manager_control_plane.models.InvitationSubject]) – The value to assign to the subjects property of this RecipientInvitation.
- sender_invitation_id (str) – The value to assign to the sender_invitation_id property of this RecipientInvitation.
- sender_tenancy_id (str) – The value to assign to the sender_tenancy_id property of this RecipientInvitation.
- lifecycle_state (str) – The value to assign to the lifecycle_state property of this RecipientInvitation. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “FAILED”, “TERMINATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- status (str) – The value to assign to the status property of this RecipientInvitation. Allowed values for this property are: “PENDING”, “CANCELED”, “ACCEPTED”, “IGNORED”, “EXPIRED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- display_name (str) – The value to assign to the display_name property of this RecipientInvitation.
- time_created (datetime) – The value to assign to the time_created property of this RecipientInvitation.
- time_updated (datetime) – The value to assign to the time_updated property of this RecipientInvitation.
- recipient_email_address (str) – The value to assign to the recipient_email_address property of this RecipientInvitation.
- freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this RecipientInvitation.
- defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this RecipientInvitation.
- system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this RecipientInvitation.
-
compartment_id
¶ [Required] Gets the compartment_id of this RecipientInvitation. OCID of the recipient tenancy.
Returns: The compartment_id of this RecipientInvitation. Return type: str
Gets the defined_tags of this RecipientInvitation. 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 RecipientInvitation. Return type: dict(str, dict(str, object))
-
display_name
¶ Gets the display_name of this RecipientInvitation. A user-created name to describe the invitation. Avoid entering confidential information.
Returns: The display_name of this RecipientInvitation. Return type: str
Gets the freeform_tags of this RecipientInvitation. 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 RecipientInvitation. Return type: dict(str, str)
-
id
¶ [Required] Gets the id of this RecipientInvitation. OCID of the recipient invitation.
Returns: The id of this RecipientInvitation. Return type: str
-
lifecycle_state
¶ [Required] Gets the lifecycle_state of this RecipientInvitation. Lifecycle state of the recipient invitation.
Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “FAILED”, “TERMINATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
Returns: The lifecycle_state of this RecipientInvitation. Return type: str
-
recipient_email_address
¶ Gets the recipient_email_address of this RecipientInvitation. Email address of the recipient.
Returns: The recipient_email_address of this RecipientInvitation. Return type: str
-
sender_invitation_id
¶ [Required] Gets the sender_invitation_id of this RecipientInvitation. OCID of the corresponding sender invitation.
Returns: The sender_invitation_id of this RecipientInvitation. Return type: str
-
sender_tenancy_id
¶ [Required] Gets the sender_tenancy_id of this RecipientInvitation. OCID of the sender tenancy.
Returns: The sender_tenancy_id of this RecipientInvitation. Return type: str
-
status
¶ [Required] Gets the status of this RecipientInvitation. Status of the recipient invitation.
Allowed values for this property are: “PENDING”, “CANCELED”, “ACCEPTED”, “IGNORED”, “EXPIRED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
Returns: The status of this RecipientInvitation. Return type: str
-
subjects
¶ [Required] Gets the subjects of this RecipientInvitation. The list of subjects the invitation contains.
Returns: The subjects of this RecipientInvitation. Return type: list[oci.tenant_manager_control_plane.models.InvitationSubject]
Gets the system_tags of this RecipientInvitation. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}
Returns: The system_tags of this RecipientInvitation. Return type: dict(str, dict(str, object))
-
time_created
¶ [Required] Gets the time_created of this RecipientInvitation. Date and time when the recipient invitation was created.
Returns: The time_created of this RecipientInvitation. Return type: datetime
-
time_updated
¶ Gets the time_updated of this RecipientInvitation. Date and time when the recipient invitation was last updated.
Returns: The time_updated of this RecipientInvitation. Return type: datetime
-