(ph.+ SrSSKJr SSKrSSKrSSKJr SSKJr \R"SSS5r SS S S S S SSS.r Sr Sr Sr SrSrSr"SS\5r"SS\5rSr\R*"S5SSj5rg)aChannel notifications support. Classes and functions to support channel subscriptions and notifications on those channels. Notes: - This code is based on experimental APIs and is subject to change. - Notification does not do deduplication of notification ids, that's up to the receiver. - Storing the Channel between calls is up to the caller. Example setting up a channel: # Create a new channel that gets notifications via webhook. channel = new_webhook_channel("https://example.com/my_web_hook") # Store the channel, keyed by 'channel.id'. Store it before calling the # watch method because notifications may start arriving before the watch # method returns. ... resp = service.objects().watchAll( bucket="some_bucket_id", body=channel.body()).execute() channel.update(resp) # Store the channel, keyed by 'channel.id'. Store it after being updated # since the resource_id value will now be correct, and that's needed to # stop a subscription. ... An example Webhook implementation using webapp2. Note that webapp2 puts headers in a case insensitive dictionary, as headers aren't guaranteed to always be upper case. id = self.request.headers[X_GOOG_CHANNEL_ID] # Retrieve the channel by id. channel = ... # Parse notification from the headers, including validating the id. n = notification_from_headers(channel, self.request.headers) # Do app specific stuff with the notification here. if n.resource_state == 'sync': # Code to handle sync state. elif n.resource_state == 'exists': # Code to handle the exists state. elif n.resource_state == 'not_exists': # Code to handle the not exists state. Example of unsubscribing. service.channels().stop(channel.body()).execute() )absolute_importN)_helpers)errorsiaddressid expirationparams resource_id resource_uritypetoken)rrr r resourceId resourceUrir rzX-GOOG-CHANNEL-IDzX-GOOG-MESSAGE-NUMBERzX-GOOG-RESOURCE-STATEzX-GOOG-RESOURCE-URIzX-GOOG-RESOURCE-IDc`0nUR5Hup#X1UR5'M U$)N)itemsupper)headers new_headerskvs J/var/www/html/venv/lib/python3.13/site-packages/googleapiclient/channel.py_upper_header_keysrgs-K !"AGGI cH\rSrSrSr\R "S5S5rSrg) NotificationnaA Notification from a Channel. Notifications are not usually constructed directly, but are returned from functions like notification_from_headers(). Attributes: message_number: int, The unique id number of this notification. state: str, The state of the resource being monitored. uri: str, The address of the resource being monitored. resource_id: str, The unique identifier of the version of the resource at this event. c4XlX lX0lX@lg)aONotification constructor. Args: message_number: int, The unique id number of this notification. state: str, The state of the resource being monitored. Can be one of "exists", "not_exists", or "sync". resource_uri: str, The address of the resource being monitored. resource_id: str, The identifier of the watched resource. N)message_numberstater r )selfr r!r r s r__init__Notification.__init__|s- (&r)r r r r!N) __name__ __module__ __qualname____firstlineno____doc__util positionalr#__static_attributes__rrrrns$  __Q ' 'rrc`\rSrSrSr\R "S5S Sj5rSrSr Sr g) ChannelaA Channel for notifications. Usually not constructed directly, instead it is returned from helper functions like new_webhook_channel(). Attributes: type: str, The type of delivery mechanism used by this channel. For example, 'web_hook'. id: str, A UUID for the channel. token: str, An arbitrary string associated with the channel that is delivered to the target address with each event delivered over this channel. address: str, The address of the receiving entity where events are delivered. Specific to the channel type. expiration: int, The time, in milliseconds from the epoch, when this channel will expire. params: dict, A dictionary of string to string, with additional parameters controlling delivery channel behavior. resource_id: str, An opaque id that identifies the resource that is being watched. Stable across different API versions. resource_uri: str, The canonicalized ID of the watched resource. rNc dXlX lX0lX@lXPlX`lXplXlg)a Create a new Channel. In user code, this Channel constructor will not typically be called manually since there are functions for creating channels for each specific type with a more customized set of arguments to pass. Args: type: str, The type of delivery mechanism used by this channel. For example, 'web_hook'. id: str, A UUID for the channel. token: str, An arbitrary string associated with the channel that is delivered to the target address with each event delivered over this channel. address: str, The address of the receiving entity where events are delivered. Specific to the channel type. expiration: int, The time, in milliseconds from the epoch, when this channel will expire. params: dict, A dictionary of string to string, with additional parameters controlling delivery channel behavior. resource_id: str, An opaque id that identifies the resource that is being watched. Stable across different API versions. resource_uri: str, The canonicalized ID of the watched resource. N)r rrrr r r r ) r"r rrrr r r r s rr#Channel.__init__s/F   $ &(rcdURURURURS.nUR(aURUS'UR (aUR US'UR (aUR US'UR(aURUS'U$)zBuild a body from the Channel. Constructs a dictionary that's appropriate for passing into watch() methods as the value of body argument. Returns: A dictionary representation of the channel. )rrr rr rrr )rrr rr r r r )r"results rbody Channel.bodys''ZZII||   ;;#{{F8    #'#3#3F<   $($5$5F= ! ??#'??F<  rc[R5H'up#URU5nUcM[XU5 M) g)aPUpdate a channel with information from the response of watch(). When a request is sent to watch() a resource, the response returned from the watch() request is a dictionary with updated channel information, such as the resource_id, which is needed when stopping a subscription. Args: resp: dict, The response from a watch() method. N)CHANNEL_PARAMSrgetsetattr)r"resp json_name param_namevalues rupdateChannel.updates8&4%9%9%; !IHHY'E %0&r`s8r' ," $1%  !   (//+)'6'>k1fk1\N<!!r