o ɶdX@sddlmZddlmZddlmZddlmZmZddlm Z ddl m Z m Z ddl mZddlmZmZmZd d lmZed ZGd d d eZdS))absolute_import)requests)six)retrycircuit_breaker) BaseClient)get_config_value_or_defaultvalidate_config)Signer)Sentinel#get_signer_from_authentication_typeAUTHENTICATION_TYPE_FIELD_NAME)limits_type_mappingZMissingc@sPeZdZdZddZddZddZdd Zd d Zd d Z ddZ ddZ dS) QuotasClientzR APIs that interact with the resource limits of a specific resource type. c Kst||ddd|vr|d}n"t|vrt|}nt|d|d|d|dt|d|dd }d |d d d i|dd|dtj|dd}d|vrY|d|d<|dduretj|d<d|vrp|d|d<t d||t fi||_ |d|_ |d|_ dS)a Creates a new service client :param dict config: Configuration keys and values as per `SDK and Tool Configuration `__. The :py:meth:`~oci.config.from_file` method can be used to load configuration from a file. Alternatively, a ``dict`` can be passed. You can validate_config the dict using :py:meth:`~oci.config.validate_config` :param str service_endpoint: (optional) The endpoint of the service to call using this client. For example ``https://iaas.us-ashburn-1.oraclecloud.com``. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint. :param timeout: (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout. :type timeout: float or tuple(float, float) :param signer: (optional) The signer to use when signing requests made by the service client. The default is to use a :py:class:`~oci.signer.Signer` based on the values provided in the config parameter. One use case for this parameter is for `Instance Principals authentication `__ by passing an instance of :py:class:`~oci.auth.signers.InstancePrincipalsSecurityTokenSigner` as the value for this keyword argument :type signer: :py:class:`~oci.signer.AbstractBaseSigner` :param obj retry_strategy: (optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a ``retry_strategy`` keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level. This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` is also available. The specifics of the default retry strategy are described `here `__. :param obj circuit_breaker_strategy: (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses :py:data:`~oci.circuit_breaker.DEFAULT_CIRCUIT_BREAKER_STRATEGY` as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described `here `__. :param function circuit_breaker_callback: (optional) Callback function to receive any exceptions triggerred by the circuit breaker. :param bool client_level_realm_specific_endpoint_template_enabled: (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None. :param allow_control_chars: (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. signer)rtenancyuser fingerprintZkey_file pass_phraseZ key_content)rrrZprivate_key_file_locationrZprivate_key_contentTservice_endpoint/z/https://limits.{region}.oci.{secondLevelDomain}skip_deserializationFcircuit_breaker_strategy5client_level_realm_specific_endpoint_template_enabled)Zregional_clientr base_pathZservice_endpoint_templateZ#service_endpoint_template_per_realmrrrtimeoutNallow_control_charsZquotasretry_strategycircuit_breaker_callback)r getr r r rrZGLOBAL_CIRCUIT_BREAKER_STRATEGYZ DEFAULT_CIRCUIT_BREAKER_STRATEGYrr base_clientrr)selfconfigkwargsrZbase_client_init_kwargsr%3        zQuotasClient.__init__c ldg}d}d}d}d}gdfddt|D} | r$td | d|i} d d t| D} t| D]\} } | d usMt| tjrTt| d krTtd| q7dd| dt | dt d} dd t| D} |j j | d|j d}|rt|tjs|j | ||j|j|j j||| | |d| d|||d S|j j||| | |d| d|||d S)ap Adds a lock to a resource. :param str quota_id: (required) The OCID of the quota. :param oci.limits.models.AddLockDetails add_lock_details: (required) :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value. :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. :param bool allow_control_chars: (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.limits.models.Quota` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use add_quota_lock API. quotaIdz*/20181025/quotas/{quotaId}/actions/addLockPOSTadd_quota_lockzHhttps://docs.oracle.com/iaas/api/#/en/limits/20181025/Quota/AddQuotaLockrropc_request_idif_matchcg|]}|vr|qSr%r%.0_keyZexpected_kwargsr%r& z/QuotasClient.add_quota_lock..z'add_quota_lock got unknown kwargs: {!r}cSi|] \}}|tur||qSr%missingr1kvr%r%r& z/QuotasClient.add_quota_lock..Nr7Parameter {} cannot be None, whitespace or empty stringapplication/jsonr-r.accept content-typeopc-request-idzif-matchcS&i|]\}}|tur|dur||qSNr7r9r%r%r&r<&rZoperation_retry_strategyZclient_retry_strategyQuotar resource_pathmethod path_params header_paramsbody response_typeroperation_nameapi_reference_linkrequired_argumentsriterkeys ValueErrorformat iteritems isinstance string_typeslenstripr r8r!get_preferred_retry_strategyrrNoneRetryStrategyadd_opc_client_retries_headeradd_circuit_breaker_callbackrmake_retrying_callcall_api)r"quota_idZadd_lock_detailsr$rRrJrKrPrQ extra_kwargsrLr:r;rMrr%r3r&r+rr&$      zQuotasClient.add_quota_lockc sg}d}d}d}d}gdfddt|D}|r#td|d d |d t|d td } d dt| D} |jj|d|j d} | durOt j } | r}t | t j si|j| |j| | |j| j|jj||| |d|d|||d S|jj||| |d|d|||d S)a Creates a new quota with the details supplied. :param oci.limits.models.CreateQuotaDetails create_quota_details: (required) Request object for creating a new quota. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. :param str opc_retry_token: (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request can be rejected). :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. :param bool allow_control_chars: (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.limits.models.Quota` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use create_quota API. /20181025/quotasr* create_quotazGhttps://docs.oracle.com/iaas/api/#/en/limits/20181025/Quota/CreateQuota)rrr-opc_retry_tokencr/r%r%r0r3r%r&r4r5z-QuotasClient.create_quota..z%create_quota got unknown kwargs: {!r}r?r-rg)rArBrCzopc-retry-tokencSrDrEr7r9r%r%r&r<rFz-QuotasClient.create_quota..rrGNrHr) rJrKrMrNrOrrPrQrR)rrTrUrVr r8rWr!r\rrDEFAULT_RETRY_STRATEGYrXr]Zadd_opc_retry_token_if_neededr^r_rr`ra) r"Zcreate_quota_detailsr$rRrJrKrPrQrcrMrr%r3r&rfsf&       zQuotasClient.create_quotac sdg}d}d}d}d}gdfddt|D}|r$td |d|i} d d t| D} t| D]\} } | d usMt| tjrTt| d krTtd| q7d| dt i} dd t| D} dd| dt | dt d} dd t| D} |j j | d|j d}|d urtj}|rt|tjs|j | ||j|j|j j||| | | | d|||d S|j j||| | | | d|||d S)aH Deletes the quota corresponding to the given OCID. :param str quota_id: (required) The OCID of the quota. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value. :param bool is_lock_override: (optional) Whether to override locks (if any exist). :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. :param bool allow_control_chars: (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings :return: A :class:`~oci.response.Response` object with data of type None :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use delete_quota API. r)/20181025/quotas/{quotaId}ZDELETE delete_quotazGhttps://docs.oracle.com/iaas/api/#/en/limits/20181025/Quota/DeleteQuotarrr-r.is_lock_overridecr/r%r%r0r3r%r&r4vr5z-QuotasClient.delete_quota..z%delete_quota got unknown kwargs: {!r}cSr6r%r7r9r%r%r&r<r=z-QuotasClient.delete_quota..Nrr>isLockOverriderlcSrDrEr7r9r%r%r&r<rFr?r-r.r@cSrDrEr7r9r%r%r&r<rFrrGr) rJrKrL query_paramsrMrrPrQrRrrTrUrVrWrXrYrZr[r r8r!r\rrrhr]r^r_rr`ra)r"rbr$rRrJrKrPrQrcrLr:r;rnrMrr%r3r&rjAsx'$       zQuotasClient.delete_quotac sldg}d}d}d}d}gdfddt|D}|r$td |d|i} d d t| D} t| D]\} } | d usMt| tjrTt| d krTtd| q7dd| dt d} dd t| D} |j j | d|j d} | d ur|tj} | rt| tjs|j | | |j| j|j j||| | d| d|||d S|j j||| | d| d|||d S)av Gets the quota for the OCID specified. :param str quota_id: (required) The OCID of the quota. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. :param bool allow_control_chars: (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.limits.models.Quota` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use get_quota API. r)riGET get_quotazDhttps://docs.oracle.com/iaas/api/#/en/limits/20181025/Quota/GetQuota)rrr-cr/r%r%r0r3r%r&r4r5z*QuotasClient.get_quota..z"get_quota got unknown kwargs: {!r}cSr6r%r7r9r%r%r&r<r=z*QuotasClient.get_quota..Nrr>r?r-rArBrCcSrDrEr7r9r%r%r&r<rFrrGrHr) rJrKrLrMrOrrPrQrRro)r"rbr$rRrJrKrPrQrcrLr:r;rMrr%r3r&rqsp$     zQuotasClient.get_quotac sdg}d}d}d}d}gdfddt|D}|r$td |d |vr8d g} |d | vr8td | d |vrMddg} |d | vrMtd| d|vrbddg} |d| vrbtd| ||dt|dt|dt|d t|d t|dtd} ddt| D} dd|dtd} ddt| D} |jj|d|j d }|d!urt j }|rt |t j s|j| ||j|j|jj||| | d"|d#|||d$ S|jj||| | d"|d#|||d$ S)%ab Lists all quotas on resources from the given compartment. :param str compartment_id: (required) The OCID of the parent compartment (remember that the tenancy is simply the root compartment). :param str page: (optional) The value of the `opc-next-page` response header from the previous "List" call. :param int limit: (optional) The maximum number of items to return in a paginated "List" call. :param str name: (optional) name :param str lifecycle_state: (optional) Filters returned quotas based on the given state. Allowed values are: "ACTIVE" :param str sort_order: (optional) The sort order to use, either 'asc' or 'desc'. By default, it is ascending. Allowed values are: "ASC", "DESC" :param str sort_by: (optional) The field to sort by. Only one sort order can be provided. Time created is default ordered as descending. Display name is default ordered as ascending. Allowed values are: "NAME", "TIMECREATED" :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. :param bool allow_control_chars: (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.limits.models.QuotaSummary` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use list_quotas API. compartmentIdrerp list_quotaszMhttps://docs.oracle.com/iaas/api/#/en/limits/20181025/QuotaSummary/ListQuotas) rrpagelimitnamelifecycle_state sort_ordersort_byr-cr/r%r%r0r3r%r&r4`r5z,QuotasClient.list_quotas..z$list_quotas got unknown kwargs: {!r}rxZACTIVEz7Invalid value for `lifecycle_state`, must be one of {0}ryZASCZDESCz2Invalid value for `sort_order`, must be one of {0}rzNAMEZ TIMECREATEDz/Invalid value for `sort_by`, must be one of {0}rurvrw)rsrurvrwZlifecycleStateZ sortOrderZsortBycSrDrEr7r9r%r%r&r<rFz,QuotasClient.list_quotas..r?r-rrcSrDrEr7r9r%r%r&r<rFrrGNzlist[QuotaSummary]r) rJrKrnrMrOrrPrQrR)rrTrUrVr r8rWr!r\rrrhrXr]r^r_rr`ra)r"Zcompartment_idr$rRrJrKrPrQrcZlifecycle_state_allowed_valuesZsort_order_allowed_valuesZsort_by_allowed_valuesrnrMrr%r3r&rts7                zQuotasClient.list_quotasc r()a Remove a lock from a resource. :param str quota_id: (required) The OCID of the quota. :param oci.limits.models.RemoveLockDetails remove_lock_details: (required) :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value. :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. :param bool allow_control_chars: (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.limits.models.Quota` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use remove_quota_lock API. r)z-/20181025/quotas/{quotaId}/actions/removeLockr*remove_quota_lockzKhttps://docs.oracle.com/iaas/api/#/en/limits/20181025/Quota/RemoveQuotaLockr,cr/r%r%r0r3r%r&r4r5z2QuotasClient.remove_quota_lock..z*remove_quota_lock got unknown kwargs: {!r}cSr6r%r7r9r%r%r&r<r=z2QuotasClient.remove_quota_lock..Nrr>r?r-r.r@cSrDrEr7r9r%r%r&r<rFrrGrHrrIrS)r"rbZremove_lock_detailsr$rRrJrKrPrQrcrLr:r;rMrr%r3r&r|rdzQuotasClient.remove_quota_lockc sdg}d}d}d}d}gdfddt|D} | r$td | d|i} d d t| D} t| D]\} } | d usMt| tjrTt| d krTtd| q7d| dt i} dd t| D} dd| dt | dt d}dd t|D}|j j | d|j d}|d urtj}|rt|tjs|j |||j|j|j j||| | ||d| d|||d S|j j||| | ||d| d|||d S)a Updates the quota corresponding to given OCID with the details supplied. :param str quota_id: (required) The OCID of the quota. :param oci.limits.models.UpdateQuotaDetails update_quota_details: (required) Request object for updating a quota. :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource's current etag value. :param bool is_lock_override: (optional) Whether to override locks (if any exist). :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. :param bool allow_control_chars: (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.limits.models.Quota` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use update_quota API. r)riZPUT update_quotazGhttps://docs.oracle.com/iaas/api/#/en/limits/20181025/Quota/UpdateQuotarkcr/r%r%r0r3r%r&r4Rr5z-QuotasClient.update_quota..z%update_quota got unknown kwargs: {!r}cSr6r%r7r9r%r%r&r<[r=z-QuotasClient.update_quota..Nrr>rmrlcSrDrEr7r9r%r%r&r<drFr?r-r.r@cSrDrEr7r9r%r%r&r<lrFrrGrHr) rJrKrLrnrMrNrOrrPrQrRro)r"rbZupdate_quota_detailsr$rRrJrKrPrQrcrLr:r;rnrMrr%r3r&r}s*$      zQuotasClient.update_quotaN) __name__ __module__ __qualname____doc__r'r+rfrjrqrtr|r}r%r%r%r&rsXlcsc lrN) __future__rZ oci._vendorrrocirrZoci.base_clientrZ oci.configrr Z oci.signerr Zoci.utilr r r Zmodelsrr8objectrr%r%r%r&s