Skip to content

Fixing broken links in Pub/Sub docs. #1334

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dhermes merged 1 commit into from
Jan 7, 2016
Merged

Fixing broken links in Pub/Sub docs. #1334

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions gcloud/pubsub/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,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/v1beta2/projects/topics/list
https://cloud.google.com/pubsub/reference/rest/v1/projects.topics/list

:type page_size: int
:param page_size: maximum number of topics to return, If not passed,
Expand Down Expand Up @@ -85,10 +85,10 @@ 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/v1beta2/projects/topics/list
https://cloud.google.com/pubsub/reference/rest/v1/projects.topics/list

and (where ``topic_name`` is passed):
https://cloud.google.com/pubsub/reference/rest/v1beta2/projects/topics/subscriptions/list
https://cloud.google.com/pubsub/reference/rest/v1/projects.topics.subscriptions/list

:type page_size: int
:param page_size: maximum number of topics to return, If not passed,
Expand Down
2 changes: 1 addition & 1 deletion gcloud/pubsub/message.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ class Message(object):
"""Messages can be published to a topic and received by subscribers.

See:
https://cloud.google.com/pubsub/reference/rest/google/pubsub/v1beta2/PubsubMessage
https://cloud.google.com/pubsub/reference/rest/v1/PubsubMessage

:type data: bytes
:param data: the payload of the message
Expand Down
18 changes: 9 additions & 9 deletions gcloud/pubsub/subscription.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ class Subscription(object):
"""Subscriptions receive messages published to their topics.

See:
https://cloud.google.com/pubsub/reference/rest/v1beta2/projects/subscriptions
https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions

:type name: string
:param name: the name of the subscription
Expand Down Expand Up @@ -103,7 +103,7 @@ def create(self, client=None):
"""API call: create the subscription via a PUT request

See:
https://cloud.google.com/pubsub/reference/rest/v1beta2/projects/subscriptions/create
https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/create

:type client: :class:`gcloud.pubsub.client.Client` or ``NoneType``
:param client: the client to use. If not passed, falls back to the
Expand All @@ -124,7 +124,7 @@ def exists(self, client=None):
"""API call: test existence of the subscription via a GET request

See
https://cloud.google.com/pubsub/reference/rest/v1beta2/projects/subscriptions/get
https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/get

:type client: :class:`gcloud.pubsub.client.Client` or ``NoneType``
:param client: the client to use. If not passed, falls back to the
Expand All @@ -142,7 +142,7 @@ def reload(self, client=None):
"""API call: sync local subscription configuration via a GET request

See
https://cloud.google.com/pubsub/reference/rest/v1beta2/projects/subscriptions/get
https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/get

:type client: :class:`gcloud.pubsub.client.Client` or ``NoneType``
:param client: the client to use. If not passed, falls back to the
Expand All @@ -158,7 +158,7 @@ def modify_push_configuration(self, push_endpoint, client=None):
"""API call: update the push endpoint for the subscription.

See:
https://cloud.google.com/pubsub/reference/rest/v1beta2/projects/subscriptions/modifyPushConfig
https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/modifyPushConfig

:type push_endpoint: string
:param push_endpoint: URL to which messages will be pushed by the
Expand All @@ -183,7 +183,7 @@ def pull(self, return_immediately=False, max_messages=1, client=None):
"""API call: retrieve messages for the subscription.

See:
https://cloud.google.com/pubsub/reference/rest/v1beta2/projects/subscriptions/pull
https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/pull

:type return_immediately: boolean
:param return_immediately: if True, the back-end returns even if no
Expand Down Expand Up @@ -215,7 +215,7 @@ def acknowledge(self, ack_ids, client=None):
"""API call: acknowledge retrieved messages for the subscription.

See:
https://cloud.google.com/pubsub/reference/rest/v1beta2/projects/subscriptions/acknowledge
https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/acknowledge

:type ack_ids: list of string
:param ack_ids: ack IDs of messages being acknowledged
Expand All @@ -233,7 +233,7 @@ def modify_ack_deadline(self, ack_id, ack_deadline, client=None):
"""API call: update acknowledgement deadline for a retrieved message.

See:
https://cloud.google.com/pubsub/reference/rest/v1beta2/projects/subscriptions/acknowledge
https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/acknowledge

:type ack_id: string
:param ack_id: ack ID of message being updated
Expand All @@ -255,7 +255,7 @@ def delete(self, client=None):
"""API call: delete the subscription via a DELETE request.

See:
https://cloud.google.com/pubsub/reference/rest/v1beta2/projects/subscriptions/delete
https://cloud.google.com/pubsub/reference/rest/v1/projects.subscriptions/delete

:type client: :class:`gcloud.pubsub.client.Client` or ``NoneType``
:param client: the client to use. If not passed, falls back to the
Expand Down
10 changes: 5 additions & 5 deletions gcloud/pubsub/topic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ class Topic(object):
Subscribers then receive those messages.

See:
https://cloud.google.com/pubsub/reference/rest/v1beta2/projects/topics
https://cloud.google.com/pubsub/reference/rest/v1/projects.topics

:type name: string
:param name: the name of the topic
Expand Down Expand Up @@ -119,7 +119,7 @@ def create(self, client=None):
"""API call: create the topic via a PUT request

See:
https://cloud.google.com/pubsub/reference/rest/v1beta2/projects/topics/create
https://cloud.google.com/pubsub/reference/rest/v1/projects.topics/create

:type client: :class:`gcloud.pubsub.client.Client` or ``NoneType``
:param client: the client to use. If not passed, falls back to the
Expand All @@ -132,7 +132,7 @@ def exists(self, client=None):
"""API call: test for the existence of the topic via a GET request

See
https://cloud.google.com/pubsub/reference/rest/v1beta2/projects/topics/get
https://cloud.google.com/pubsub/reference/rest/v1/projects.topics/get

:type client: :class:`gcloud.pubsub.client.Client` or ``NoneType``
:param client: the client to use. If not passed, falls back to the
Expand Down Expand Up @@ -161,7 +161,7 @@ def publish(self, message, client=None, **attrs):
"""API call: publish a message to a topic via a POST request

See:
https://cloud.google.com/pubsub/reference/rest/v1beta2/projects/topics/publish
https://cloud.google.com/pubsub/reference/rest/v1/projects.topics/publish

:type message: bytes
:param message: the message payload
Expand Down Expand Up @@ -203,7 +203,7 @@ def delete(self, client=None):
"""API call: delete the topic via a DELETE request

See:
https://cloud.google.com/pubsub/reference/rest/v1beta2/projects/topics/delete
https://cloud.google.com/pubsub/reference/rest/v1/projects.topics/delete

:type client: :class:`gcloud.pubsub.client.Client` or ``NoneType``
:param client: the client to use. If not passed, falls back to the
Expand Down