o ɶd9@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)queue_type_mappingZMissingc@sPeZdZdZddZddZddZdd Zd d Zd d Z ddZ ddZ dS) QueueClientz( A description of the Queue API 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 /20210201z2https://messaging.{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_charsqueueretry_strategycircuit_breaker_callback)r getr r r rrZGLOBAL_CIRCUIT_BREAKER_STRATEGYZ DEFAULT_CIRCUIT_BREAKER_STRATEGYrr base_clientrr)selfconfigkwargsrZbase_client_init_kwargsr%:usr/lib/python3.10/site-packages/oci/queue/queue_client.py__init__s>3        zQueueClient.__init__c slddg}d}d}d}d}gdfdd t|D} | r%td | ||d } d d t| D} t| D]\} } | dusOt| tjrVt| dkrVtd| q9dd| dt d} dd t| D} |j j | d|j d}|dur~tj}|rt|tjs|j | ||j|j|j j||| | | d|||d S|j j||| | | d|||dS)a Deletes from the queue the message represented by the receipt. :param str queue_id: (required) unique Queue identifier :param str message_receipt: (required) The receipt of the message retrieved from a GetMessages call. :param str opc_request_id: (optional) The client request ID for tracing. :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_message API. queueIdmessageReceipt+/queues/{queueId}/messages/{messageReceipt}ZDELETEdelete_messagezMhttps://docs.oracle.com/iaas/api/#/en/queue/20210201/GetMessage/DeleteMessagerropc_request_idcg|]}|vr|qSr%r%.0_keyZexpected_kwargsr%r& z.QueueClient.delete_message..z'delete_message got unknown kwargs: {!r}r(r)cSi|] \}}|tur||qSr%missingr0kvr%r%r& z.QueueClient.delete_message..Nr7Parameter {} cannot be None, whitespace or empty stringapplication/jsonr-acceptz content-typezopc-request-idcS&i|]\}}|tur|dur||qSNr7r9r%r%r&r<&rZoperation_retry_strategyZclient_retry_strategyr) resource_pathmethod path_params header_paramsroperation_nameapi_reference_linkrequired_argumentsriterkeys ValueErrorformat iteritems isinstance string_typeslenstripr r8r!get_preferred_retry_strategyrrZDEFAULT_RETRY_STRATEGYNoneRetryStrategyadd_opc_client_retries_headeradd_circuit_breaker_callbackrmake_retrying_callcall_api)r"queue_idmessage_receiptr$rLrFrGrJrK extra_kwargsrHr:r;rIrr%r2r&r+rsn!$     zQueueClient.delete_messagec pdg}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)a Deletes multiple messages from the queue. :param str queue_id: (required) unique Queue identifier :param oci.queue.models.DeleteMessagesDetails delete_messages_details: (required) Details for the messages to delete. :param str opc_request_id: (optional) The client request ID for tracing. :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.queue.models.DeleteMessagesResult` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use delete_messages API. r(z1/queues/{queueId}/messages/actions/deleteMessagesPOSTdelete_messageszNhttps://docs.oracle.com/iaas/api/#/en/queue/20210201/GetMessage/DeleteMessagesr,cr.r%r%r/r2r%r&r3r4z/QueueClient.delete_messages..z(delete_messages got unknown kwargs: {!r}cSr6r%r7r9r%r%r&r< r=z/QueueClient.delete_messages..Nrr>r?r-r@cSrBrCr7r9r%r%r&r<rDrrEZDeleteMessagesResultr rFrGrHrIbody response_typerrJrKrLrM)r"r\Zdelete_messages_detailsr$rLrFrGrJrKr^rHr:r;rIrr%r2r&rat!$     zQueueClient.delete_messagesc sdg}d}d}d}d}gdfddt|D}|r$td |d|i} d d t| D} t| D]\} } | d usMt| tjrTt| d krTtd| q7| dt | dt | dt d} dd t| D} dd| 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 Consumes message from the queue. :param str queue_id: (required) unique Queue identifier :param int visibility_in_seconds: (optional) If the visibilityInSeconds parameter is set, messages will be hidden for visibilityInSeconds seconds and won't be consumable by other consumers during that time. If it isn't set it defaults to the value set at the queue level. The minimum is 0 and the maximum is 43,200 (12 hours). Using a visibilityInSeconds of 0, effectively acts as a peek functionality. Messages retrieved that way, aren't meant to be deleted because they will most likely be delivered to another consumer as their visibility won't change, but will still increase the delivery count by one. :param int timeout_in_seconds: (optional) If the timeoutInSeconds parameter isn't set or set to a value greater than zero, the request is using the long-polling mode and will only return when a message is available for consumption (it does not wait for limit messages but still only returns at-most limit messages) or after timeoutInSeconds seconds (in which case it will return an empty response) whichever comes first. If the parameter is set to zero, the request is using the short-polling mode and immediately returns whether messages have been retrieved or not. In same rare-cases a long-polling request could be interrupted (returned with empty response) before the end of the timeout. The minimum is 0 (long polling disabled), the maximum is 30 seconds and default is 30 seconds. :param int limit: (optional) The limit parameter controls how many messages is returned at-most. The default is 1, the minimum is 1 and the maximum is 32. :param str opc_request_id: (optional) The client request ID for tracing. :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.queue.models.GetMessages` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use get_messages API. r(/queues/{queueId}/messagesGET get_messageszKhttps://docs.oracle.com/iaas/api/#/en/queue/20210201/GetMessage/GetMessages)rrvisibility_in_secondstimeout_in_secondslimitr-cr.r%r%r/r2r%r&r3zr4z,QueueClient.get_messages..z%get_messages got unknown kwargs: {!r}cSr6r%r7r9r%r%r&r<r=z,QueueClient.get_messages..Nrr>rirjrk)ZvisibilityInSecondsZtimeoutInSecondsrkcSrBrCr7r9r%r%r&r<rDr?r-r@cSrBrCr7r9r%r%r&r<rDrrEZ GetMessagesr) rFrGrH query_paramsrIrdrrJrKrLrrNrOrPrQrRrSrTrUr r8r!rVrrrWrXrYrrZr[)r"r\r$rLrFrGrJrKr^rHr:r;rlrIrr%r2r&rh=sz.$        zQueueClient.get_messagesc 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)a Gets the statistics for the queue and its dead letter queue. :param str queue_id: (required) unique Queue identifier :param str opc_request_id: (optional) The client request ID for tracing. :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.queue.models.QueueStats` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use get_stats API. r(z/queues/{queueId}/statsrg get_statszHhttps://docs.oracle.com/iaas/api/#/en/queue/20210201/QueueStats/GetStatsr,cr.r%r%r/r2r%r&r3r4z)QueueClient.get_stats..z"get_stats got unknown kwargs: {!r}cSr6r%r7r9r%r%r&r<r=z)QueueClient.get_stats..Nrr>r?r-r@cSrBrCr7r9r%r%r&r<rDrrEZ QueueStatsr) rFrGrHrIrdrrJrKrLrM)r"r\r$rLrFrGrJrKr^rHr:r;rIrr%r2r&rnsp$     zQueueClient.get_statsc sbdg}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 Puts messages in the queue :param str queue_id: (required) unique Queue identifier :param oci.queue.models.PutMessagesDetails put_messages_details: (required) Details for the messages to publish. :param str opc_request_id: (optional) The client request ID for tracing. :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.queue.models.PutMessages` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use put_messages API. r(rfr` put_messageszKhttps://docs.oracle.com/iaas/api/#/en/queue/20210201/PutMessage/PutMessagesr,cr.r%r%r/r2r%r&r3Hr4z,QueueClient.put_messages..z%put_messages got unknown kwargs: {!r}cSr6r%r7r9r%r%r&r<Qr=z,QueueClient.put_messages..Nrr>r?r-r@cSrBrCr7r9r%r%r&r<\rDrrEZ PutMessagesrrbrm)r"r\Zput_messages_detailsr$rLrFrGrJrKr^rHr:r;rIrr%r2r&rosp!$     zQueueClient.put_messagesc stddg}d}d}d}d} gdfdd t|D} | r%td | ||d } d d t| D} t| D]\} } | dusOt| tjrVt| dkrVtd| q9dd| dt d}dd t|D}|j j | d|j d}|dur~tj}|rt|tjs|j |||j|j|j j||| ||d| d|| |d S|j j||| ||d| d|| |d S)a0 Updates the visibility of the message represented by the receipt. :param str queue_id: (required) unique Queue identifier :param str message_receipt: (required) The receipt of the message retrieved from a GetMessages call. :param oci.queue.models.UpdateMessageDetails update_message_details: (required) Details for the message to update. :param str opc_request_id: (optional) The client request ID for tracing. :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.queue.models.UpdatedMessage` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use update_message API. r(r)r*ZPUTupdate_messagezQhttps://docs.oracle.com/iaas/api/#/en/queue/20210201/UpdatedMessage/UpdateMessager,cr.r%r%r/r2r%r&r3r4z.QueueClient.update_message..z'update_message got unknown kwargs: {!r}r5cSr6r%r7r9r%r%r&r<r=z.QueueClient.update_message..Nrr>r?r-r@cSrBrCr7r9r%r%r&r<rDrrEZUpdatedMessagerrbrM)r"r\r]Zupdate_message_detailsr$rLrFrGrJrKr^rHr:r;rIrr%r2r&rpsv$$     zQueueClient.update_messagec r_)a Updates multiple messages in the queue. :param str queue_id: (required) unique Queue identifier :param oci.queue.models.UpdateMessagesDetails update_messages_details: (required) Details for the messages to update. :param str opc_request_id: (optional) The client request ID for tracing. :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.queue.models.UpdateMessagesResult` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use update_messages API. r(z1/queues/{queueId}/messages/actions/updateMessagesr`update_messageszNhttps://docs.oracle.com/iaas/api/#/en/queue/20210201/GetMessage/UpdateMessagesr,cr.r%r%r/r2r%r&r3r4z/QueueClient.update_messages..z(update_messages got unknown kwargs: {!r}cSr6r%r7r9r%r%r&r<!r=z/QueueClient.update_messages..Nrr>r?r-r@cSrBrCr7r9r%r%r&r<,rDrrEZUpdateMessagesResultrrbrM)r"r\Zupdate_messages_detailsr$rLrFrGrJrKr^rHr:r;rIrr%r2r&rqrezQueueClient.update_messagesN) __name__ __module__ __qualname____doc__r'r+rarhrnrorprqr%r%r%r&rsXdg|be krN) __future__rZ oci._vendorrrocirrZoci.base_clientrZ oci.configrr Z oci.signerr Zoci.utilr r r Zmodelsrr8objectrr%r%r%r&s