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)events_type_mappingZMissingc@sHeZdZdZddZddZddZdd Zd d Zd d Z ddZ dS) EventsClientz API for the Events Service. Use this API to manage rules and actions that create automation in your tenancy. For more information, see [Overview of Events](/iaas/Content/Events/Concepts/eventsoverview.htm). 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_endpointz /20181201z/https://events.{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_charseventsretry_strategycircuit_breaker_callback)r getr r r rrZGLOBAL_CIRCUIT_BREAKER_STRATEGYZ DEFAULT_CIRCUIT_BREAKER_STRATEGYrr base_clientrr)selfconfigkwargsrZbase_client_init_kwargsr%3        zEventsClient.__init__c s~dg}d}d}d}d}gdfddt|D} | r$td | d|i} d d t| D} t| D]\} } | d usMt| tjrTt| d krTtd| q7dd| dt | dt | dt d} dd t| D} |j j | d|j d}|rt|tjs|j | |j | ||j|j|j j||| | || d|||d S|j j||| | || d|||d S)a Moves a rule into a different compartment within the same tenancy. For information about moving resources between compartments, see `Moving Resources to a Different Compartment`__. __ https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes :param str rule_id: (required) The `OCID`__ of this rule. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm :param oci.events.models.ChangeRuleCompartmentDetails change_rule_compartment_details: (required) :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 will be updated or deleted only if the etag you provide matches the resource's current etag value. :param str opc_request_id: (optional) The 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 (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may 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 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 None :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use change_rule_compartment API. ruleIdz)/rules/{ruleId}/actions/changeCompartmentPOSTchange_rule_compartmentzPhttps://docs.oracle.com/iaas/api/#/en/events/20181201/Rule/ChangeRuleCompartment)rrif_matchopc_request_idopc_retry_tokencg|]}|vr|qSr%r%.0_keyZexpected_kwargsr%r& z8EventsClient.change_rule_compartment..z0change_rule_compartment got unknown kwargs: {!r}cSi|] \}}|tur||qSr%missingr0kvr%r%r& z8EventsClient.change_rule_compartment..Nr7Parameter {} cannot be None, whitespace or empty stringapplication/jsonr+r,r-)accept content-typeif-matchopc-request-idopc-retry-tokencS&i|]\}}|tur|dur||qSNr6r8r%r%r&r;&rZoperation_retry_strategyZclient_retry_strategyr) resource_pathmethod path_params header_paramsbodyroperation_nameapi_reference_linkrequired_arguments)riterkeys ValueErrorformat iteritems isinstance string_typeslenstripr r7r!get_preferred_retry_strategyrrNoneRetryStrategyadd_opc_retry_token_if_neededadd_opc_client_retries_headeradd_circuit_breaker_callbackrmake_retrying_callcall_api)r"rule_idZchange_rule_compartment_detailsr$rOrHrIrMrN extra_kwargsrJr9r:rKrr%r2r&r*ssr2$        z$EventsClient.change_rule_compartmentc sg}d}d}d}d}gdfddt|D}|r#td|d d |d t|d td } d dt| D} |jj|d|j d} | rvt | t j sb|j | |j| | |j| j|jj||| |d|d|||d S|jj||| |d|d|||d S)a Creates a new rule. :param oci.events.models.CreateRuleDetails create_rule_details: (required) Specification of the rule to create :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 (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). :param str opc_request_id: (optional) The 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 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.events.models.Rule` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use create_rule API. /rulesr) create_rulezEhttps://docs.oracle.com/iaas/api/#/en/events/20181201/Rule/CreateRule)rrr-r,cr.r%r%r/r2r%r&r3r4z,EventsClient.create_rule..z$create_rule got unknown kwargs: {!r}r>r-r,)r?r@rCrBcSrDrEr6r8r%r%r&r;*rFz,EventsClient.create_rule..rrGRuler) rHrIrKrL response_typerrMrNrO)rrPrQrRr r7rSr!rXrrTrrYrZr[r\rr]r^) r"Zcreate_rule_detailsr$rOrHrIrMrNr`rKrr%r2r&rbsb&       zEventsClient.create_rulec sddg}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 S|j j||| | | d|||dS)aZ Deletes a rule. :param str rule_id: (required) The `OCID`__ of this rule. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm :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 will be updated or deleted only if the etag you provide matches the resource's current etag value. :param str opc_request_id: (optional) The 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 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 None :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use delete_rule API. r(/rules/{ruleId}ZDELETE delete_rulezEhttps://docs.oracle.com/iaas/api/#/en/events/20181201/Rule/DeleteRulerrr+r,cr.r%r%r/r2r%r&r3r4z,EventsClient.delete_rule..z$delete_rule got unknown kwargs: {!r}cSr5r%r6r8r%r%r&r;r<z,EventsClient.delete_rule..Nrr=r>r+r,r?r@rArBcSrDrEr6r8r%r%r&r;rFrrGr)rHrIrJrKrrMrNrOrrPrQrRrSrTrUrVrWr r7r!rXrrrYr[r\rr]r^r"r_r$rOrHrIrMrNr`rJr9r:rKrr%r2r&rfMsj&$      zEventsClient.delete_rulec s^dg}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} | rt| tjs|j | | |j| j|j j||| | d| d|||d S|j j||| | d| d|||d S)a Retrieves a rule. :param str rule_id: (required) The `OCID`__ of this rule. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm :param str opc_request_id: (optional) The 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 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.events.models.Rule` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use get_rule API. r(reGETget_rulezBhttps://docs.oracle.com/iaas/api/#/en/events/20181201/Rule/GetRule)rrr,cr.r%r%r/r2r%r&r3r4z)EventsClient.get_rule..z!get_rule got unknown kwargs: {!r}cSr5r%r6r8r%r%r&r;r<z)EventsClient.get_rule..Nrr=r>r,r?r@rBcSrDrEr6r8r%r%r&r;rFrrGrcr) rHrIrJrKrdrrMrNrOrirjr%r2r&rlsl!$     zEventsClient.get_rulec sdg}d}d}d}d}gdfddt|D}|r$td |d |vr9gd } |d | vr9td | d |vrNgd} |d | vrNtd| d|vrcddg} |d| vrctd| ||dt|dt|d t|dt|d t|dtd} ddt| D} dd|dtd} ddt| D} |jj|d|j d}|rt |t j s|j | ||j|j|jj||| | d |d!|||d" S|jj||| | d |d!|||d" S)#a Lists rules for this compartment. :param str compartment_id: (required) The `OCID`__ of the compartment to which this rule belongs. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm :param int limit: (optional) The maximum number of items to return. 1 is the minimum, 50 is the maximum. Default: 10 :param str page: (optional) For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see `List Pagination`__. __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine :param str lifecycle_state: (optional) A filter to return only rules that match the lifecycle state in this parameter. Example: `Creating` Allowed values are: "CREATING", "ACTIVE", "INACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED" :param str display_name: (optional) A filter to return only rules with descriptions that match the displayName string in this parameter. Example: `"This rule sends a notification upon completion of DbaaS backup."` :param str sort_by: (optional) Specifies the attribute with which to sort the rules. Default: `timeCreated` * **TIME_CREATED:** Sorts by timeCreated. * **DISPLAY_NAME:** Sorts by displayName. * **ID:** Sorts by id. Allowed values are: "TIME_CREATED", "ID", "DISPLAY_NAME" :param str sort_order: (optional) Specifies sort order. * **ASC:** Ascending sort order. * **DESC:** Descending sort order. Allowed values are: "ASC", "DESC" :param str opc_request_id: (optional) The 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 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 list of :class:`~oci.events.models.RuleSummary` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use list_rules API. compartmentIdrark list_ruleszKhttps://docs.oracle.com/iaas/api/#/en/events/20181201/RuleSummary/ListRules) rrlimitpagelifecycle_state display_namesort_by sort_orderr,cr.r%r%r/r2r%r&r3vr4z+EventsClient.list_rules..z#list_rules got unknown kwargs: {!r}rr)ZCREATINGZACTIVEZINACTIVEZUPDATINGZDELETINGZDELETEDZFAILEDz7Invalid value for `lifecycle_state`, must be one of {0}rt)Z TIME_CREATEDIDZ DISPLAY_NAMEz/Invalid value for `sort_by`, must be one of {0}ruZASCZDESCz2Invalid value for `sort_order`, must be one of {0}rprqrs)rnrprqZlifecycleStateZ displayNameZsortByZ sortOrdercSrDrEr6r8r%r%r&r;rFz+EventsClient.list_rules..r>r,rmcSrDrEr6r8r%r%r&r;rFrrGzlist[RuleSummary]r) rHrI query_paramsrKrdrrMrNrO)rrPrQrRr r7rSr!rXrrTrrYr[r\rr]r^)r"Zcompartment_idr$rOrHrIrMrNr`Zlifecycle_state_allowed_valuesZsort_by_allowed_valuesZsort_order_allowed_valuesrwrKrr%r2r&rosL                zEventsClient.list_rulesc sldg}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)a Updates a rule. :param str rule_id: (required) The `OCID`__ of this rule. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm :param oci.events.models.UpdateRuleDetails update_rule_details: (required) The new rule spec to apply :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 will be updated or deleted only if the etag you provide matches the resource's current etag value. :param str opc_request_id: (optional) The 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 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.events.models.Rule` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use update_rule API. r(reZPUT update_rulezEhttps://docs.oracle.com/iaas/api/#/en/events/20181201/Rule/UpdateRulergcr.r%r%r/r2r%r&r3r4z,EventsClient.update_rule..z$update_rule got unknown kwargs: {!r}cSr5r%r6r8r%r%r&r;r<z,EventsClient.update_rule..Nrr=r>r+r,rhcSrDrEr6r8r%r%r&r; rFrrGrcr) rHrIrJrKrLrdrrMrNrOri)r"r_Zupdate_rule_detailsr$rOrHrIrMrNr`rJr9r:rKrr%r2r&rxsr)$      zEventsClient.update_ruleN) __name__ __module__ __qualname____doc__r'r*rbrfrlrorxr%r%r%r&rsXyahc +rN) __future__rZ oci._vendorrrocirrZoci.base_clientrZ oci.configrr Z oci.signerr Zoci.utilr r r Zmodelsrr7objectrr%r%r%r&s