Skip to content
This repository was archived by the owner on Dec 31, 2023. It is now read-only.

Commit 4cdb1ff

Browse files
authored
docs: remove code snippet and 'Stackdriver' (#71)
Remove the code snippet which is untested. Fixes #70. Also remove 'Stackdriver' from the README.
1 parent fe57446 commit 4cdb1ff

File tree

1 file changed

+7
-32
lines changed

1 file changed

+7
-32
lines changed

README.rst

Lines changed: 7 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
Python Client for Stackdriver Monitoring API
1+
Python Client for Cloud Monitoring API
22
=======================================================
33

44
|ga| |pypi| |versions|
55

6-
`Stackdriver Monitoring API`_: Manages your Stackdriver Monitoring data and
7-
configurations. Most projects must be associated with a Stackdriver account,
6+
`Cloud Monitoring API`_: Manages your Cloud Monitoring data and
7+
configurations. Most projects must be associated with a Google Cloud account,
88
with a few exceptions as noted on the individual method pages.
99

1010
- `Client Library Documentation`_
@@ -16,7 +16,7 @@ with a few exceptions as noted on the individual method pages.
1616
:target: https://pypi.org/project/google-cloud-monitoring/
1717
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-monitoring.svg
1818
:target: https://pypi.org/project/google-cloud-monitoring/
19-
.. _Stackdriver Monitoring API: https://cloud.google.com/monitoring/api/ref_v3/rest/
19+
.. _Cloud Monitoring API: https://cloud.google.com/monitoring/api/ref_v3/rest/
2020
.. _Client Library Documentation: https://googleapis.dev/python/monitoring/latest
2121
.. _Product Documentation: https://cloud.google.com/monitoring/docs
2222

@@ -27,12 +27,12 @@ In order to use this library, you first need to go through the following steps:
2727

2828
1. `Select or create a Cloud Platform project.`_
2929
2. `Enable billing for your project.`_
30-
3. `Enable the Stackdriver Monitoring API.`_
30+
3. `Enable the Cloud Monitoring API.`_
3131
4. `Setup Authentication.`_
3232

3333
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
3434
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
35-
.. _Enable the Stackdriver Monitoring API.: https://cloud.google.com/monitoring/api/enable-api
35+
.. _Enable the Cloud Monitoring API.: https://cloud.google.com/monitoring/api/enable-api
3636
.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
3737

3838
Installation
@@ -81,37 +81,12 @@ Windows
8181
<your-env>\Scripts\activate
8282
<your-env>\Scripts\pip.exe install google-cloud-monitoring
8383
84-
Preview
85-
~~~~~~~
86-
87-
MetricServiceClient
88-
^^^^^^^^^^^^^^^^^^^
89-
90-
.. code:: py
91-
92-
from google.cloud import monitoring_v3
93-
94-
client = monitoring_v3.MetricServiceClient()
95-
96-
name = client.project_path('[PROJECT]')
97-
98-
99-
# Iterate over all results
100-
for element in client.list_monitored_resource_descriptors(name):
101-
# process element
102-
pass
103-
104-
# Or iterate over results one page at a time
105-
for page in client.list_monitored_resource_descriptors(name).pages:
106-
for element in page:
107-
# process element
108-
pass
10984
11085
Next Steps
11186
~~~~~~~~~~
11287

11388

114-
- Read the `Client Library Documentation`_ for Stackdriver Monitoring API
89+
- Read the `Client Library Documentation`_ for Cloud Monitoring API
11590
to see other available methods on the client.
11691
- Read the `Product documentation`_ to learn more about the product and see
11792
How-to Guides.

0 commit comments

Comments
 (0)