Skip to content

Commit 5aa21ca

Browse files
chore: remove PubSub cloud-client samples (#4175)
* chore: remove PubSub cloud-client samples * chore: add link to new samples location in README Co-authored-by: Tianzi Cai <[email protected]>
1 parent 1b44894 commit 5aa21ca

14 files changed

+2
-2539
lines changed

pubsub/cloud-client/README.rst

Lines changed: 2 additions & 239 deletions
Original file line numberDiff line numberDiff line change
@@ -1,240 +1,3 @@
1-
.. This file is automatically generated. Do not edit this file directly.
1+
These samples have been moved.
22

3-
Google Cloud Pub/Sub Python Samples
4-
===============================================================================
5-
6-
.. image:: https://gstatic.com/cloudssh/images/open-btn.png
7-
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=pubsub/cloud-client/README.rst
8-
9-
10-
This directory contains samples for Google Cloud Pub/Sub. `Google Cloud Pub/Sub`_ is a fully-managed real-time messaging service that allows you to send and receive messages between independent applications.
11-
12-
13-
14-
15-
.. _Google Cloud Pub/Sub: https://cloud.google.com/pubsub/docs
16-
17-
Setup
18-
-------------------------------------------------------------------------------
19-
20-
21-
Authentication
22-
++++++++++++++
23-
24-
This sample requires you to have authentication setup. Refer to the
25-
`Authentication Getting Started Guide`_ for instructions on setting up
26-
credentials for applications.
27-
28-
.. _Authentication Getting Started Guide:
29-
https://cloud.google.com/docs/authentication/getting-started
30-
31-
Install Dependencies
32-
++++++++++++++++++++
33-
34-
#. Clone python-docs-samples and change directory to the sample directory you want to use.
35-
36-
.. code-block:: bash
37-
38-
$ git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git
39-
40-
#. Install `pip`_ and `virtualenv`_ if you do not already have them. You may want to refer to the `Python Development Environment Setup Guide`_ for Google Cloud Platform for instructions.
41-
42-
.. _Python Development Environment Setup Guide:
43-
https://cloud.google.com/python/setup
44-
45-
#. Create a virtualenv. Samples are compatible with Python 2.7 and 3.4+.
46-
47-
.. code-block:: bash
48-
49-
$ virtualenv env
50-
$ source env/bin/activate
51-
52-
#. Install the dependencies needed to run the samples.
53-
54-
.. code-block:: bash
55-
56-
$ pip install -r requirements.txt
57-
58-
.. _pip: https://pip.pypa.io/
59-
.. _virtualenv: https://virtualenv.pypa.io/
60-
61-
Samples
62-
-------------------------------------------------------------------------------
63-
64-
Publisher
65-
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
66-
67-
.. image:: https://gstatic.com/cloudssh/images/open-btn.png
68-
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=pubsub/cloud-client/publisher.py,pubsub/cloud-client/README.rst
69-
70-
71-
72-
73-
To run this sample:
74-
75-
.. code-block:: bash
76-
77-
$ python publisher.py --help
78-
79-
usage: publisher.py [-h]
80-
project_id
81-
{list,create,delete,publish,publish-with-custom-attributes,publish-with-error-handler,publish-with-batch-settings,publish-with-retry-settings}
82-
...
83-
84-
This application demonstrates how to perform basic operations on topics
85-
with the Cloud Pub/Sub API.
86-
87-
For more information, see the README.md under /pubsub and the documentation
88-
at https://cloud.google.com/pubsub/docs.
89-
90-
positional arguments:
91-
project_id Your Google Cloud project ID
92-
{list,create,delete,publish,publish-with-custom-attributes,publish-with-error-handler,publish-with-batch-settings,publish-with-retry-settings}
93-
list Lists all Pub/Sub topics in the given project.
94-
create Create a new Pub/Sub topic.
95-
delete Deletes an existing Pub/Sub topic.
96-
publish Publishes multiple messages to a Pub/Sub topic.
97-
publish-with-custom-attributes
98-
Publishes multiple messages with custom attributes to
99-
a Pub/Sub topic.
100-
publish-with-error-handler
101-
Publishes multiple messages to a Pub/Sub topic with an
102-
error handler.
103-
publish-with-batch-settings
104-
Publishes multiple messages to a Pub/Sub topic with
105-
batch settings.
106-
publish-with-retry-settings
107-
Publishes messages with custom retry settings.
108-
109-
optional arguments:
110-
-h, --help show this help message and exit
111-
112-
113-
114-
Subscribers
115-
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
116-
117-
.. image:: https://gstatic.com/cloudssh/images/open-btn.png
118-
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=pubsub/cloud-client/subscriber.py,pubsub/cloud-client/README.rst
119-
120-
121-
122-
123-
To run this sample:
124-
125-
.. code-block:: bash
126-
127-
$ python subscriber.py --help
128-
129-
usage: subscriber.py [-h]
130-
project_id
131-
{list-in-topic,list-in-project,create,create-with-dead-letter-policy,create-push,delete,update-push,update-dead-letter-policy,remove-dead-letter-policy,receive,receive-custom-attributes,receive-flow-control,receive-synchronously,receive-synchronously-with-lease,listen-for-errors,receive-messages-with-delivery-attempts}
132-
...
133-
134-
This application demonstrates how to perform basic operations on
135-
subscriptions with the Cloud Pub/Sub API.
136-
137-
For more information, see the README.md under /pubsub and the documentation
138-
at https://cloud.google.com/pubsub/docs.
139-
140-
positional arguments:
141-
project_id Your Google Cloud project ID
142-
{list-in-topic,list-in-project,create,create-with-dead-letter-policy,create-push,delete,update-push,update-dead-letter-policy,remove-dead-letter-policy,receive,receive-custom-attributes,receive-flow-control,receive-synchronously,receive-synchronously-with-lease,listen-for-errors,receive-messages-with-delivery-attempts}
143-
list-in-topic Lists all subscriptions for a given topic.
144-
list-in-project Lists all subscriptions in the current project.
145-
create Create a new pull subscription on the given topic.
146-
create-with-dead-letter-policy
147-
Create a subscription with dead letter policy.
148-
create-push Create a new push subscription on the given topic.
149-
delete Deletes an existing Pub/Sub topic.
150-
update-push Updates an existing Pub/Sub subscription's push
151-
endpoint URL. Note that certain properties of a
152-
subscription, such as its topic, are not modifiable.
153-
update-dead-letter-policy
154-
Update a subscription's dead letter policy.
155-
remove-dead-letter-policy
156-
Remove dead letter policy from a subscription.
157-
receive Receives messages from a pull subscription.
158-
receive-custom-attributes
159-
Receives messages from a pull subscription.
160-
receive-flow-control
161-
Receives messages from a pull subscription with flow
162-
control.
163-
receive-synchronously
164-
Pulling messages synchronously.
165-
receive-synchronously-with-lease
166-
Pulling messages synchronously with lease management
167-
listen-for-errors Receives messages and catches errors from a pull
168-
subscription.
169-
receive-messages-with-delivery-attempts
170-
171-
optional arguments:
172-
-h, --help show this help message and exit
173-
174-
175-
176-
Identity and Access Management
177-
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
178-
179-
.. image:: https://gstatic.com/cloudssh/images/open-btn.png
180-
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=pubsub/cloud-client/iam.py,pubsub/cloud-client/README.rst
181-
182-
183-
184-
185-
To run this sample:
186-
187-
.. code-block:: bash
188-
189-
$ python iam.py
190-
191-
usage: iam.py [-h]
192-
project
193-
{get-topic-policy,get-subscription-policy,set-topic-policy,set-subscription-policy,check-topic-permissions,check-subscription-permissions}
194-
...
195-
196-
This application demonstrates how to perform basic operations on IAM
197-
policies with the Cloud Pub/Sub API.
198-
199-
For more information, see the README.md under /pubsub and the documentation
200-
at https://cloud.google.com/pubsub/docs.
201-
202-
positional arguments:
203-
project Your Google Cloud project ID
204-
{get-topic-policy,get-subscription-policy,set-topic-policy,set-subscription-policy,check-topic-permissions,check-subscription-permissions}
205-
get-topic-policy Prints the IAM policy for the given topic.
206-
get-subscription-policy
207-
Prints the IAM policy for the given subscription.
208-
set-topic-policy Sets the IAM policy for a topic.
209-
set-subscription-policy
210-
Sets the IAM policy for a topic.
211-
check-topic-permissions
212-
Checks to which permissions are available on the given
213-
topic.
214-
check-subscription-permissions
215-
Checks to which permissions are available on the given
216-
subscription.
217-
218-
optional arguments:
219-
-h, --help show this help message and exit
220-
221-
222-
223-
224-
225-
The client library
226-
-------------------------------------------------------------------------------
227-
228-
This sample uses the `Google Cloud Client Library for Python`_.
229-
You can read the documentation for more details on API usage and use GitHub
230-
to `browse the source`_ and `report issues`_.
231-
232-
.. _Google Cloud Client Library for Python:
233-
https://googlecloudplatform.github.io/google-cloud-python/
234-
.. _browse the source:
235-
https://github.com/GoogleCloudPlatform/google-cloud-python
236-
.. _report issues:
237-
https://github.com/GoogleCloudPlatform/google-cloud-python/issues
238-
239-
240-
.. _Google Cloud SDK: https://cloud.google.com/sdk/
3+
https://github.com/googleapis/python-pubsub/tree/master/samples

pubsub/cloud-client/README.rst.in

Lines changed: 0 additions & 30 deletions
This file was deleted.

0 commit comments

Comments
 (0)