openstack/openstacksdk
Code Issues Proposed changes

Add telemetry resource docs

Browse Source 
Change-Id: I4639f3b95eac0bfc34472502e54aba48b89d778a
This commit is contained in:
Terry Howe 2015-05-22 14:49:02 -07:00
parent 25049be285
commit 977bf3320f
9 changed files with 98 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/users/index.rst
View File

@ -98,6 +98,7 @@ The following services have exposed *Resource* classes.
Database <resources/database/index>
Network <resources/network/index>
Object Store <resources/object_store/index>
Telemetry <resources/telemetry/index>
Volume <resources/volume/index>
Low-Level Classes

13
doc/source/users/resources/telemetry/index.rst Normal file
View File

@ -0,0 +1,13 @@
Telemetry Resources
===================
.. toctree::
:maxdepth: 1
v2/alarm
v2/alarm_change
v2/capability
v2/meter
v2/resource
v2/sample
v2/statistics

12
doc/source/users/resources/telemetry/v2/alarm.rst Normal file
View File

@ -0,0 +1,12 @@
openstack.telemetry.v2.alarm
============================
.. automodule:: openstack.telemetry.v2.alarm
The Alarm Class
---------------
The ``Alarm`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.telemetry.v2.alarm.Alarm
:members:

12
doc/source/users/resources/telemetry/v2/alarm_change.rst Normal file
View File

@ -0,0 +1,12 @@
openstack.telemetry.v2.alarm_change
===================================
.. automodule:: openstack.telemetry.v2.alarm_change
The AlarmChange Class
---------------------
The ``AlarmChange`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.telemetry.v2.alarm_change.AlarmChange
:members:

12
doc/source/users/resources/telemetry/v2/capability.rst Normal file
View File

@ -0,0 +1,12 @@
openstack.telemetry.v2.capability
=================================
.. automodule:: openstack.telemetry.v2.capability
The Capability Class
--------------------
The ``Capability`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.telemetry.v2.capability.Capability
:members:

12
doc/source/users/resources/telemetry/v2/meter.rst Normal file
View File

@ -0,0 +1,12 @@
openstack.telemetry.v2.meter
============================
.. automodule:: openstack.telemetry.v2.meter
The Meter Class
----------------
The ``Meter`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.telemetry.v2.meter.Meter
:members:

12
doc/source/users/resources/telemetry/v2/resource.rst Normal file
View File

@ -0,0 +1,12 @@
openstack.telemetry.v2.resource
===============================
.. automodule:: openstack.telemetry.v2.resource
The Resource Class
------------------
The ``Resource`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.telemetry.v2.resource.Resource
:members:

12
doc/source/users/resources/telemetry/v2/sample.rst Normal file
View File

@ -0,0 +1,12 @@
openstack.telemetry.v2.sample
=============================
.. automodule:: openstack.telemetry.v2.sample
The Sample Class
----------------
The ``Sample`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.telemetry.v2.sample.Sample
:members:

12
doc/source/users/resources/telemetry/v2/statistics.rst Normal file
View File

@ -0,0 +1,12 @@
openstack.telemetry.v2.statistics
=================================
.. automodule:: openstack.telemetry.v2.statistics
The Statistics Class
--------------------
The ``Statistics`` class inherits from :class:`~openstack.resource.Resource`.
.. autoclass:: openstack.telemetry.v2.statistics.Statistics
:members: