o ɶd @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@s8eZdZdZddZddZddZdd Zd d Zd S) LimitsClientzR 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_charsZlimitsretry_strategycircuit_breaker_callback)r getr r r rrZGLOBAL_CIRCUIT_BREAKER_STRATEGYZ DEFAULT_CIRCUIT_BREAKER_STRATEGYrr base_clientrr)selfconfigkwargsrZbase_client_init_kwargsr%3        zLimitsClient.__init__c sgd}d}d}d}d} gdfddt|D} | r%td | ||d } d d t| D} t| D]\} } | d usOt| tjrVt| dkrVtd| q9|| dt d}dd t|D}dd| 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 For a given compartmentId, resource limit name, and scope, returns the following: * The number of available resources associated with the given limit. * The usage in the selected compartment for the given limit. Note that not all resource limits support this API. If the value is not available, the API returns a 404 response. :param str service_name: (required) The service name of the target quota. :param str limit_name: (required) The limit name for which to fetch the data. :param str compartment_id: (required) The OCID of the compartment for which data is being fetched. :param str availability_domain: (optional) This field is mandatory if the scopeType of the target resource limit is AD. Otherwise, this field should be omitted. If the above requirements are not met, the API returns a 400 - InvalidParameter response. :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.ResourceAvailability` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use get_resource_availability API. ) serviceName limitName compartmentIdzH/20190729/services/{serviceName}/limits/{limitName}/resourceAvailabilityGETget_resource_availabilityzbhttps://docs.oracle.com/iaas/api/#/en/limits/20181025/ResourceAvailability/GetResourceAvailability)rravailability_domainopc_request_idcg|]}|vr|qSr%r%.0_keyZexpected_kwargsr%r& z:LimitsClient.get_resource_availability..z2get_resource_availability got unknown kwargs: {!r})r(r)cSsi|] \}}|tur||qSr%missingr1kvr%r%r& sz:LimitsClient.get_resource_availability..Nrz7Parameter {} cannot be None, whitespace or empty stringr-)r*availabilityDomaincS&i|]\}}|tur|dur||qSNr6r8r%r%r&r;&application/jsonr.acceptz content-typezopc-request-idcSr=r>r6r8r%r%r&r;r?rZoperation_retry_strategyZclient_retry_strategyZResourceAvailabilityr) resource_pathmethod path_params query_params header_params response_typeroperation_nameapi_reference_linkrequired_arguments)riterkeys ValueErrorformat iteritems isinstanceZ string_typeslenstripr r7r!get_preferred_retry_strategyrrDEFAULT_RETRY_STRATEGYNoneRetryStrategyadd_opc_client_retries_headeradd_circuit_breaker_callbackrmake_retrying_callcall_api)r" service_nameZ limit_namecompartment_idr$rLrDrErJrK extra_kwargsrFr9r:rGrHrr%r3r&r,rs~-$      z&LimitsClient.get_resource_availabilityc sdg}d}d}d}d}gdfddt|D}|r$td |d |vr9d d g} |d | vr9td | d|vrNddg} |d| vrNtd| ||dt|d t|d t|dt|dt|dtd} ddt| D} dd|dtd} ddt| D} |jj|d|j d} | durt j } | rt | t j s|j| | |j| j|jj||| | d|d |||d! S|jj||| | d|d |||d! S)"a} Includes a list of resource limits that are currently supported. If the 'areQuotasSupported' property is true, you can create quota policies on top of this limit at the compartment level. :param str compartment_id: (required) The OCID of the parent compartment (remember that the tenancy is simply the root compartment). :param str service_name: (optional) The target service name. :param str name: (optional) Optional field, filter for a specific resource limit. :param str sort_by: (optional) The field to sort by. Allowed values are: "name", "description" :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 int limit: (optional) The maximum number of items to return in a paginated "List" call. :param str page: (optional) The value of the `opc-next-page` response header from the previous "List" call. :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.LimitDefinitionSummary` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use list_limit_definitions API. r*z/20190729/limitDefinitionsr+list_limit_definitionszahttps://docs.oracle.com/iaas/api/#/en/limits/20181025/LimitDefinitionSummary/ListLimitDefinitions) rrr[namesort_by sort_orderlimitpager.cr/r%r%r0r3r%r&r46r5z7LimitsClient.list_limit_definitions..z/list_limit_definitions got unknown kwargs: {!r}r`r_ description/Invalid value for `sort_by`, must be one of {0}raASCDESC2Invalid value for `sort_order`, must be one of {0}r[rbrc)r*r(r_sortBy sortOrderrbrccSr=r>r6r8r%r%r&r;Rr?z7LimitsClient.list_limit_definitions..r@r.rAcSr=r>r6r8r%r%r&r;Yr?rrCNzlist[LimitDefinitionSummary]r rDrErGrHrIrrJrKrLrrMrNrOr r7rPr!rTrrrUrQrVrWrXrrYrZr"r\r$rLrDrErJrKr]sort_by_allowed_valuessort_order_allowed_valuesrGrHrr%r3r&r^s7               z#LimitsClient.list_limit_definitionsc sddg}d}d}d}d}gdfdd t|D} | r%td | d |vr:gd } |d | vr:td | d|vrNdg} |d| vrNtd| d|vrcddg} |d| vrctd| |||d t|dt|dt|dt|dt|dt|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 Includes a full list of resource limits belonging to a given service. :param str compartment_id: (required) The OCID of the parent compartment (remember that the tenancy is simply the root compartment). :param str service_name: (required) The target service name. :param str scope_type: (optional) Filter entries by scope type. Allowed values are: "GLOBAL", "REGION", "AD" :param str availability_domain: (optional) Filter entries by availability domain. This implies that only AD-specific values are returned. :param str name: (optional) Optional field, can be used to see a specific resource limit value. :param str sort_by: (optional) The field to sort by. The sorting is by availabilityDomain, as a second level field, if available. Allowed values are: "name" :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 int limit: (optional) The maximum number of items to return in a paginated "List" call. :param str page: (optional) The value of the `opc-next-page` response header from the previous "List" call. :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.LimitValueSummary` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use list_limit_values API. r*r(z/20190729/limitValuesr+list_limit_valueszWhttps://docs.oracle.com/iaas/api/#/en/limits/20181025/LimitValueSummary/ListLimitValues) rr scope_typer-r_r`rarbrcr.cr/r%r%r0r3r%r&r4r5z2LimitsClient.list_limit_values..z*list_limit_values got unknown kwargs: {!r}rq)ZGLOBALZREGIONZADz2Invalid value for `scope_type`, must be one of {0}r`r_rerarfrgrhr-rbrc) r*r(Z scopeTyper<r_rirjrbrccSr=r>r6r8r%r%r&r;r?z2LimitsClient.list_limit_values..r@r.rAcSr=r>r6r8r%r%r&r;r?rrCNzlist[LimitValueSummary]rrkrl)r"r\r[r$rLrDrErJrKr]Zscope_type_allowed_valuesrnrorGrHrr%r3r&rp}s=                 zLimitsClient.list_limit_valuesc sdg}d}d}d}d}gdfddt|D}|r$td |d |vr9d d g} |d | vr9td | d|vrNddg} |d| vrNtd| ||d t|dt|dt|dtd} ddt| D} dd|dtd} ddt| D} |jj|d|j d} | durt j } | rt | t j s|j| | |j| j|jj||| | d|d|||d S|jj||| | d|d|||d S)!aa Returns the list of supported services. This includes the programmatic service name, along with the friendly service name. :param str compartment_id: (required) The OCID of the parent compartment (remember that the tenancy is simply the root compartment). :param str sort_by: (optional) The field to sort by. Allowed values are: "name", "description" :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 int limit: (optional) The maximum number of items to return in a paginated "List" call. :param str page: (optional) The value of the `opc-next-page` response header from the previous "List" call. :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.ServiceSummary` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use list_services API. r*z/20190729/servicesr+ list_serviceszQhttps://docs.oracle.com/iaas/api/#/en/limits/20181025/ServiceSummary/ListServices)rrr`rarbrcr.cr/r%r%r0r3r%r&r4]r5z.LimitsClient.list_services..z&list_services got unknown kwargs: {!r}r`r_rdrerarfrgrhrbrc)r*rirjrbrccSr=r>r6r8r%r%r&r;wr?z.LimitsClient.list_services..r@r.rAcSr=r>r6r8r%r%r&r;~r?rrCNzlist[ServiceSummary]rrkrlrmr%r3r&rrs0            zLimitsClient.list_servicesN) __name__ __module__ __qualname____doc__r'r,r^rprrr%r%r%r&rsX{ !rN) __future__rZ oci._vendorrrocirrZoci.base_clientrZ oci.configrr Z oci.signerr Zoci.utilr r r Zmodelsrr7objectrr%r%r%r&s