Load balancer - reindentation of the docstrings

Change-Id: Ie98dcd47298389ae52a70e4ab7d623ebcb4a9183
This commit is contained in:
Thomas Bucaioni 2021-12-03 10:17:16 +01:00
parent 112fbf641a
commit a1263076e4

View File

@ -35,8 +35,7 @@ class Proxy(proxy.Proxy):
"""Create a new load balancer from attributes
:param dict attrs: Keyword arguments which will be used to create
a :class:`~openstack.load_balancer.v2.
load_balancer.LoadBalancer`,
a :class:`~openstack.load_balancer.v2.load_balancer.LoadBalancer`,
comprised of the properties on the
LoadBalancer class.
@ -62,8 +61,8 @@ class Proxy(proxy.Proxy):
:param name_or_id: The name or ID of a load balancer
:returns: One :class:`~openstack.load_balancer.v2.load_balancer.
LoadBalancerStats`
:returns: One
:class:`~openstack.load_balancer.v2.load_balancer.LoadBalancerStats`
"""
return self._get(_lb.LoadBalancerStats, lb_id=name_or_id,
requires_id=False)
@ -206,10 +205,10 @@ class Proxy(proxy.Proxy):
:class:`~openstack.load_balancer.v2.listener.Listener`
instance.
:returns: One :class:`~openstack.load_balancer.v2.listener.
ListenerStats`
:raises: :class:`~openstack.exceptions.ResourceNotFound`
when no resource can be found.
:returns: One
:class:`~openstack.load_balancer.v2.listener.ListenerStats`
:raises: :class:`~openstack.exceptions.ResourceNotFound` when no
resource can be found.
"""
return self._get(_listener.ListenerStats, listener_id=listener,
requires_id=False)
@ -242,10 +241,8 @@ class Proxy(proxy.Proxy):
"""Create a new pool from attributes
:param dict attrs: Keyword arguments which will be used to create
a :class:`~openstack.load_balancer.v2.
pool.Pool`,
comprised of the properties on the
Pool class.
a :class:`~openstack.load_balancer.v2.pool.Pool`, comprised of the
properties on the Pool class.
:returns: The results of Pool creation
:rtype: :class:`~openstack.load_balancer.v2.pool.Pool`
@ -453,14 +450,12 @@ class Proxy(proxy.Proxy):
"""Create a new health monitor from attributes
:param dict attrs: Keyword arguments which will be used to create
a :class:`~openstack.load_balancer.v2.
healthmonitor.HealthMonitor`,
comprised of the properties on the
HealthMonitor class.
a :class:`~openstack.load_balancer.v2.healthmonitor.HealthMonitor`,
comprised of the properties on the HealthMonitor class.
:returns: The results of HealthMonitor creation
:rtype: :class:`~openstack.load_balancer.v2.
healthmonitor.HealthMonitor`
:rtype:
:class:`~openstack.load_balancer.v2.healthmonitor.HealthMonitor`
"""
return self._create(_hm.HealthMonitor, **attrs)
@ -473,8 +468,8 @@ class Proxy(proxy.Proxy):
instance.
:returns: One health monitor
:rtype: :class:`~openstack.load_balancer.v2.
healthmonitor.HealthMonitor`
:rtype:
:class:`~openstack.load_balancer.v2.healthmonitor.HealthMonitor`
"""
return self._get(_hm.HealthMonitor, healthmonitor)
@ -523,8 +518,8 @@ class Proxy(proxy.Proxy):
represented by ``healthmonitor``.
:returns: The updated health monitor
:rtype: :class:`~openstack.load_balancer.v2.
healthmonitor.HealthMonitor`
:rtype:
:class:`~openstack.load_balancer.v2.healthmonitor.HealthMonitor`
"""
return self._update(_hm.HealthMonitor, healthmonitor,
**attrs)
@ -805,24 +800,22 @@ class Proxy(proxy.Proxy):
def create_flavor_profile(self, **attrs):
"""Create a new flavor profile from attributes
:param dict attrs: Keyword arguments which will be used to create
a :class:`~openstack.load_balancer.v2.
flavor_profile.FlavorProfile`,
comprised of the properties on the
FlavorProfile class.
:param dict attrs: Keyword arguments which will be used to create a
:class:`~openstack.load_balancer.v2.flavor_profile.FlavorProfile`,
comprised of the properties on the FlavorProfile class.
:returns: The results of profile creation creation
:rtype: :class:`~openstack.load_balancer.v2.flavor_profile.
FlavorProfile`
:rtype:
:class:`~openstack.load_balancer.v2.flavor_profile.FlavorProfile`
"""
return self._create(_flavor_profile.FlavorProfile, **attrs)
def get_flavor_profile(self, *attrs):
"""Get a flavor profile
:param flavor_profile: The value can be the name of a flavor profile
or :class:`~openstack.load_balancer.v2.flavor_profile.
FlavorProfile` instance.
:param flavor_profile: The value can be the name of a flavor profile or
:class:`~openstack.load_balancer.v2.flavor_profile.FlavorProfile`
instance.
:returns: One
:class:`~openstack.load_balancer.v2.flavor_profile.FlavorProfile`
@ -878,8 +871,8 @@ class Proxy(proxy.Proxy):
represented by ``flavor_profile``.
:returns: The updated flavor profile
:rtype: :class:`~openstack.load_balancer.v2.flavor_profile.
FlavorProfile`
:rtype:
:class:`~openstack.load_balancer.v2.flavor_profile.FlavorProfile`
"""
return self._update(_flavor_profile.FlavorProfile, flavor_profile,
**attrs)
@ -888,9 +881,8 @@ class Proxy(proxy.Proxy):
"""Create a new flavor from attributes
:param dict attrs: Keyword arguments which will be used to create
a :class:`~openstack.load_balancer.v2.
flavor.Flavor`, comprised of the properties on the
Flavorclass.
a :class:`~openstack.load_balancer.v2.flavor.Flavor`,
comprised of the properties on the Flavorclass.
:returns: The results of flavor creation creation
:rtype: :class:`~openstack.load_balancer.v2.flavor.Flavor`
@ -1012,15 +1004,14 @@ class Proxy(proxy.Proxy):
def create_availability_zone_profile(self, **attrs):
"""Create a new availability zone profile from attributes
:param dict attrs: Keyword arguments which will be used to create
a :class:`~openstack.load_balancer.v2.
availability_zone_profile.AvailabilityZoneProfile`,
comprised of the properties on the
AvailabilityZoneProfile class.
:param dict attrs: Keyword arguments which will be used to create a
:class:`~openstack.load_balancer.v2.availability_zone_profile.AvailabilityZoneProfile`
comprised of the properties on the AvailabilityZoneProfile
class.
:returns: The results of profile creation creation
:rtype: :class:`~openstack.load_balancer.v2.availability_zone_profile.
AvailabilityZoneProfile`
:rtype:
:class:`~openstack.load_balancer.v2.availability_zone_profile.AvailabilityZoneProfile`
"""
return self._create(_availability_zone_profile.AvailabilityZoneProfile,
**attrs)
@ -1029,9 +1020,9 @@ class Proxy(proxy.Proxy):
"""Get an availability zone profile
:param availability_zone_profile: The value can be the name of an
availability_zone profile
or :class:`~openstack.load_balancer.v2.availability_zone_profile.
AvailabilityZoneProfile` instance.
availability_zone profile or
:class:`~openstack.load_balancer.v2.availability_zone_profile.AvailabilityZoneProfile`
instance.
:returns: One
:class:`~openstack.load_balancer.v2.availability_zone_profile.AvailabilityZoneProfile`
@ -1090,12 +1081,11 @@ class Proxy(proxy.Proxy):
:class:`~openstack.load_balancer.v2.availability_zone_profile.AvailabilityZoneProfile`
instance
:param dict attrs: The attributes to update on the availability_zone
profile represented by
``availability_zone_profile``.
profile represented by ``availability_zone_profile``.
:returns: The updated availability zone profile
:rtype: :class:`~openstack.load_balancer.v2.availability_zone_profile.
AvailabilityZoneProfile`
:rtype:
:class:`~openstack.load_balancer.v2.availability_zone_profile.AvailabilityZoneProfile`
"""
return self._update(_availability_zone_profile.AvailabilityZoneProfile,
availability_zone_profile, **attrs)
@ -1103,10 +1093,9 @@ class Proxy(proxy.Proxy):
def create_availability_zone(self, **attrs):
"""Create a new availability zone from attributes
:param dict attrs: Keyword arguments which will be used to create
a :class:`~openstack.load_balancer.v2.
availability_zone.AvailabilityZone`, comprised of
the properties on the AvailabilityZoneclass.
:param dict attrs: Keyword arguments which will be used to create a
:class:`~openstack.load_balancer.v2.availability_zone.AvailabilityZone`
comprised of the properties on the AvailabilityZoneclass.
:returns: The results of availability_zone creation creation
:rtype: