o
    ɶd6                     @   s8   d dl mZmZmZ d dlmZ eG dd deZdS )    )formatted_flat_dictNONE_SENTINEL#value_allowed_none_or_none_sentinel)init_model_state_from_kwargsc                   @   sL  e Zd ZdZdZdZdZdZdZdZ	dd	 Z
ed
d Zejdd Zedd Zejdd Zedd Zejdd Zedd Zejdd Zedd Zejdd Zedd Zejdd Zedd Zejdd Zedd  Zejd!d  Zed"d# Zejd$d# Zed%d& Zejd'd& Zd(d) Zd*d+ Zd,d- Zd.S )/	UsagePlanzs
    A usage plan controls access of subscribers to deployments, controlling rate limits and quotas for usage.
    CREATINGACTIVEUPDATINGDELETINGDELETEDFAILEDc                 K   sx   ddddddddddd
| _ ddd	d
ddddddd
| _d| _d| _d| _d| _d| _d| _d| _d| _	d| _
d| _dS )a  
        Initializes a new UsagePlan 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 UsagePlan.
        :type id: str

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

        :param entitlements:
            The value to assign to the entitlements property of this UsagePlan.
        :type entitlements: list[oci.apigateway.models.Entitlement]

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

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

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

        :param lifecycle_state:
            The value to assign to the lifecycle_state property of this UsagePlan.
            Allowed values for this property are: "CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'.
            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
        :type lifecycle_state: str

        :param lifecycle_details:
            The value to assign to the lifecycle_details property of this UsagePlan.
        :type lifecycle_details: str

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

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

        strzlist[Entitlement]datetimezdict(str, str)zdict(str, dict(str, object)))
iddisplay_nameentitlementscompartment_idtime_createdtime_updatedlifecycle_statelifecycle_detailsfreeform_tagsdefined_tagsr   ZdisplayNamer   ZcompartmentIdZtimeCreatedZtimeUpdatedZlifecycleStateZlifecycleDetailsZfreeformTagsZdefinedTagsN)Zswagger_typesZattribute_map_id_display_name_entitlements_compartment_id_time_created_time_updated_lifecycle_state_lifecycle_details_freeform_tags_defined_tags)selfkwargs r%   Dusr/lib/python3.10/site-packages/oci/apigateway/models/usage_plan.py__init__*   s@   1
zUsagePlan.__init__c                 C      | j S )a
  
        **[Required]** Gets the id of this UsagePlan.
        The `OCID`__ of a usage plan
        resource.

        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm


        :return: The id of this UsagePlan.
        :rtype: str
        r   r#   r%   r%   r&   r         zUsagePlan.idc                 C   
   || _ dS )z
        Sets the id of this UsagePlan.
        The `OCID`__ of a usage plan
        resource.

        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm


        :param id: The id of this UsagePlan.
        :type: str
        Nr)   )r#   r   r%   r%   r&   r         
c                 C   r(   )a)  
        Gets the display_name of this UsagePlan.
        A user-friendly name. Does not have to be unique, and it's changeable.
        Avoid entering confidential information.

        Example: `My new resource`


        :return: The display_name of this UsagePlan.
        :rtype: str
        r   r*   r%   r%   r&   r      r+   zUsagePlan.display_namec                 C   r,   )a4  
        Sets the display_name of this UsagePlan.
        A user-friendly name. Does not have to be unique, and it's changeable.
        Avoid entering confidential information.

        Example: `My new resource`


        :param display_name: The display_name of this UsagePlan.
        :type: str
        Nr.   )r#   r   r%   r%   r&   r      r-   c                 C   r(   )a  
        **[Required]** Gets the entitlements of this UsagePlan.
        A collection of entitlements currently assigned to the usage plan.


        :return: The entitlements of this UsagePlan.
        :rtype: list[oci.apigateway.models.Entitlement]
        r   r*   r%   r%   r&   r         
zUsagePlan.entitlementsc                 C   r,   )z
        Sets the entitlements of this UsagePlan.
        A collection of entitlements currently assigned to the usage plan.


        :param entitlements: The entitlements of this UsagePlan.
        :type: list[oci.apigateway.models.Entitlement]
        Nr/   )r#   r   r%   r%   r&   r         

