a !fA@sdZddlZddlmZddlmZddlmZddlmZddlm Z ddl m Z dd l m Z Gd d d eZGd d d eZdS)zDefine API Topics.N)_datetime_to_rfc3339)_NOW)NotFound)subscription_name_from_path)topic_name_from_path)Policy Subscriptionc@seZdZdZd$ddZd%ddZedd Zed d Z ed d Z ddZ d&ddZ d'ddZ d(ddZddZd)ddZd*ddZd+ddZd,ddZd-d d!Zd.d"d#ZdS)/TopicaTopics are targets to which messages can be published. Subscribers then receive those messages. See: https://cloud.google.com/pubsub/reference/rest/v1/projects.topics :type name: string :param name: the name of the topic :type client: :class:`gcloud.pubsub.client.Client` :param client: A client which holds credentials and project configuration for the topic (which requires a project). :type timestamp_messages: boolean :param timestamp_messages: If true, the topic will add a ``timestamp`` key to the attributes of each published message: the value will be an RFC 3339 timestamp. FcCs||_||_||_dSN)name_clienttimestamp_messages)selfr clientrrT/var/www/html/python-backend/venv/lib/python3.9/site-packages/gcloud/pubsub/topic.py__init__0szTopic.__init__NcCst||||dS)a2Creates a subscription bound to the current topic. Example: pull-mode subcription, default paramter values .. literalinclude:: pubsub_snippets.py :start-after: [START topic_subscription_defaults] :end-before: [END topic_subscription_defaults] Example: pull-mode subcription, override ``ack_deadline`` default .. literalinclude:: pubsub_snippets.py :start-after: [START topic_subscription_ack90] :end-before: [END topic_subscription_ack90] Example: push-mode subcription .. literalinclude:: pubsub_snippets.py :start-after: [START topic_subscription_push] :end-before: [END topic_subscription_push] :type name: string :param name: the name of the subscription :type ack_deadline: int :param ack_deadline: the deadline (in seconds) by which messages pulled from the back-end must be acknowledged. :type push_endpoint: string :param push_endpoint: URL to which messages will be pushed by the back-end. If not set, the application must pull messages. :rtype: :class:`Subscription` :returns: The subscription created with the passed in arguments. ) ack_deadline push_endpointr)rr rrrrr subscription5s$zTopic.subscriptioncCst|d|j}|||dS)a|Factory: construct a topic given its API representation :type resource: dict :param resource: topic resource representation returned from the API :type client: :class:`gcloud.pubsub.client.Client` :param client: Client which holds credentials and project configuration for the topic. :rtype: :class:`gcloud.pubsub.topic.Topic` :returns: Topic parsed from ``resource``. :raises: :class:`ValueError` if ``client`` is not ``None`` and the project from the resource does not agree with the project from the client. r )r)rproject)clsresourcerZ topic_namerrr from_api_repr\szTopic.from_api_reprcCs|jjS)zProject bound to the topic.)r rrrrrrpsz Topic.projectcCsd|j|jfS)z6Fully-qualified name used in topic / subscription APIszprojects/%s/topics/%s)rr rrrr full_nameuszTopic.full_namecCs|dur|j}|S)a}Check client or verify over-ride. :type client: :class:`gcloud.pubsub.client.Client` or ``NoneType`` :param client: the client to use. If not passed, falls back to the ``client`` stored on the current topic. :rtype: :class:`gcloud.pubsub.client.Client` :returns: The client passed in or the currently bound client. N)r rrrrr_require_clientzs zTopic._require_clientcCs"||}|j}|j|jddS)aAPI call: create the topic via a PUT request See: https://cloud.google.com/pubsub/reference/rest/v1/projects.topics/create Example: .. literalinclude:: pubsub_snippets.py :start-after: [START topic_create] :end-before: [END topic_create] :type client: :class:`gcloud.pubsub.client.Client` or ``NoneType`` :param client: the client to use. If not passed, falls back to the ``client`` stored on the current topic. Z topic_pathN)r publisher_apiZ topic_createrrrapirrrcreates z Topic.createcCs@||}|j}z|j|jdWnty6YdS0dSdS)aiAPI call: test for the existence of the topic via a GET request See https://cloud.google.com/pubsub/reference/rest/v1/projects.topics/get Example: .. literalinclude:: pubsub_snippets.py :start-after: [START topic_exists] :end-before: [END topic_exists] :type client: :class:`gcloud.pubsub.client.Client` or ``NoneType`` :param client: the client to use. If not passed, falls back to the ``client`` stored on the current topic. :rtype: bool :returns: Boolean indicating existence of the topic. rFTN)rr Z topic_getrrr!rrrexistss  z Topic.existscCs"||}|j}|j|jddS)a API call: delete the topic via a DELETE request See: https://cloud.google.com/pubsub/reference/rest/v1/projects.topics/delete Example: .. literalinclude:: pubsub_snippets.py :start-after: [START topic_delete] :end-before: [END topic_delete] :type client: :class:`gcloud.pubsub.client.Client` or ``NoneType`` :param client: the client to use. If not passed, falls back to the ``client`` stored on the current topic. rN)rr Z topic_deleterr!rrrdeletes z Topic.deletecCs |jrd|vrtt|d<dS)zAdd a timestamp to ``attrs``, if the topic is so configured. If ``attrs`` already has the key, do nothing. Helper method for ``publish``/``Batch.publish``. timestampN)rrr)rattrsrrr_timestamp_messageszTopic._timestamp_messagecKsL||}|j}||t|d}||d}||j|g}|dS)aAAPI call: publish a message to a topic via a POST request See: https://cloud.google.com/pubsub/reference/rest/v1/projects.topics/publish Example without message attributes: .. literalinclude:: pubsub_snippets.py :start-after: [START topic_publish_simple_message] :end-before: [END topic_publish_simple_message] With message attributes: .. literalinclude:: pubsub_snippets.py :start-after: [START topic_publish_message_with_attrs] :end-before: [END topic_publish_message_with_attrs] :type message: bytes :param message: the message payload :type client: :class:`gcloud.pubsub.client.Client` or ``NoneType`` :param client: the client to use. If not passed, falls back to the ``client`` stored on the current topic. :type attrs: dict (string -> string) :param attrs: key-value pairs to send as message attributes :rtype: str :returns: message ID assigned by the server to the published message asciidata attributesr)rr r(base64 b64encodedecode topic_publishr)rmessagerr'r"Z message_bZ message_data message_idsrrrpublishs   z Topic.publishcCs||}t||S)aReturn a batch to use as a context manager. Example: .. literalinclude:: pubsub_snippets.py :start-after: [START topic_batch] :end-before: [END topic_batch] .. note:: The only API request happens during the ``__exit__()`` of the topic used as a context manager, and only if the block exits without raising an exception. :type client: :class:`gcloud.pubsub.client.Client` or ``NoneType`` :param client: the client to use. If not passed, falls back to the ``client`` stored on the current topic. :rtype: :class:`Batch` :returns: A batch to use as a context manager. )rBatchrrrrbatchs z Topic.batchc CsV||}|j}||j||\}}g}|D] }t||j} |t| |q,||fS)aList subscriptions for the project associated with this client. See: https://cloud.google.com/pubsub/reference/rest/v1/projects.topics.subscriptions/list Example: .. literalinclude:: pubsub_snippets.py :start-after: [START topic_list_subscriptions] :end-before: [END topic_list_subscriptions] :type page_size: int :param page_size: maximum number of topics to return, If not passed, defaults to a value set by the API. :type page_token: string :param page_token: opaque marker for the next "page" of topics. If not passed, the API will return the first page of topics. :type client: :class:`gcloud.pubsub.client.Client` or ``NoneType`` :param client: the client to use. If not passed, falls back to the ``client`` stored on the current topic. :rtype: tuple, (list, str) :returns: list of :class:`gcloud.pubsub.subscription.Subscription`, plus a "next page token" string: if not None, indicates that more topics can be retrieved with another call (pass that value as ``page_token``). )rr Ztopic_list_subscriptionsrrrappendr ) rZ page_sizeZ page_tokenrr"Z sub_pathsZ next_tokenZ subscriptionsZsub_pathZsub_namerrrlist_subscriptionss  zTopic.list_subscriptionscCs&||}|j}||j}t|S)aFetch the IAM policy for the topic. See: https://cloud.google.com/pubsub/reference/rest/v1/projects.topics/getIamPolicy Example: .. literalinclude:: pubsub_snippets.py :start-after: [START topic_get_iam_policy] :end-before: [END topic_get_iam_policy] :type client: :class:`gcloud.pubsub.client.Client` or ``NoneType`` :param client: the client to use. If not passed, falls back to the ``client`` stored on the current batch. :rtype: :class:`gcloud.pubsub.iam.Policy` :returns: policy created from the resource returned by the ``getIamPolicy`` API request. )riam_policy_apiget_iam_policyrrr)rrr"resprrrr9As  zTopic.get_iam_policycCs0||}|j}|}||j|}t|S)a|Update the IAM policy for the topic. See: https://cloud.google.com/pubsub/reference/rest/v1/projects.topics/setIamPolicy Example: .. literalinclude:: pubsub_snippets.py :start-after: [START topic_set_iam_policy] :end-before: [END topic_set_iam_policy] :type policy: :class:`gcloud.pubsub.iam.Policy` :param policy: the new policy, typically fetched via :meth:`get_iam_policy` and updated in place. :type client: :class:`gcloud.pubsub.client.Client` or ``NoneType`` :param client: the client to use. If not passed, falls back to the ``client`` stored on the current batch. :rtype: :class:`gcloud.pubsub.iam.Policy` :returns: updated policy created from the resource returned by the ``setIamPolicy`` API request. )rr8Z to_api_reprset_iam_policyrrr)rpolicyrr"rr:rrrr;Zs  zTopic.set_iam_policycCs"||}|j}||jt|S)a Verify permissions allowed for the current user. See: https://cloud.google.com/pubsub/reference/rest/v1/projects.topics/testIamPermissions Example: .. literalinclude:: pubsub_snippets.py :start-after: [START topic_check_iam_permissions] :end-before: [END topic_check_iam_permissions] :type permissions: list of string :param permissions: list of permissions to be tested :type client: :class:`gcloud.pubsub.client.Client` or ``NoneType`` :param client: the client to use. If not passed, falls back to the ``client`` stored on the current batch. :rtype: sequence of string :returns: subset of ``permissions`` allowed by current IAM policy. )rr8Ztest_iam_permissionsrlist)rZ permissionsrr"rrrcheck_iam_permissionsxs   zTopic.check_iam_permissions)F)NN)N)N)N)N)N)NNN)N)N)N)__name__ __module__ __qualname____doc__rr classmethodrpropertyrrrr#r$r%r(r3r5r7r9r;r>rrrrr s(  '       (  )  r c@sBeZdZdZddZddZddZdd Zd d Zdd dZ d S)r4a2Context manager: collect messages to publish via a single API call. Helper returned by :meth:Topic.batch :type topic: :class:`gcloud.pubsub.topic.Topic` :param topic: the topic being published :type client: :class:`gcloud.pubsub.client.Client` :param client: The client to use. cCs||_g|_g|_||_dSr )topicmessagesr2r)rrErrrrrszBatch.__init__cCs|Sr rrrrr __enter__szBatch.__enter__cCs|dur|dSr )commit)rexc_typeexc_valexc_tbrrr__exit__szBatch.__exit__cCs t|jSr )iterr2rrrr__iter__szBatch.__iter__cKs.|j||jt|d|ddS)zEmulate publishing a message, but save it. :type message: bytes :param message: the message payload :type attrs: dict (string -> string) :param attrs: key-value pairs to send as message attributes r)r*N)rEr(rFr6r-r.r/)rr1r'rrrr3s z Batch.publishNcCsT|js dS|dur|j}|j}||jj|jdd}|j||jdd=dS)a Send saved messages as a single API call. :type client: :class:`gcloud.pubsub.client.Client` or ``NoneType`` :param client: the client to use. If not passed, falls back to the ``client`` stored on the current batch. N)rFrr r0rErr2extend)rrr"r2rrrrHs z Batch.commit)N) r?r@rArBrrGrLrNr3rHrrrrr4s r4)rBr-Zgcloud._helpersrrZgcloud.exceptionsrZgcloud.pubsub._helpersrrZgcloud.pubsub.iamrZgcloud.pubsub.subscriptionr objectr r4rrrrs       z