Skip to content

Commit

Permalink
Merge pull request #2398 from daspecster/fix-pubsub-doc-links
Browse files Browse the repository at this point in the history
Fix links to pubsub documentation.
  • Loading branch information
daspecster committed Sep 23, 2016
2 parents e927026 + 3298176 commit b98aad3
Show file tree
Hide file tree
Showing 8 changed files with 62 additions and 62 deletions.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ receivers, Google Cloud Pub/Sub allows developers to communicate between
independently written applications.

.. _Cloud Pub/Sub: https://cloud.google.com/pubsub/docs
.. _Pub/Sub API docs: https://cloud.google.com/pubsub/reference/rest/
.. _Pub/Sub API docs: https://cloud.google.com/pubsub/docs/reference/rest/

See the ``google-cloud-python`` API `Pub/Sub documentation`_ to learn how to connect
to Cloud Pub/Sub using this Client Library.
Expand Down
28 changes: 14 additions & 14 deletions google/cloud/pubsub/_gax.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ def list_topics(self, project, page_size=0, page_token=None):
"""List topics for the project associated with this API.
See:
https://cloud.google.com/pubsub/reference/rest/v1/projects.topics/list
https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics/list
:type project: string
:param project: project ID
Expand Down Expand Up @@ -80,7 +80,7 @@ def topic_create(self, topic_path):
"""API call: create a topic
See:
https://cloud.google.com/pubsub/reference/rest/v1/projects.topics/create
https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics/create
:type topic_path: string
:param topic_path: fully-qualified path of the new topic, in format
Expand All @@ -103,7 +103,7 @@ def topic_get(self, topic_path):
"""API call: retrieve a topic
See:
https://cloud.google.com/pubsub/reference/rest/v1/projects.topics/get
https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics/get
:type topic_path: string
:param topic_path: fully-qualified path of the topic, in format
Expand All @@ -126,7 +126,7 @@ def topic_delete(self, topic_path):
"""API call: delete a topic
See:
https://cloud.google.com/pubsub/reference/rest/v1/projects.topics/create
https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics/create
:type topic_path: string
:param topic_path: fully-qualified path of the new topic, in format
Expand All @@ -143,7 +143,7 @@ def topic_publish(self, topic_path, messages):
"""API call: publish one or more messages to a topic
See:
https://cloud.google.com/pubsub/reference/rest/v1/projects.topics/publish
https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics/publish
:type topic_path: string
:param topic_path: fully-qualified path of the topic, in format
Expand Down Expand Up @@ -174,7 +174,7 @@ def topic_list_subscriptions(self, topic_path, page_size=0,
"""API call: list subscriptions bound to a topic
See:
https://cloud.google.com/pubsub/reference/rest/v1/projects.topics.subscriptions/list
https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics.subscriptions/list
:type topic_path: string
:param topic_path: fully-qualified path of the topic, in format
Expand Down Expand Up @@ -223,7 +223,7 @@ def list_subscriptions(self, project, page_size=0, page_token=None):
"""List subscriptions for the project associated with this API.
See:
https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/list
https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.subscriptions/list
:type project: string
:param project: project ID
Expand Down Expand Up @@ -259,7 +259,7 @@ def subscription_create(self, subscription_path, topic_path,
"""API call: create a subscription
See:
https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/create
https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.subscriptions/create
:type subscription_path: string
:param subscription_path: the fully-qualified path of the new
Expand Down Expand Up @@ -304,7 +304,7 @@ def subscription_get(self, subscription_path):
"""API call: retrieve a subscription
See:
https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/get
https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.subscriptions/get
:type subscription_path: string
:param subscription_path: the fully-qualified path of the subscription,
Expand All @@ -326,7 +326,7 @@ def subscription_delete(self, subscription_path):
"""API call: delete a subscription
See:
https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/delete
https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.subscriptions/delete
:type subscription_path: string
:param subscription_path: the fully-qualified path of the subscription,
Expand All @@ -345,7 +345,7 @@ def subscription_modify_push_config(self, subscription_path,
"""API call: update push config of a subscription
See:
https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/modifyPushConfig
https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.subscriptions/modifyPushConfig
:type subscription_path: string
:param subscription_path: the fully-qualified path of the new
Expand All @@ -370,7 +370,7 @@ def subscription_pull(self, subscription_path, return_immediately=False,
"""API call: retrieve messages for a subscription
See:
https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/modifyPushConfig
https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.subscriptions/modifyPushConfig
:type subscription_path: string
:param subscription_path: the fully-qualified path of the new
Expand Down Expand Up @@ -403,7 +403,7 @@ def subscription_acknowledge(self, subscription_path, ack_ids):
"""API call: acknowledge retrieved messages
See:
https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/modifyPushConfig
https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.subscriptions/modifyPushConfig
:type subscription_path: string
:param subscription_path: the fully-qualified path of the new
Expand All @@ -425,7 +425,7 @@ def subscription_modify_ack_deadline(self, subscription_path, ack_ids,
"""API call: update ack deadline for retrieved messages
See:
https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/modifyAckDeadline
https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.subscriptions/modifyAckDeadline
:type subscription_path: string
:param subscription_path: the fully-qualified path of the new
Expand Down
4 changes: 2 additions & 2 deletions google/cloud/pubsub/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ def list_topics(self, page_size=None, page_token=None):
"""List topics for the project associated with this client.
See:
https://cloud.google.com/pubsub/reference/rest/v1/projects.topics/list
https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics/list
Example:
Expand Down Expand Up @@ -137,7 +137,7 @@ def list_subscriptions(self, page_size=None, page_token=None):
"""List subscriptions for the project associated with this client.
See:
https://cloud.google.com/pubsub/reference/rest/v1/projects.topics/list
https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics/list
Example:
Expand Down
40 changes: 20 additions & 20 deletions google/cloud/pubsub/connection.py
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ def list_topics(self, project, page_size=None, page_token=None):
"""API call: list topics for a given project
See:
https://cloud.google.com/pubsub/reference/rest/v1/projects.topics/list
https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics/list
:type project: string
:param project: project ID
Expand Down Expand Up @@ -144,7 +144,7 @@ def topic_create(self, topic_path):
"""API call: create a topic
See:
https://cloud.google.com/pubsub/reference/rest/v1/projects.topics/create
https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics/create
:type topic_path: string
:param topic_path: the fully-qualified path of the new topic, in format
Expand All @@ -160,7 +160,7 @@ def topic_get(self, topic_path):
"""API call: retrieve a topic
See:
https://cloud.google.com/pubsub/reference/rest/v1/projects.topics/get
https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics/get
:type topic_path: string
:param topic_path: the fully-qualified path of the topic, in format
Expand All @@ -176,7 +176,7 @@ def topic_delete(self, topic_path):
"""API call: delete a topic
See:
https://cloud.google.com/pubsub/reference/rest/v1/projects.topics/delete
https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics/delete
:type topic_path: string
:param topic_path: the fully-qualified path of the topic, in format
Expand All @@ -189,7 +189,7 @@ def topic_publish(self, topic_path, messages):
"""API call: publish one or more messages to a topic
See:
https://cloud.google.com/pubsub/reference/rest/v1/projects.topics/publish
https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics/publish
:type topic_path: string
:param topic_path: the fully-qualified path of the topic, in format
Expand All @@ -212,7 +212,7 @@ def topic_list_subscriptions(self, topic_path, page_size=None,
"""API call: list subscriptions bound to a topic
See:
https://cloud.google.com/pubsub/reference/rest/v1/projects.topics.subscriptions/list
https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics.subscriptions/list
:type topic_path: string
:param topic_path: the fully-qualified path of the topic, in format
Expand Down Expand Up @@ -259,7 +259,7 @@ def list_subscriptions(self, project, page_size=None, page_token=None):
"""API call: list subscriptions for a given project
See:
https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/list
https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.subscriptions/list
:type project: string
:param project: project ID
Expand Down Expand Up @@ -297,7 +297,7 @@ def subscription_create(self, subscription_path, topic_path,
"""API call: create a subscription
See:
https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/create
https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.subscriptions/create
:type subscription_path: string
:param subscription_path: the fully-qualified path of the new
Expand Down Expand Up @@ -337,7 +337,7 @@ def subscription_get(self, subscription_path):
"""API call: retrieve a subscription
See:
https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/get
https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.subscriptions/get
:type subscription_path: string
:param subscription_path: the fully-qualified path of the subscription,
Expand All @@ -355,7 +355,7 @@ def subscription_delete(self, subscription_path):
"""API call: delete a subscription
See:
https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/delete
https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.subscriptions/delete
:type subscription_path: string
:param subscription_path: the fully-qualified path of the subscription,
Expand All @@ -371,7 +371,7 @@ def subscription_modify_push_config(self, subscription_path,
"""API call: update push config of a subscription
See:
https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/modifyPushConfig
https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.subscriptions/modifyPushConfig
:type subscription_path: string
:param subscription_path: the fully-qualified path of the new
Expand All @@ -393,7 +393,7 @@ def subscription_pull(self, subscription_path, return_immediately=False,
"""API call: retrieve messages for a subscription
See:
https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/modifyPushConfig
https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.subscriptions/modifyPushConfig
:type subscription_path: string
:param subscription_path: the fully-qualified path of the new
Expand Down Expand Up @@ -425,7 +425,7 @@ def subscription_acknowledge(self, subscription_path, ack_ids):
"""API call: acknowledge retrieved messages
See:
https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/modifyPushConfig
https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.subscriptions/modifyPushConfig
:type subscription_path: string
:param subscription_path: the fully-qualified path of the new
Expand All @@ -447,7 +447,7 @@ def subscription_modify_ack_deadline(self, subscription_path, ack_ids,
"""API call: update ack deadline for retrieved messages
See:
https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/modifyAckDeadline
https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.subscriptions/modifyAckDeadline
:type subscription_path: string
:param subscription_path: the fully-qualified path of the new
Expand Down Expand Up @@ -484,8 +484,8 @@ def get_iam_policy(self, target_path):
"""API 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
https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics/getIamPolicy
https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.subscriptions/getIamPolicy
:type target_path: string
:param target_path: the path of the target object.
Expand All @@ -501,8 +501,8 @@ def set_iam_policy(self, target_path, policy):
"""API 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
https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics/setIamPolicy
https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.subscriptions/setIamPolicy
:type target_path: string
:param target_path: the path of the target object.
Expand All @@ -522,8 +522,8 @@ def test_iam_permissions(self, target_path, permissions):
"""API 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
https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics/testIamPermissions
https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.subscriptions/testIamPermissions
:type target_path: string
:param target_path: the path of the target object.
Expand Down
4 changes: 2 additions & 2 deletions google/cloud/pubsub/iam.py
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,8 @@ class Policy(object):
"""Combined IAM Policy / Bindings.
See:
https://cloud.google.com/pubsub/reference/rest/Shared.Types/Policy
https://cloud.google.com/pubsub/reference/rest/Shared.Types/Binding
https://cloud.google.com/pubsub/docs/reference/rest/Shared.Types/Policy
https://cloud.google.com/pubsub/docs/reference/rest/Shared.Types/Binding
:type etag: string
:param etag: ETag used to identify a unique of the policy
Expand Down
2 changes: 1 addition & 1 deletion google/cloud/pubsub/message.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ class Message(object):
"""Messages can be published to a topic and received by subscribers.
See:
https://cloud.google.com/pubsub/reference/rest/v1/PubsubMessage
https://cloud.google.com/pubsub/docs/reference/rest/v1/PubsubMessage
:type data: bytes
:param data: the payload of the message.
Expand Down
Loading

0 comments on commit b98aad3

Please sign in to comment.