a !fP@sjdZddlZddlmZddlmZGdddejZGddde Z Gd d d e Z Gd d d e Z dS) z1Create / interact with gcloud pubsub connections.N) connection)PUBSUB_EMULATORcs@eZdZdZdZdZdZdZd fdd Zd fd d Z Z S) Connectiona"A connection to Google Cloud Pubsub via the JSON REST API. :type credentials: :class:`oauth2client.client.OAuth2Credentials` :param credentials: (Optional) The OAuth2 Credentials to use for this connection. :type http: :class:`httplib2.Http` or class that defines ``request()``. :param http: (Optional) HTTP object to make requests. :type api_base_url: string :param api_base_url: The base of the API call URL. Defaults to the value :attr:`Connection.API_BASE_URL`. zhttps://pubsub.googleapis.comZv1z"{api_base_url}/{api_version}{path})z&https://www.googleapis.com/auth/pubsubz.https://www.googleapis.com/auth/cloud-platformNcsJtt|j||d|dur@tt}|dur8|jj}nd|}||_dS)N) credentialshttpzhttp://) superr__init__osgetenvr __class__ API_BASE_URL api_base_url)selfrrr Z emulator_hostr Y/var/www/html/python-backend/venv/lib/python3.9/site-packages/gcloud/pubsub/connection.pyr3s  zConnection.__init__cs(|dur|j}tt|jj||||dS)aConstruct an API url given a few components, some optional. Typically, you shouldn't need to use this method. :type path: string :param path: The path to the resource. :type query_params: dict or list :param query_params: A dictionary of keys and values (or list of key-value pairs) to insert into the query string of the URL. :type api_base_url: string :param api_base_url: The base URL for the API endpoint. Typically you won't have to provide this. :type api_version: string :param api_version: The version of the API to call. Typically you shouldn't provide this and instead use the default for the library. :rtype: string :returns: The URL assembled from the pieces provided. N) query_paramsr api_version)r rrr build_api_url)rpathrr rrrrr=s  zConnection.build_api_url)NNN)NNN) __name__ __module__ __qualname____doc__r Z API_VERSIONZAPI_URL_TEMPLATEZSCOPErr __classcell__rrrrrs rc@sLeZdZdZddZdddZddZd d Zd d Zd dZ dddZ dS) _PublisherAPIzHelper mapping publisher-related APIs. :type connection: :class:`Connection` :param connection: the connection used to make API requests. cCs ||_dSN _connectionrrrrrresz_PublisherAPI.__init__NcCsZ|j}i}|dur||d<|dur*||d<d|f}|jd||d}|dd|d fS) axAPI call: list topics for a given project See: https://cloud.google.com/pubsub/reference/rest/v1/projects.topics/list :type project: string :param project: project ID :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. :rtype: tuple, (list, str) :returns: list of ``Topic`` resource dicts, 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``). NpageSize pageTokenz/projects/%s/topicsGETmethodrrZtopicsr nextPageTokenr api_requestgetrproject page_size page_tokenconnparamsrresprrr list_topicshs z_PublisherAPI.list_topicscCs|j}|jdd|fdS)aAPI call: create a topic See: https://cloud.google.com/pubsub/reference/rest/v1/projects.topics/create :type topic_path: string :param topic_path: the fully-qualified path of the new topic, in format ``projects//topics/``. :rtype: dict :returns: ``Topic`` resource returned from the API. PUT/%sr$rrr'r topic_pathr-rrr topic_creates z_PublisherAPI.topic_createcCs|j}|jdd|fdS)aAPI call: retrieve a topic See: https://cloud.google.com/pubsub/reference/rest/v1/projects.topics/get :type topic_path: string :param topic_path: the fully-qualified path of the topic, in format ``projects//topics/``. :rtype: dict :returns: ``Topic`` resource returned from the API. r"r2r3r4r5rrr topic_gets z_PublisherAPI.topic_getcCs|j}|jdd|fddS)a6API call: delete a topic See: https://cloud.google.com/pubsub/reference/rest/v1/projects.topics/delete :type topic_path: string :param topic_path: the fully-qualified path of the topic, in format ``projects//topics/``. DELETEr2r3Nr4r5rrr topic_deletes z_PublisherAPI.topic_deletecCs,|j}d|i}|jdd|f|d}|dS)aAPI call: publish one or more messages to a topic See: https://cloud.google.com/pubsub/reference/rest/v1/projects.topics/publish :type topic_path: string :param topic_path: the fully-qualified path of the topic, in format ``projects//topics/``. :type messages: list of dict :param messages: messages to be published. :rtype: list of string :returns: list of opaque IDs for published messages. messagesPOSTz /%s:publishr$rdataZ messageIdsr4)rr6r;r-r>responserrr topic_publishs  z_PublisherAPI.topic_publishcCsZ|j}i}|dur||d<|dur*||d<d|f}|jd||d}|dd|d fS) ahAPI call: list subscriptions bound to a topic See: https://cloud.google.com/pubsub/reference/rest/v1/projects.topics.subscriptions/list :type topic_path: string :param topic_path: the fully-qualified path of the topic, in format ``projects//topics/``. :type page_size: int :param page_size: maximum number of subscriptions 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. :rtype: list of strings :returns: fully-qualified names of subscriptions for the supplied topic. Nr r!z/%s/subscriptionsr"r# subscriptionsrr%r&)rr6r+r,r-r.rr/rrrtopic_list_subscriptionss z&_PublisherAPI.topic_list_subscriptions)NN)NN) rrrrrr0r7r8r:r@rBrrrrr^s % rc@s^eZdZdZddZdddZdddZd d Zd d Zd dZ dddZ ddZ ddZ dS)_SubscriberAPIzHelper mapping subscriber-related APIs. :type connection: :class:`Connection` :param connection: the connection used to make API requests. cCs ||_dSrrrrrrrsz_SubscriberAPI.__init__NcCsZ|j}i}|dur||d<|dur*||d<d|f}|jd||d}|dd|d fS) aAPI call: list subscriptions for a given project See: https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/list :type project: string :param project: project ID :type page_size: int :param page_size: maximum number of subscriptions 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 subscriptions. If not passed, the API will return the first page of subscriptions. :rtype: tuple, (list, str) :returns: list of ``Subscription`` resource dicts, plus a "next page token" string: if not None, indicates that more subscriptions can be retrieved with another call (pass that value as ``page_token``). Nr r!z/projects/%s/subscriptionsr"r#rArr%r&r)rrrlist_subscriptionss z!_SubscriberAPI.list_subscriptionscCsL|j}d|f}d|i}|dur(||d<|dur/subscriptions/``. :type topic_path: string :param topic_path: the fully-qualified path of the topic being subscribed, in format ``projects//topics/``. :type ack_deadline: int, or ``NoneType`` :param ack_deadline: the deadline (in seconds) by which messages pulled from the back-end must be acknowledged. :type push_endpoint: string, or ``NoneType`` :param push_endpoint: URL to which messages will be pushed by the back-end. If not set, the application must pull messages. :rtype: dict :returns: ``Subscription`` resource returned from the API. r2ZtopicNackDeadlineSeconds pushEndpoint pushConfigr1r=r4)rsubscription_pathr6 ack_deadline push_endpointr-rresourcerrrsubscription_create%s  z"_SubscriberAPI.subscription_createcCs|j}d|f}|jd|dS)aAPI call: retrieve a subscription See: https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/get :type subscription_path: string :param subscription_path: the fully-qualified path of the subscription, in format ``projects//subscriptions/``. :rtype: dict :returns: ``Subscription`` resource returned from the API. r2r"r3r4rrHr-rrrrsubscription_getNs z_SubscriberAPI.subscription_getcCs"|j}d|f}|jd|ddS)aAPI call: delete a subscription See: https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/delete :type subscription_path: string :param subscription_path: the fully-qualified path of the subscription, in format ``projects//subscriptions/``. r2r9r3Nr4rMrrrsubscription_delete`s  z"_SubscriberAPI.subscription_deletecCs0|j}d|f}dd|ii}|jd||ddS)aAPI call: update push config of a subscription See: https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/modifyPushConfig :type subscription_path: string :param subscription_path: the fully-qualified path of the new subscription, in format ``projects//subscriptions/``. :type push_endpoint: string, or ``NoneType`` :param push_endpoint: URL to which messages will be pushed by the back-end. If not set, the application must pull messages. z/%s:modifyPushConfigrGrFr<r=Nr4)rrHrJr-rrKrrrsubscription_modify_push_configos  z._SubscriberAPI.subscription_modify_push_configFcCs6|j}d|f}||d}|jd||d}|ddS)aAPI call: retrieve messages for a subscription See: https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/modifyPushConfig :type subscription_path: string :param subscription_path: the fully-qualified path of the new subscription, in format ``projects//subscriptions/``. :type return_immediately: boolean :param return_immediately: if True, the back-end returns even if no messages are available; if False, the API call blocks until one or more messages are available. :type max_messages: int :param max_messages: the maximum number of messages to return. :rtype: list of dict :returns: the ``receivedMessages`` element of the response. z/%s:pull)ZreturnImmediatelyZ maxMessagesr<r=ZreceivedMessagesrr&)rrHZreturn_immediatelyZ max_messagesr-rr>r?rrrsubscription_pulls z _SubscriberAPI.subscription_pullcCs,|j}d|f}d|i}|jd||ddS)aAPI call: acknowledge retrieved messages See: https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/modifyPushConfig :type subscription_path: string :param subscription_path: the fully-qualified path of the new subscription, in format ``projects//subscriptions/``. :type ack_ids: list of string :param ack_ids: ack IDs of messages being acknowledged z/%s:acknowledgeackIdsr<r=Nr4)rrHack_idsr-rr>rrrsubscription_acknowledges  z'_SubscriberAPI.subscription_acknowledgecCs.|j}d|f}||d}|jd||ddS)aAPI call: update ack deadline for retrieved messages See: https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/modifyAckDeadline :type subscription_path: string :param subscription_path: the fully-qualified path of the new subscription, in format ``projects//subscriptions/``. :type ack_ids: list of string :param ack_ids: ack IDs of messages being acknowledged :type ack_deadline: int :param ack_deadline: the deadline (in seconds) by which messages pulled from the back-end must be acknowledged. z/%s:modifyAckDeadline)rSrEr<r=Nr4)rrHrTrIr-rr>rrr subscription_modify_ack_deadlines  z/_SubscriberAPI.subscription_modify_ack_deadline)NN)NN)FrQ) rrrrrrDrLrNrOrPrRrUrVrrrrrCs & ) !rCc@s0eZdZdZddZddZddZdd Zd S) _IAMPolicyAPIzHelper mapping IAM policy-related APIs. :type connection: :class:`Connection` :param connection: the connection used to make API requests. cCs ||_dSrrrrrrrsz_IAMPolicyAPI.__init__cCs|j}d|f}|jd|dS)aAPI call: fetch the IAM policy for the target See: https://cloud.google.com/pubsub/reference/rest/v1/projects.topics/getIamPolicy https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/getIamPolicy :type target_path: string :param target_path: the path of the target object. :rtype: dict :returns: the resource returned by the ``getIamPolicy`` API request. z/%s:getIamPolicyr"r3r4)r target_pathr-rrrrget_iam_policys  z_IAMPolicyAPI.get_iam_policycCs(|j}d|i}d|f}|jd||dS)aAPI call: update the IAM policy for the target See: https://cloud.google.com/pubsub/reference/rest/v1/projects.topics/setIamPolicy https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/setIamPolicy :type target_path: string :param target_path: the path of the target object. :type policy: dict :param policy: the new policy resource. :rtype: dict :returns: the resource returned by the ``setIamPolicy`` API request. policyz/%s:setIamPolicyr<r=r4)rrXrZr-wrappedrrrrset_iam_policys z_IAMPolicyAPI.set_iam_policycCs4|j}d|i}d|f}|jd||d}|dgS)aAPI call: test permissions See: https://cloud.google.com/pubsub/reference/rest/v1/projects.topics/testIamPermissions https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/testIamPermissions :type target_path: string :param target_path: the path of the target object. :type permissions: list of string :param permissions: the permissions to check :rtype: dict :returns: the resource returned by the ``getIamPolicy`` API request. permissionsz/%s:testIamPermissionsr<r=r&)rrXr]r-r[rr/rrrtest_iam_permissionss  z"_IAMPolicyAPI.test_iam_permissionsN)rrrrrrYr\r^rrrrrWs rW) rr ZgcloudrZbase_connectionZgcloud.environment_varsrZJSONConnectionrobjectrrCrWrrrrs  Gb