MBSSKJr SSKrSSKrSSKrSSKrSSKrSSKJrJ r SSK J r SSK J r SSKJr \R (aSSKrSSKrSSKJr SSKJr S r\ R."5r\R3\R45 SS \S \S \4S jjr"SS\5rg))absolute_importN)OptionalCallable)requests)futures)AcknowledgeStatus)types) containersz@Message {{ data: {!r} ordering_key: {!r} attributes: {} }}linesprefixreturnc~/nURS5HnURX-5 M SRU5$)aIndent some text. Note that this is present as ``textwrap.indent``, but not in Python 2. Args: lines: The newline delimited string to be indented. prefix: The prefix to indent each line with. Defaults to two spaces. Returns: The newly indented content.  )splitappendjoin)r r indentedlines Message.`srmessageztypes.PubsubMessage._meta._pback_iddelivery_attempt request_queuez queue.Queue"exactly_once_delivery_enabled_funcc XlX lUS:aUOSUlX@lXPlUR Ul[ R "5UlURUl URUl [RRURR URR"S- -[R$R&S9UlUR*UlUR/5Ulg)a\Construct the Message. .. note:: This class should not be constructed directly; it is the responsibility of :class:`BasePolicy` subclasses to do so. Args: message (types.PubsubMessage._meta._pb): The message received from Pub/Sub. For performance reasons it should be the raw protobuf message normally wrapped by :class:`~pubsub_v1.types.PubsubMessage`. A raw message can be obtained from a :class:`~pubsub_v1.types.PubsubMessage` instance through the latter's ``._pb`` attribute. ack_id (str): The ack_id received from Pub/Sub. delivery_attempt (int): The delivery attempt counter received from Pub/Sub if a DeadLetterPolicy is set on the subscription, and zero otherwise. request_queue (queue.Queue): A queue provided by the policy that can accept requests; the policy is responsible for handling those requests. exactly_once_delivery_enabled_func (Callable[[], bool]): A Callable that returns whether exactly-once delivery is currently-enabled. Defaults to a lambda that always returns False. rNgeA)tz)_message_ack_id_delivery_attempt_request_queue#_exactly_once_delivery_enabled_func message_idtime_received_timestamp attributes _attributesdata_datadtdatetime fromtimestamp publish_timesecondsnanostimezoneutc _publish_time ordering_key _ordering_keyByteSize_size)selfrr r!r"r#s r__init__Message.__init__ZsB  5E5I!1t+3U0!,, $(99; #--\\ [[66  ( (7+?+?+E+E+K K{{7 %11%%' rc:URRn[U5S:aUSSS-n[R"[ UR 5SSSS9n[U5nUR5n[RU[UR5U5$)N2s...),z: T)indent separators sort_keys) r&r0lenjsondumpsdictr.rlstrip _MESSAGE_REPRformatstrr;)r? abbv_data pretty_attrss r__repr__Message.__repr__sMM&& y>B !#2/Izz  !! t |, #**, ##Is43D3D/E|TTrr cUR$)aXReturn the attributes of the underlying Pub/Sub Message. .. warning:: A ``ScalarMap`` behaves slightly differently than a ``dict``. For a Pub / Sub message this is a ``string->string`` map. When trying to access a value via ``map['key']``, if the key is not in the map, then the default value for the string type will be returned, which is an empty string. It may be more intuitive to just cast the map to a ``dict`` or to one use ``map.get``. Returns: containers.ScalarMap: The message's attributes. This is a ``dict``-like object provided by ``google.protobuf``. )r/r?s rr.Message.attributess"rcUR$)zReturn the data for the underlying Pub/Sub Message. Returns: bytes: The message data. This is always a bytestring; if you want a text string, call :meth:`bytes.decode`. )r1rVs rr0 Message.dataszzrcUR$)zReturn the time that the message was originally published. Returns: datetime.datetime: The date and time that the message was published. )r:rVs rr5Message.publish_times!!!rcUR$)z-The ordering key used to publish the message.)r<rVs rr;Message.ordering_keys!!!rcUR$)z4Return the size of the underlying message, in bytes.)r>rVs rsize Message.sizeszzrcUR$)zthe ID used to ack the message.)r'rVs rr Message.ack_ids||rcUR$)aThe delivery attempt counter is 1 + (the sum of number of NACKs and number of ack_deadline exceeds) for this message. It is set to None if a DeadLetterPolicy is not set on the subscription. A NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline exceeds event is whenever a message is not acknowledged within ack_deadline. Note that ack_deadline is initially Subscription.ackDeadlineSeconds, but may get extended automatically by the client library. The first delivery of a given message will have this value as 1. The value is calculated at best effort and is approximate. Returns: Optional[int]: The delivery attempt counter or ``None``. )r(rVs rr!Message.delivery_attempts$%%%rNc [R"[R"5UR- 5nURR [ R"URURUURSS95 g)aAcknowledge the given message. Acknowledging a message in Pub/Sub means that you are done with it, and it will not be delivered to this subscription again. You should avoid acknowledging messages until you have *finished* processing them, so that in the event of a failure, you receive the message again. .. warning:: Acks in Pub/Sub are best effort. You should always ensure that your processing code is idempotent, as you may receive any given message more than once. If you need strong guarantees about acks and re-deliveres, enable exactly-once delivery on your subscription and use the `ack_with_response` method instead. Exactly once delivery is a preview feature. For more details, see: https://cloud.google.com/pubsub/docs/exactly-once-delivery." Nr byte_size time_to_ackr;future) mathceilr,r-r)putr AckRequestr'r_r;)r?rhs rack Message.acksb(ii d.F.F FG     ||))'!..   rfutures.Futurec zUR5(a[R"5nUnO[nSn[R "[ R "5UR- 5nURR[R"URURUURUS95 U$)aAcknowledge the given message. Acknowledging a message in Pub/Sub means that you are done with it, and it will not be delivered to this subscription again. You should avoid acknowledging messages until you have *finished* processing them, so that in the event of a failure, you receive the message again. If exactly-once delivery is NOT enabled on the subscription, the future returns immediately with an AcknowledgeStatus.SUCCESS. Since acks in Cloud Pub/Sub are best effort when exactly-once delivery is disabled, the message may be re-delivered. Because re-deliveries are possible, you should ensure that your processing code is idempotent, as you may receive any given message more than once. If exactly-once delivery is enabled on the subscription, the future returned by this method tracks the state of acknowledgement operation. If the future completes successfully, the message is guaranteed NOT to be re-delivered. Otherwise, the future will contain an exception with more details about the failure and the message may be re-delivered. Exactly once delivery is a preview feature. For more details, see https://cloud.google.com/pubsub/docs/exactly-once-delivery." Returns: futures.Future: A :class:`~google.cloud.pubsub_v1.subscriber.futures.Future` instance that conforms to Python Standard library's :class:`~concurrent.futures.Future` interface (but not an instance of that class). Call `result()` to get the result of the operation; upon success, a pubsub_v1.subscriber.exceptions.AcknowledgeStatus.SUCCESS will be returned and upon an error, an pubsub_v1.subscriber.exceptions.AcknowledgeError exception will be thrown. Nrf)r*rFuture_SUCCESS_FUTURErjrkr,r-r)rlrrmr'r_r;)r?ri req_futurerhs rack_with_responseMessage.ack_with_response sP  3 3 5 5^^%FJ$FJii d.F.F FG     ||))'!..!    rcURR[R"URUR UR S95 g)aRelease the message from lease management. This informs the policy to no longer hold on to the lease for this message. Pub/Sub will re-deliver the message if it is not acknowledged before the existing lease expires. .. warning:: For most use cases, the only reason to drop a message from lease management is on `ack` or `nack`; this library automatically drop()s the message on `ack` or `nack`. You probably do not want to call this method directly. )r rgr;N)r)rlr DropRequestr'r_r;rVs rdrop Message.dropDs;   ||tyytGXGX  rr6cvURR[R"URUSS95 g)a>Resets the deadline for acknowledgement. New deadline will be the given value of seconds from now. The default implementation handles automatically modacking received messages for you; you should not need to manually deal with setting ack deadlines. The exception case is if you are implementing your own custom subclass of :class:`~.pubsub_v1.subcriber._consumer.Consumer`. Args: seconds (int): The number of seconds to set the lease deadline to. This should be between 0 and 600. Due to network latency, values below 10 are advised against. Nr r6ri)r)rlr ModAckRequestr')r?r6s rmodify_ack_deadlineMessage.modify_ack_deadlineWs/   " "$,,PT U rcUR5(a[R"5nUnO[nSnURR [ R"URXS95 U$)aResets the deadline for acknowledgement and returns the response status via a future. New deadline will be the given value of seconds from now. The default implementation handles automatically modacking received messages for you; you should not need to manually deal with setting ack deadlines. The exception case is if you are implementing your own custom subclass of :class:`~.pubsub_v1.subcriber._consumer.Consumer`. If exactly-once delivery is NOT enabled on the subscription, the future returns immediately with an AcknowledgeStatus.SUCCESS. Since modify-ack-deadline operations in Cloud Pub/Sub are best effort when exactly-once delivery is disabled, the message may be re-delivered within the set deadline. If exactly-once delivery is enabled on the subscription, the future returned by this method tracks the state of the modify-ack-deadline operation. If the future completes successfully, the message is guaranteed NOT to be re-delivered within the new deadline. Otherwise, the future will contain an exception with more details about the failure and the message will be redelivered according to its currently-set ack deadline. Exactly once delivery is a preview feature. For more details, see https://cloud.google.com/pubsub/docs/exactly-once-delivery." Args: seconds (int): The number of seconds to set the lease deadline to. This should be between 0 and 600. Due to network latency, values below 10 are advised against. Returns: futures.Future: A :class:`~google.cloud.pubsub_v1.subscriber.futures.Future` instance that conforms to Python Standard library's :class:`~concurrent.futures.Future` interface (but not an instance of that class). Call `result()` to get the result of the operation; upon success, a pubsub_v1.subscriber.exceptions.AcknowledgeStatus.SUCCESS will be returned and upon an error, an pubsub_v1.subscriber.exceptions.AcknowledgeError exception will be thrown. Nr|) r*rrrrsr)rlrr}r')r?r6rirts r!modify_ack_deadline_with_response)Message.modify_ack_deadline_with_responseksa^  3 3 5 5^^%FJ$FJ   " "||W   rc URR[R"URUR UR SS95 g)zDecline to acknowledge the given message. This will cause the message to be re-delivered to subscribers. Re-deliveries may take place immediately or after a delay, and may arrive at this subscriber or another. Nr rgr;ri)r)rlr NackRequestr'r_r;rVs rnack Message.nacks@   ||))!..   rc  UR5(a[R"5nUnO[nSnURR [ R"URURURUS95 U$)a0Decline to acknowledge the given message, returning the response status via a future. This will cause the message to be re-delivered to subscribers. Re-deliveries may take place immediately or after a delay, and may arrive at this subscriber or another. If exactly-once delivery is NOT enabled on the subscription, the future returns immediately with an AcknowledgeStatus.SUCCESS. If exactly-once delivery is enabled on the subscription, the future returned by this method tracks the state of the nack operation. If the future completes successfully, the future's result will be an AcknowledgeStatus.SUCCESS. Otherwise, the future will contain an exception with more details about the failure. Exactly once delivery is a preview feature. For more details, see https://cloud.google.com/pubsub/docs/exactly-once-delivery." Returns: futures.Future: A :class:`~google.cloud.pubsub_v1.subscriber.futures.Future` instance that conforms to Python Standard library's :class:`~concurrent.futures.Future` interface (but not an instance of that class). Call `result()` to get the result of the operation; upon success, a pubsub_v1.subscriber.exceptions.AcknowledgeStatus.SUCCESS will be returned and upon an error, an pubsub_v1.subscriber.exceptions.AcknowledgeError exception will be thrown. Nr) r*rrrrsr)rlrrr'r_r;)r?rirts rnack_with_responseMessage.nack_with_responsesrF  3 3 5 5^^%FJ$FJ   ||))!..!    r) r'r/r1r(r*r&r<r:r-r)r>r+)r zcontainers.ScalarMap)r zdatetime.datetime)r N)r rp)__name__ __module__ __qualname____firstlineno____doc__rPintrboolr@rSpropertyr.bytesr0r5r;r_r rr!rnruryr~rrr__static_attributes__rrrrrCsH8BO 7(07(7( 7( % 7( -5RX,> 7(r U  $e"""c""c&(3-&&& >8t & 3 4 (<<AQ<| 3rr)z ) __future__rr3r2rJrjr,typingrr+google.cloud.pubsub_v1.subscriber._protocolr!google.cloud.pubsub_v1.subscriberr,google.cloud.pubsub_v1.subscriber.exceptionsr TYPE_CHECKINGqueuegoogle.cloud.pubsub_v1r !cloudsdk.google.protobuf.internalr rNrrrs set_resultSUCCESSrProbjectrrrrrs' %@5J ,< ..",4453s(ifir