Aurora

Name	Size	Permissions	Actions
..	-	-	-

# coding: utf-8
# Copyright (c) 2016, 2024, Oracle and/or its affiliates.  All rights reserved.
# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.

# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20230401

from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
from oci.decorators import init_model_state_from_kwargs

@init_model_state_from_kwargs
class SenderInvitation(object):
    """
    The invitation model that the sender owns.
    """

#: A constant which can be used with the lifecycle_state property of a SenderInvitation.
    #: This constant has a value of "CREATING"
    LIFECYCLE_STATE_CREATING = "CREATING"

#: A constant which can be used with the lifecycle_state property of a SenderInvitation.
    #: This constant has a value of "ACTIVE"
    LIFECYCLE_STATE_ACTIVE = "ACTIVE"

#: A constant which can be used with the lifecycle_state property of a SenderInvitation.
    #: This constant has a value of "INACTIVE"
    LIFECYCLE_STATE_INACTIVE = "INACTIVE"

#: A constant which can be used with the lifecycle_state property of a SenderInvitation.
    #: This constant has a value of "UPDATING"
    LIFECYCLE_STATE_UPDATING = "UPDATING"

#: A constant which can be used with the lifecycle_state property of a SenderInvitation.
    #: This constant has a value of "FAILED"
    LIFECYCLE_STATE_FAILED = "FAILED"

#: A constant which can be used with the lifecycle_state property of a SenderInvitation.
    #: This constant has a value of "TERMINATED"
    LIFECYCLE_STATE_TERMINATED = "TERMINATED"

#: A constant which can be used with the status property of a SenderInvitation.
    #: This constant has a value of "PENDING"
    STATUS_PENDING = "PENDING"

#: A constant which can be used with the status property of a SenderInvitation.
    #: This constant has a value of "CANCELED"
    STATUS_CANCELED = "CANCELED"

#: A constant which can be used with the status property of a SenderInvitation.
    #: This constant has a value of "ACCEPTED"
    STATUS_ACCEPTED = "ACCEPTED"

#: A constant which can be used with the status property of a SenderInvitation.
    #: This constant has a value of "EXPIRED"
    STATUS_EXPIRED = "EXPIRED"

#: A constant which can be used with the status property of a SenderInvitation.
    #: This constant has a value of "FAILED"
    STATUS_FAILED = "FAILED"

def __init__(self, **kwargs):
        """
        Initializes a new SenderInvitation object with values from keyword arguments.
        The following keyword arguments are supported (corresponding to the getters/setters of this class):

:param id:
            The value to assign to the id property of this SenderInvitation.
        :type id: str

:param compartment_id:
            The value to assign to the compartment_id property of this SenderInvitation.
        :type compartment_id: str

:param subjects:
            The value to assign to the subjects property of this SenderInvitation.
        :type subjects: list[oci.tenant_manager_control_plane.models.InvitationSubject]

:param recipient_invitation_id:
            The value to assign to the recipient_invitation_id property of this SenderInvitation.
        :type recipient_invitation_id: str

:param recipient_tenancy_id:
            The value to assign to the recipient_tenancy_id property of this SenderInvitation.
        :type recipient_tenancy_id: str

:param lifecycle_state:
            The value to assign to the lifecycle_state property of this SenderInvitation.
            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'.
        :type lifecycle_state: str

:param status:
            The value to assign to the status property of this SenderInvitation.
            Allowed values for this property are: "PENDING", "CANCELED", "ACCEPTED", "EXPIRED", "FAILED", 'UNKNOWN_ENUM_VALUE'.
            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
        :type status: str

:param display_name:
            The value to assign to the display_name property of this SenderInvitation.
        :type display_name: str

:param time_created:
            The value to assign to the time_created property of this SenderInvitation.
        :type time_created: datetime

:param time_updated:
            The value to assign to the time_updated property of this SenderInvitation.
        :type time_updated: datetime

:param recipient_email_address:
            The value to assign to the recipient_email_address property of this SenderInvitation.
        :type recipient_email_address: str

:param freeform_tags:
            The value to assign to the freeform_tags property of this SenderInvitation.
        :type freeform_tags: dict(str, str)

:param defined_tags:
            The value to assign to the defined_tags property of this SenderInvitation.
        :type defined_tags: dict(str, dict(str, object))

:param system_tags:
            The value to assign to the system_tags property of this SenderInvitation.
        :type system_tags: dict(str, dict(str, object))

"""
        self.swagger_types = {
            'id': 'str',
            'compartment_id': 'str',
            'subjects': 'list[InvitationSubject]',
            'recipient_invitation_id': 'str',
            'recipient_tenancy_id': 'str',
            'lifecycle_state': 'str',
            'status': 'str',
            'display_name': 'str',
            'time_created': 'datetime',
            'time_updated': 'datetime',
            'recipient_email_address': 'str',
            'freeform_tags': 'dict(str, str)',
            'defined_tags': 'dict(str, dict(str, object))',
            'system_tags': 'dict(str, dict(str, object))'
        }