c                 C   r(   )a=  
        **[Required]** Gets the compartment_id of this UsagePlan.
        The `OCID`__ of the compartment in which the
        resource is created.

        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm


        :return: The compartment_id of this UsagePlan.
        :rtype: str
        r   r*   r%   r%   r&   r      r+   zUsagePlan.compartment_idc                 C   r,   )a;  
        Sets the compartment_id of this UsagePlan.
        The `OCID`__ of the compartment in which the
        resource is created.

        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm


        :param compartment_id: The compartment_id of this UsagePlan.
        :type: str
        Nr2   )r#   r   r%   r%   r&   r      r-   c                 C   r(   )z
        **[Required]** Gets the time_created of this UsagePlan.
        The time this resource was created. An RFC3339 formatted datetime string.


        :return: The time_created of this UsagePlan.
        :rtype: datetime
        r   r*   r%   r%   r&   r      r0   zUsagePlan.time_createdc                 C   r,   )z
        Sets the time_created of this UsagePlan.
        The time this resource was created. An RFC3339 formatted datetime string.


        :param time_created: The time_created of this UsagePlan.
        :type: datetime
        Nr3   )r#   r   r%   r%   r&   r      r1   c                 C   r(   )z
        **[Required]** Gets the time_updated of this UsagePlan.
        The time this resource was last updated. An RFC3339 formatted datetime string.


        :return: The time_updated of this UsagePlan.
        :rtype: datetime
        r   r*   r%   r%   r&   r   	  r0   zUsagePlan.time_updatedc                 C   r,   )z
        Sets the time_updated of this UsagePlan.
        The time this resource was last updated. An RFC3339 formatted datetime string.


        :param time_updated: The time_updated of this UsagePlan.
        :type: datetime
        Nr4   )r#   r   r%   r%   r&   r     r1   c                 C   r(   )a  
        **[Required]** Gets the lifecycle_state of this UsagePlan.
        The current state of the usage plan.

        Allowed values for this property are: "CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'.
        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.


        :return: The lifecycle_state of this UsagePlan.
        :rtype: str
        )r   r*   r%   r%   r&   r   !  r+   zUsagePlan.lifecycle_statec                 C   s    g d}t ||sd}|| _dS )z
        Sets the lifecycle_state of this UsagePlan.
        The current state of the usage plan.


        :param lifecycle_state: The lifecycle_state of this UsagePlan.
        :type: str
        )r   r   r	   r
   r   r   ZUNKNOWN_ENUM_VALUEN)r   r   )r#   r   Zallowed_valuesr%   r%   r&   r   0  s   


c                 C   r(   )a3  
        Gets the lifecycle_details of this UsagePlan.
        A message describing the current state in more detail.
        For example, can be used to provide actionable information for a resource in a Failed state.


        :return: The lifecycle_details of this UsagePlan.
        :rtype: str
        r    r*   r%   r%   r&   r   ?  s   zUsagePlan.lifecycle_detailsc                 C   r,   )aC  
        Sets the lifecycle_details of this UsagePlan.
        A message describing the current state in more detail.
        For example, can be used to provide actionable information for a resource in a Failed state.


        :param lifecycle_details: The lifecycle_details of this UsagePlan.
        :type: str
        Nr5   )r#   r   r%   r%   r&   r   L  s   
c                 C   r(   )a  
        Gets the freeform_tags of this UsagePlan.
        Free-form tags for this resource. Each tag is a simple key-value pair
        with no predefined name, type, or namespace. For more information, see
        `Resource Tags`__.

        Example: `{"Department": "Finance"}`

        __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm


        :return: The freeform_tags of this UsagePlan.
        :rtype: dict(str, str)
        r!   r*   r%   r%   r&   r   Y     zUsagePlan.freeform_tagsc                 C   r,   )a  
        Sets the freeform_tags of this UsagePlan.
        Free-form tags for this resource. Each tag is a simple key-value pair
        with no predefined name, type, or namespace. For more information, see
        `Resource Tags`__.

        Example: `{"Department": "Finance"}`

        __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm


        :param freeform_tags: The freeform_tags of this UsagePlan.
        :type: dict(str, str)
        Nr6   )r#   r   r%   r%   r&   r   k     
c                 C   r(   )a  
        Gets the defined_tags of this UsagePlan.
        Defined tags for this resource. Each key is predefined and scoped to a
        namespace. For more information, see
        `Resource Tags`__.

        Example: `{"Operations": {"CostCenter": "42"}}`

        __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm


        :return: The defined_tags of this UsagePlan.
        :rtype: dict(str, dict(str, object))
        r"   r*   r%   r%   r&   r   }  r7   zUsagePlan.defined_tagsc                 C   r,   )a  
        Sets the defined_tags of this UsagePlan.
        Defined tags for this resource. Each key is predefined and scoped to a
        namespace. For more information, see
        `Resource Tags`__.

        Example: `{"Operations": {"CostCenter": "42"}}`

        __ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm


        :param defined_tags: The defined_tags of this UsagePlan.
        :type: dict(str, dict(str, object))
        Nr9   )r#   r   r%   r%   r&   r     r8   c                 C   s   t | S N)r   r*   r%   r%   r&   __repr__  s   zUsagePlan.__repr__c                 C   s   |d u rdS | j |j kS )NF)__dict__r#   otherr%   r%   r&   __eq__  s   zUsagePlan.__eq__c                 C   s
   | |k S r:   r%   r=   r%   r%   r&   __ne__  s   
zUsagePlan.__ne__N)__name__
__module____qualname____doc__ZLIFECYCLE_STATE_CREATINGZLIFECYCLE_STATE_ACTIVEZLIFECYCLE_STATE_UPDATINGZLIFECYCLE_STATE_DELETINGZLIFECYCLE_STATE_DELETEDZLIFECYCLE_STATE_FAILEDr'   propertyr   setterr   r   r   r   r   r   r   r   r   r;   r?   r@   r%   r%   r%   r&   r      sh    U



















r   N)Zoci.utilr   r   r   Zoci.decoratorsr   objectr   r%   r%   r%   r&   <module>   s   