self.attribute_map = {
            'id': 'id',
            'compartment_id': 'compartmentId',
            'subjects': 'subjects',
            'recipient_invitation_id': 'recipientInvitationId',
            'recipient_tenancy_id': 'recipientTenancyId',
            'lifecycle_state': 'lifecycleState',
            'status': 'status',
            'display_name': 'displayName',
            'time_created': 'timeCreated',
            'time_updated': 'timeUpdated',
            'recipient_email_address': 'recipientEmailAddress',
            'freeform_tags': 'freeformTags',
            'defined_tags': 'definedTags',
            'system_tags': 'systemTags'
        }

self._id = None
        self._compartment_id = None
        self._subjects = None
        self._recipient_invitation_id = None
        self._recipient_tenancy_id = None
        self._lifecycle_state = None
        self._status = None
        self._display_name = None
        self._time_created = None
        self._time_updated = None
        self._recipient_email_address = None
        self._freeform_tags = None
        self._defined_tags = None
        self._system_tags = None

@property
    def id(self):
        """
        **[Required]** Gets the id of this SenderInvitation.
        OCID of the sender invitation.

:return: The id of this SenderInvitation.
        :rtype: str
        """
        return self._id

@id.setter
    def id(self, id):
        """
        Sets the id of this SenderInvitation.
        OCID of the sender invitation.

:param id: The id of this SenderInvitation.
        :type: str
        """
        self._id = id

@property
    def compartment_id(self):
        """
        **[Required]** Gets the compartment_id of this SenderInvitation.
        OCID of the sender tenancy.

:return: The compartment_id of this SenderInvitation.
        :rtype: str
        """
        return self._compartment_id

@compartment_id.setter
    def compartment_id(self, compartment_id):
        """
        Sets the compartment_id of this SenderInvitation.
        OCID of the sender tenancy.

:param compartment_id: The compartment_id of this SenderInvitation.
        :type: str
        """
        self._compartment_id = compartment_id

@property
    def subjects(self):
        """
        **[Required]** Gets the subjects of this SenderInvitation.
        The list of subjects the invitation contains.

:return: The subjects of this SenderInvitation.
        :rtype: list[oci.tenant_manager_control_plane.models.InvitationSubject]
        """
        return self._subjects

@subjects.setter
    def subjects(self, subjects):
        """
        Sets the subjects of this SenderInvitation.
        The list of subjects the invitation contains.

:param subjects: The subjects of this SenderInvitation.
        :type: list[oci.tenant_manager_control_plane.models.InvitationSubject]
        """
        self._subjects = subjects

@property
    def recipient_invitation_id(self):
        """
        Gets the recipient_invitation_id of this SenderInvitation.
        OCID of the corresponding recipient invitation.

:return: The recipient_invitation_id of this SenderInvitation.
        :rtype: str
        """
        return self._recipient_invitation_id

@recipient_invitation_id.setter
    def recipient_invitation_id(self, recipient_invitation_id):
        """
        Sets the recipient_invitation_id of this SenderInvitation.
        OCID of the corresponding recipient invitation.

:param recipient_invitation_id: The recipient_invitation_id of this SenderInvitation.
        :type: str
        """
        self._recipient_invitation_id = recipient_invitation_id

@property
    def recipient_tenancy_id(self):
        """
        **[Required]** Gets the recipient_tenancy_id of this SenderInvitation.
        OCID of the recipient tenancy.

:return: The recipient_tenancy_id of this SenderInvitation.
        :rtype: str
        """
        return self._recipient_tenancy_id

@recipient_tenancy_id.setter
    def recipient_tenancy_id(self, recipient_tenancy_id):
        """
        Sets the recipient_tenancy_id of this SenderInvitation.
        OCID of the recipient tenancy.

:param recipient_tenancy_id: The recipient_tenancy_id of this SenderInvitation.
        :type: str
        """
        self._recipient_tenancy_id = recipient_tenancy_id

@property
    def lifecycle_state(self):
        """
        **[Required]** Gets the lifecycle_state of this SenderInvitation.
        Lifecycle state of the sender 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'.

:return: The lifecycle_state of this SenderInvitation.
        :rtype: str
        """
        return self._lifecycle_state

@lifecycle_state.setter
    def lifecycle_state(self, lifecycle_state):
        """
        Sets the lifecycle_state of this SenderInvitation.
        Lifecycle state of the sender invitation.

:param lifecycle_state: The lifecycle_state of this SenderInvitation.
        :type: str
        """
        allowed_values = ["CREATING", "ACTIVE", "INACTIVE", "UPDATING", "FAILED", "TERMINATED"]
        if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values):
            lifecycle_state = 'UNKNOWN_ENUM_VALUE'
        self._lifecycle_state = lifecycle_state

@property
    def status(self):
        """
        **[Required]** Gets the status of this SenderInvitation.
        Status of the sender invitation.

Allowed values for this property are: "PENDING", "CANCELED", "ACCEPTED", "EXPIRED", "FAILED", 'UNKNOWN_ENUM_VALUE'.
        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.

:return: The status of this SenderInvitation.
        :rtype: str
        """
        return self._status

@status.setter
    def status(self, status):
        """
        Sets the status of this SenderInvitation.
        Status of the sender invitation.

:param status: The status of this SenderInvitation.
        :type: str
        """
        allowed_values = ["PENDING", "CANCELED", "ACCEPTED", "EXPIRED", "FAILED"]
        if not value_allowed_none_or_none_sentinel(status, allowed_values):
            status = 'UNKNOWN_ENUM_VALUE'
        self._status = status

@property
    def display_name(self):
        """
        Gets the display_name of this SenderInvitation.
        A user-created name to describe the invitation. Avoid entering confidential information.

:return: The display_name of this SenderInvitation.
        :rtype: str
        """
        return self._display_name

@display_name.setter
    def display_name(self, display_name):
        """
        Sets the display_name of this SenderInvitation.
        A user-created name to describe the invitation. Avoid entering confidential information.

:param display_name: The display_name of this SenderInvitation.
        :type: str
        """
        self._display_name = display_name

@property
    def time_created(self):
        """
        **[Required]** Gets the time_created of this SenderInvitation.
        Date and time when the sender invitation was created.

:return: The time_created of this SenderInvitation.
        :rtype: datetime
        """
        return self._time_created

@time_created.setter
    def time_created(self, time_created):
        """
        Sets the time_created of this SenderInvitation.
        Date and time when the sender invitation was created.

:param time_created: The time_created of this SenderInvitation.
        :type: datetime
        """
        self._time_created = time_created

@property
    def time_updated(self):
        """
        Gets the time_updated of this SenderInvitation.
        Date and time when the sender invitation was last updated.

:return: The time_updated of this SenderInvitation.
        :rtype: datetime
        """
        return self._time_updated

@time_updated.setter
    def time_updated(self, time_updated):
        """
        Sets the time_updated of this SenderInvitation.
        Date and time when the sender invitation was last updated.

:param time_updated: The time_updated of this SenderInvitation.
        :type: datetime
        """
        self._time_updated = time_updated

@property
    def recipient_email_address(self):
        """
        Gets the recipient_email_address of this SenderInvitation.
        Email address of the recipient.

:return: The recipient_email_address of this SenderInvitation.
        :rtype: str
        """
        return self._recipient_email_address

@recipient_email_address.setter
    def recipient_email_address(self, recipient_email_address):
        """
        Sets the recipient_email_address of this SenderInvitation.
        Email address of the recipient.

:param recipient_email_address: The recipient_email_address of this SenderInvitation.
        :type: str
        """
        self._recipient_email_address = recipient_email_address

@property
    def freeform_tags(self):
        """
        Gets the freeform_tags of this SenderInvitation.
        Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
        Example: `{\"bar-key\": \"value\"}`

:return: The freeform_tags of this SenderInvitation.
        :rtype: dict(str, str)
        """
        return self._freeform_tags

@freeform_tags.setter
    def freeform_tags(self, freeform_tags):
        """
        Sets the freeform_tags of this SenderInvitation.
        Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
        Example: `{\"bar-key\": \"value\"}`

:param freeform_tags: The freeform_tags of this SenderInvitation.
        :type: dict(str, str)
        """
        self._freeform_tags = freeform_tags

@property
    def defined_tags(self):
        """
        Gets the defined_tags of this SenderInvitation.
        Defined tags for this resource. Each key is predefined and scoped to a namespace.
        Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

:return: The defined_tags of this SenderInvitation.
        :rtype: dict(str, dict(str, object))
        """
        return self._defined_tags

@defined_tags.setter
    def defined_tags(self, defined_tags):
        """
        Sets the defined_tags of this SenderInvitation.
        Defined tags for this resource. Each key is predefined and scoped to a namespace.
        Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

:param defined_tags: The defined_tags of this SenderInvitation.
        :type: dict(str, dict(str, object))
        """
        self._defined_tags = defined_tags

@property
    def system_tags(self):
        """
        Gets the system_tags of this SenderInvitation.
        Usage of system tag keys. These predefined keys are scoped to namespaces.
        Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`

:return: The system_tags of this SenderInvitation.
        :rtype: dict(str, dict(str, object))
        """
        return self._system_tags

@system_tags.setter
    def system_tags(self, system_tags):
        """
        Sets the system_tags of this SenderInvitation.
        Usage of system tag keys. These predefined keys are scoped to namespaces.
        Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`

:param system_tags: The system_tags of this SenderInvitation.
        :type: dict(str, dict(str, object))
        """
        self._system_tags = system_tags

def __repr__(self):
        return formatted_flat_dict(self)

def __eq__(self, other):
        if other is None:
            return False

return self.__dict__ == other.__dict__

def __ne__(self, other):
        return not self == other

Upload File

New Folder

New File

Add WordPress Admin

cPanel Password Reset

Edit: sender_invitation.py