Load balancer - reindentation of the docstrings
Change-Id: Ie98dcd47298389ae52a70e4ab7d623ebcb4a9183
This commit is contained in:
Thomas Bucaioni
parent
112fbf641a
commit
a1263076e4
@ -35,10 +35,9 @@ 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`,
|
||||
comprised of the properties on the
|
||||
LoadBalancer class.
|
||||
a :class:`~openstack.load_balancer.v2.load_balancer.LoadBalancer`,
|
||||
comprised of the properties on the
|
||||
LoadBalancer class.
|
||||
|
||||
:returns: The results of load balancer creation
|
||||
:rtype: :class:`~openstack.load_balancer.v2.load_balancer.LoadBalancer`
|
||||
@ -49,11 +48,11 @@ class Proxy(proxy.Proxy):
|
||||
"""Get a load balancer
|
||||
|
||||
:param load_balancer: The value can be the name of a load balancer
|
||||
or :class:`~openstack.load_balancer.v2.load_balancer.LoadBalancer`
|
||||
instance.
|
||||
or :class:`~openstack.load_balancer.v2.load_balancer.LoadBalancer`
|
||||
instance.
|
||||
|
||||
:returns: One
|
||||
:class:`~openstack.load_balancer.v2.load_balancer.LoadBalancer`
|
||||
:class:`~openstack.load_balancer.v2.load_balancer.LoadBalancer`
|
||||
"""
|
||||
return self._get(_lb.LoadBalancer, *attrs)
|
||||
|
||||
@ -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)
|
||||
@ -119,7 +118,7 @@ class Proxy(proxy.Proxy):
|
||||
:class:`~openstack.load_balancer.v2.load_balancer.LoadBalancer`
|
||||
instance
|
||||
:param dict attrs: The attributes to update on the load balancer
|
||||
represented by ``load_balancer``.
|
||||
represented by ``load_balancer``.
|
||||
|
||||
:returns: The updated load_balancer
|
||||
:rtype: :class:`~openstack.load_balancer.v2.load_balancer.LoadBalancer`
|
||||
@ -146,8 +145,8 @@ class Proxy(proxy.Proxy):
|
||||
"""Create a new listener from attributes
|
||||
|
||||
:param dict attrs: Keyword arguments which will be used to create a
|
||||
:class:`~openstack.load_balancer.v2.listener.Listener`,
|
||||
comprised of the properties on the Listener class.
|
||||
:class:`~openstack.load_balancer.v2.listener.Listener`,
|
||||
comprised of the properties on the Listener class.
|
||||
|
||||
:returns: The results of listener creation
|
||||
:rtype: :class:`~openstack.load_balancer.v2.listener.Listener`
|
||||
@ -158,12 +157,12 @@ class Proxy(proxy.Proxy):
|
||||
"""Delete a listener
|
||||
|
||||
:param listener: The value can be either the ID of a listner or a
|
||||
:class:`~openstack.load_balancer.v2.listener.Listener` instance.
|
||||
:class:`~openstack.load_balancer.v2.listener.Listener` instance.
|
||||
:param bool ignore_missing: When set to ``False``
|
||||
:class:`~openstack.exceptions.ResourceNotFound` will be
|
||||
raised when the listner does not exist.
|
||||
When set to ``True``, no exception will be set when
|
||||
attempting to delete a nonexistent listener.
|
||||
:class:`~openstack.exceptions.ResourceNotFound` will be
|
||||
raised when the listner does not exist.
|
||||
When set to ``True``, no exception will be set when
|
||||
attempting to delete a nonexistent listener.
|
||||
|
||||
:returns: ``None``
|
||||
"""
|
||||
@ -175,13 +174,13 @@ class Proxy(proxy.Proxy):
|
||||
|
||||
:param name_or_id: The name or ID of a listener.
|
||||
:param bool ignore_missing: When set to ``False``
|
||||
:class:`~openstack.exceptions.ResourceNotFound` will be
|
||||
raised when the resource does not exist.
|
||||
When set to ``True``, None will be returned when
|
||||
attempting to find a nonexistent resource.
|
||||
:class:`~openstack.exceptions.ResourceNotFound` will be
|
||||
raised when the resource does not exist.
|
||||
When set to ``True``, None will be returned when
|
||||
attempting to find a nonexistent resource.
|
||||
|
||||
:returns: One :class:`~openstack.load_balancer.v2.listener.Listener`
|
||||
or None
|
||||
or None
|
||||
"""
|
||||
return self._find(_listener.Listener, name_or_id,
|
||||
ignore_missing=ignore_missing)
|
||||
@ -190,12 +189,12 @@ class Proxy(proxy.Proxy):
|
||||
"""Get a single listener
|
||||
|
||||
:param listener: The value can be the ID of a listener or a
|
||||
:class:`~openstack.load_balancer.v2.listener.Listener`
|
||||
instance.
|
||||
:class:`~openstack.load_balancer.v2.listener.Listener`
|
||||
instance.
|
||||
|
||||
:returns: One :class:`~openstack.load_balancer.v2.listener.Listener`
|
||||
:raises: :class:`~openstack.exceptions.ResourceNotFound`
|
||||
when no resource can be found.
|
||||
when no resource can be found.
|
||||
"""
|
||||
return self._get(_listener.Listener, listener)
|
||||
|
||||
@ -203,13 +202,13 @@ class Proxy(proxy.Proxy):
|
||||
"""Get the listener statistics
|
||||
|
||||
:param listener: The value can be the ID of a listener or a
|
||||
:class:`~openstack.load_balancer.v2.listener.Listener`
|
||||
instance.
|
||||
: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)
|
||||
@ -218,7 +217,7 @@ class Proxy(proxy.Proxy):
|
||||
"""Return a generator of listeners
|
||||
|
||||
:param dict query: Optional query parameters to be sent to limit
|
||||
the resources being returned. Valid parameters are:
|
||||
the resources being returned. Valid parameters are:
|
||||
:returns: A generator of listener objects
|
||||
:rtype: :class:`~openstack.load_balancer.v2.listener.Listener`
|
||||
"""
|
||||
@ -228,10 +227,10 @@ class Proxy(proxy.Proxy):
|
||||
"""Update a listener
|
||||
|
||||
:param listener: Either the id of a listener or a
|
||||
:class:`~openstack.load_balancer.v2.listener.Listener`
|
||||
instance.
|
||||
:class:`~openstack.load_balancer.v2.listener.Listener`
|
||||
instance.
|
||||
:param dict attrs: The attributes to update on the listener
|
||||
represented by ``listener``.
|
||||
represented by ``listener``.
|
||||
|
||||
:returns: The updated listener
|
||||
:rtype: :class:`~openstack.load_balancer.v2.listener.Listener`
|
||||
@ -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`
|
||||
@ -260,7 +257,7 @@ class Proxy(proxy.Proxy):
|
||||
instance.
|
||||
|
||||
:returns: One
|
||||
:class:`~openstack.load_balancer.v2.pool.Pool`
|
||||
:class:`~openstack.load_balancer.v2.pool.Pool`
|
||||
"""
|
||||
return self._get(_pool.Pool, *attrs)
|
||||
|
||||
@ -307,10 +304,10 @@ class Proxy(proxy.Proxy):
|
||||
"""Update a pool
|
||||
|
||||
:param pool: Either the id of a pool or a
|
||||
:class:`~openstack.load_balancer.v2.pool.Pool`
|
||||
instance.
|
||||
:class:`~openstack.load_balancer.v2.pool.Pool`
|
||||
instance.
|
||||
:param dict attrs: The attributes to update on the pool
|
||||
represented by ``pool``.
|
||||
represented by ``pool``.
|
||||
|
||||
:returns: The updated pool
|
||||
:rtype: :class:`~openstack.load_balancer.v2.pool.Pool`
|
||||
@ -321,8 +318,8 @@ class Proxy(proxy.Proxy):
|
||||
"""Create a new member from attributes
|
||||
|
||||
:param pool: The pool can be either the ID of a pool or a
|
||||
:class:`~openstack.load_balancer.v2.pool.Pool` instance
|
||||
that the member will be created in.
|
||||
:class:`~openstack.load_balancer.v2.pool.Pool` instance
|
||||
that the member will be created in.
|
||||
:param dict attrs: Keyword arguments which will be used to create
|
||||
a :class:`~openstack.load_balancer.v2.member.Member`,
|
||||
comprised of the properties on the Member class.
|
||||
@ -341,13 +338,13 @@ class Proxy(proxy.Proxy):
|
||||
The member can be either the ID of a member or a
|
||||
:class:`~openstack.load_balancer.v2.member.Member` instance.
|
||||
:param pool: The pool can be either the ID of a pool or a
|
||||
:class:`~openstack.load_balancer.v2.pool.Pool` instance
|
||||
that the member belongs to.
|
||||
:class:`~openstack.load_balancer.v2.pool.Pool` instance
|
||||
that the member belongs to.
|
||||
:param bool ignore_missing: When set to ``False``
|
||||
:class:`~openstack.exceptions.ResourceNotFound` will be
|
||||
raised when the member does not exist.
|
||||
When set to ``True``, no exception will be set when
|
||||
attempting to delete a nonexistent member.
|
||||
:class:`~openstack.exceptions.ResourceNotFound` will be
|
||||
raised when the member does not exist.
|
||||
When set to ``True``, no exception will be set when
|
||||
attempting to delete a nonexistent member.
|
||||
|
||||
:returns: ``None``
|
||||
"""
|
||||
@ -360,16 +357,16 @@ class Proxy(proxy.Proxy):
|
||||
|
||||
:param str name_or_id: The name or ID of a member.
|
||||
:param pool: The pool can be either the ID of a pool or a
|
||||
:class:`~openstack.load_balancer.v2.pool.Pool` instance
|
||||
that the member belongs to.
|
||||
:class:`~openstack.load_balancer.v2.pool.Pool` instance
|
||||
that the member belongs to.
|
||||
:param bool ignore_missing: When set to ``False``
|
||||
:class:`~openstack.exceptions.ResourceNotFound` will be
|
||||
raised when the resource does not exist.
|
||||
When set to ``True``, None will be returned when
|
||||
attempting to find a nonexistent resource.
|
||||
:class:`~openstack.exceptions.ResourceNotFound` will be
|
||||
raised when the resource does not exist.
|
||||
When set to ``True``, None will be returned when
|
||||
attempting to find a nonexistent resource.
|
||||
|
||||
:returns: One :class:`~openstack.load_balancer.v2.member.Member`
|
||||
or None
|
||||
or None
|
||||
"""
|
||||
poolobj = self._get_resource(_pool.Pool, pool)
|
||||
return self._find(_member.Member, name_or_id,
|
||||
@ -379,15 +376,15 @@ class Proxy(proxy.Proxy):
|
||||
"""Get a single member
|
||||
|
||||
:param member: The member can be the ID of a member or a
|
||||
:class:`~openstack.load_balancer.v2.member.Member`
|
||||
instance.
|
||||
:class:`~openstack.load_balancer.v2.member.Member`
|
||||
instance.
|
||||
:param pool: The pool can be either the ID of a pool or a
|
||||
:class:`~openstack.load_balancer.v2.pool.Pool` instance
|
||||
that the member belongs to.
|
||||
:class:`~openstack.load_balancer.v2.pool.Pool` instance
|
||||
that the member belongs to.
|
||||
|
||||
:returns: One :class:`~openstack.load_balancer.v2.member.Member`
|
||||
:raises: :class:`~openstack.exceptions.ResourceNotFound`
|
||||
when no resource can be found.
|
||||
when no resource can be found.
|
||||
"""
|
||||
poolobj = self._get_resource(_pool.Pool, pool)
|
||||
return self._get(_member.Member, member,
|
||||
@ -397,10 +394,10 @@ class Proxy(proxy.Proxy):
|
||||
"""Return a generator of members
|
||||
|
||||
:param pool: The pool can be either the ID of a pool or a
|
||||
:class:`~openstack.load_balancer.v2.pool.Pool` instance
|
||||
that the member belongs to.
|
||||
:class:`~openstack.load_balancer.v2.pool.Pool` instance
|
||||
that the member belongs to.
|
||||
:param dict query: Optional query parameters to be sent to limit
|
||||
the resources being returned. Valid parameters are:
|
||||
the resources being returned. Valid parameters are:
|
||||
|
||||
:returns: A generator of member objects
|
||||
:rtype: :class:`~openstack.load_balancer.v2.member.Member`
|
||||
@ -412,13 +409,13 @@ class Proxy(proxy.Proxy):
|
||||
"""Update a member
|
||||
|
||||
:param member: Either the ID of a member or a
|
||||
:class:`~openstack.load_balancer.v2.member.Member`
|
||||
instance.
|
||||
:class:`~openstack.load_balancer.v2.member.Member`
|
||||
instance.
|
||||
:param pool: The pool can be either the ID of a pool or a
|
||||
:class:`~openstack.load_balancer.v2.pool.Pool` instance
|
||||
that the member belongs to.
|
||||
:class:`~openstack.load_balancer.v2.pool.Pool` instance
|
||||
that the member belongs to.
|
||||
:param dict attrs: The attributes to update on the member
|
||||
represented by ``member``.
|
||||
represented by ``member``.
|
||||
|
||||
:returns: The updated member
|
||||
:rtype: :class:`~openstack.load_balancer.v2.member.Member`
|
||||
@ -442,9 +439,9 @@ class Proxy(proxy.Proxy):
|
||||
object matching the given name or id or None if nothing matches.
|
||||
|
||||
:raises: :class:`openstack.exceptions.DuplicateResource` if more
|
||||
than one resource is found for this request.
|
||||
than one resource is found for this request.
|
||||
:raises: :class:`openstack.exceptions.ResourceNotFound` if nothing
|
||||
is found and ignore_missing is ``False``.
|
||||
is found and ignore_missing is ``False``.
|
||||
"""
|
||||
return self._find(_hm.HealthMonitor, name_or_id,
|
||||
ignore_missing=ignore_missing)
|
||||
@ -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)
|
||||
|
||||
@ -482,13 +477,13 @@ class Proxy(proxy.Proxy):
|
||||
"""Retrieve a generator of health monitors
|
||||
|
||||
:param dict query: Optional query parameters to be sent to limit
|
||||
the resources being returned. Valid parameters are:
|
||||
'name', 'created_at', 'updated_at', 'delay',
|
||||
'expected_codes', 'http_method', 'max_retries',
|
||||
'max_retries_down', 'pool_id',
|
||||
'provisioning_status', 'operating_status',
|
||||
'timeout', 'project_id', 'type', 'url_path',
|
||||
'is_admin_state_up'.
|
||||
the resources being returned. Valid parameters are:
|
||||
'name', 'created_at', 'updated_at', 'delay',
|
||||
'expected_codes', 'http_method', 'max_retries',
|
||||
'max_retries_down', 'pool_id',
|
||||
'provisioning_status', 'operating_status',
|
||||
'timeout', 'project_id', 'type', 'url_path',
|
||||
'is_admin_state_up'.
|
||||
|
||||
:returns: A generator of health monitor instances
|
||||
"""
|
||||
@ -520,11 +515,11 @@ class Proxy(proxy.Proxy):
|
||||
:class:`~openstack.load_balancer.v2.healthmonitor.HealthMonitor`
|
||||
instance
|
||||
:param dict attrs: The attributes to update on the health monitor
|
||||
represented by ``healthmonitor``.
|
||||
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)
|
||||
@ -533,8 +528,8 @@ class Proxy(proxy.Proxy):
|
||||
"""Create a new l7policy from attributes
|
||||
|
||||
:param dict attrs: Keyword arguments which will be used to create a
|
||||
:class:`~openstack.load_balancer.v2.l7_policy.L7Policy`,
|
||||
comprised of the properties on the L7Policy class.
|
||||
:class:`~openstack.load_balancer.v2.l7_policy.L7Policy`,
|
||||
comprised of the properties on the L7Policy class.
|
||||
|
||||
:returns: The results of l7policy creation
|
||||
:rtype: :class:`~openstack.load_balancer.v2.l7_policy.L7Policy`
|
||||
@ -545,12 +540,12 @@ class Proxy(proxy.Proxy):
|
||||
"""Delete a l7policy
|
||||
|
||||
:param l7_policy: The value can be either the ID of a l7policy or a
|
||||
:class:`~openstack.load_balancer.v2.l7_policy.L7Policy` instance.
|
||||
:class:`~openstack.load_balancer.v2.l7_policy.L7Policy` instance.
|
||||
:param bool ignore_missing: When set to ``False``
|
||||
:class:`~openstack.exceptions.ResourceNotFound` will be
|
||||
raised when the l7policy does not exist.
|
||||
When set to ``True``, no exception will be set when
|
||||
attempting to delete a nonexistent l7policy.
|
||||
:class:`~openstack.exceptions.ResourceNotFound` will be
|
||||
raised when the l7policy does not exist.
|
||||
When set to ``True``, no exception will be set when
|
||||
attempting to delete a nonexistent l7policy.
|
||||
|
||||
:returns: ``None``
|
||||
"""
|
||||
@ -562,13 +557,13 @@ class Proxy(proxy.Proxy):
|
||||
|
||||
:param name_or_id: The name or ID of a l7policy.
|
||||
:param bool ignore_missing: When set to ``False``
|
||||
:class:`~openstack.exceptions.ResourceNotFound` will be
|
||||
raised when the resource does not exist.
|
||||
When set to ``True``, None will be returned when
|
||||
attempting to find a nonexistent resource.
|
||||
:class:`~openstack.exceptions.ResourceNotFound` will be
|
||||
raised when the resource does not exist.
|
||||
When set to ``True``, None will be returned when
|
||||
attempting to find a nonexistent resource.
|
||||
|
||||
:returns: One :class:`~openstack.load_balancer.v2.l7_policy.L7Policy`
|
||||
or None
|
||||
or None
|
||||
"""
|
||||
return self._find(_l7policy.L7Policy, name_or_id,
|
||||
ignore_missing=ignore_missing)
|
||||
@ -577,12 +572,12 @@ class Proxy(proxy.Proxy):
|
||||
"""Get a single l7policy
|
||||
|
||||
:param l7_policy: The value can be the ID of a l7policy or a
|
||||
:class:`~openstack.load_balancer.v2.l7_policy.L7Policy`
|
||||
instance.
|
||||
:class:`~openstack.load_balancer.v2.l7_policy.L7Policy`
|
||||
instance.
|
||||
|
||||
:returns: One :class:`~openstack.load_balancer.v2.l7_policy.L7Policy`
|
||||
:raises: :class:`~openstack.exceptions.ResourceNotFound`
|
||||
when no resource can be found.
|
||||
when no resource can be found.
|
||||
"""
|
||||
return self._get(_l7policy.L7Policy, l7_policy)
|
||||
|
||||
@ -590,7 +585,7 @@ class Proxy(proxy.Proxy):
|
||||
"""Return a generator of l7policies
|
||||
|
||||
:param dict query: Optional query parameters to be sent to limit
|
||||
the resources being returned. Valid parameters are:
|
||||
the resources being returned. Valid parameters are:
|
||||
|
||||
:returns: A generator of l7policy objects
|
||||
:rtype: :class:`~openstack.load_balancer.v2.l7_policy.L7Policy`
|
||||
@ -601,10 +596,10 @@ class Proxy(proxy.Proxy):
|
||||
"""Update a l7policy
|
||||
|
||||
:param l7_policy: Either the id of a l7policy or a
|
||||
:class:`~openstack.load_balancer.v2.l7_policy.L7Policy`
|
||||
instance.
|
||||
:class:`~openstack.load_balancer.v2.l7_policy.L7Policy`
|
||||
instance.
|
||||
:param dict attrs: The attributes to update on the l7policy
|
||||
represented by ``l7policy``.
|
||||
represented by ``l7policy``.
|
||||
|
||||
:returns: The updated l7policy
|
||||
:rtype: :class:`~openstack.load_balancer.v2.l7_policy.L7Policy`
|
||||
@ -615,8 +610,8 @@ class Proxy(proxy.Proxy):
|
||||
"""Create a new l7rule from attributes
|
||||
|
||||
:param l7_policy: The l7_policy can be either the ID of a l7policy or
|
||||
:class:`~openstack.load_balancer.v2.l7_policy.L7Policy`
|
||||
instance that the l7rule will be created in.
|
||||
:class:`~openstack.load_balancer.v2.l7_policy.L7Policy`
|
||||
instance that the l7rule will be created in.
|
||||
:param dict attrs: Keyword arguments which will be used to create
|
||||
a :class:`~openstack.load_balancer.v2.l7_rule.L7Rule`,
|
||||
comprised of the properties on the L7Rule class.
|
||||
@ -635,13 +630,13 @@ class Proxy(proxy.Proxy):
|
||||
The l7rule can be either the ID of a l7rule or a
|
||||
:class:`~openstack.load_balancer.v2.l7_rule.L7Rule` instance.
|
||||
:param l7_policy: The l7_policy can be either the ID of a l7policy or
|
||||
:class:`~openstack.load_balancer.v2.l7_policy.L7Policy`
|
||||
instance that the l7rule belongs to.
|
||||
:class:`~openstack.load_balancer.v2.l7_policy.L7Policy`
|
||||
instance that the l7rule belongs to.
|
||||
:param bool ignore_missing: When set to ``False``
|
||||
:class:`~openstack.exceptions.ResourceNotFound` will be
|
||||
raised when the l7rule does not exist.
|
||||
When set to ``True``, no exception will be set when
|
||||
attempting to delete a nonexistent l7rule.
|
||||
:class:`~openstack.exceptions.ResourceNotFound` will be
|
||||
raised when the l7rule does not exist.
|
||||
When set to ``True``, no exception will be set when
|
||||
attempting to delete a nonexistent l7rule.
|
||||
|
||||
:returns: ``None``
|
||||
"""
|
||||
@ -654,16 +649,16 @@ class Proxy(proxy.Proxy):
|
||||
|
||||
:param str name_or_id: The name or ID of a l7rule.
|
||||
:param l7_policy: The l7_policy can be either the ID of a l7policy or
|
||||
:class:`~openstack.load_balancer.v2.l7_policy.L7Policy`
|
||||
instance that the l7rule belongs to.
|
||||
:class:`~openstack.load_balancer.v2.l7_policy.L7Policy`
|
||||
instance that the l7rule belongs to.
|
||||
:param bool ignore_missing: When set to ``False``
|
||||
:class:`~openstack.exceptions.ResourceNotFound` will be
|
||||
raised when the resource does not exist.
|
||||
When set to ``True``, None will be returned when
|
||||
attempting to find a nonexistent resource.
|
||||
:class:`~openstack.exceptions.ResourceNotFound` will be
|
||||
raised when the resource does not exist.
|
||||
When set to ``True``, None will be returned when
|
||||
attempting to find a nonexistent resource.
|
||||
|
||||
:returns: One :class:`~openstack.load_balancer.v2.l7_rule.L7Rule`
|
||||
or None
|
||||
or None
|
||||
"""
|
||||
l7policyobj = self._get_resource(_l7policy.L7Policy, l7_policy)
|
||||
return self._find(_l7rule.L7Rule, name_or_id,
|
||||
@ -674,15 +669,15 @@ class Proxy(proxy.Proxy):
|
||||
"""Get a single l7rule
|
||||
|
||||
:param l7rule: The l7rule can be the ID of a l7rule or a
|
||||
:class:`~openstack.load_balancer.v2.l7_rule.L7Rule`
|
||||
instance.
|
||||
:class:`~openstack.load_balancer.v2.l7_rule.L7Rule`
|
||||
instance.
|
||||
:param l7_policy: The l7_policy can be either the ID of a l7policy or
|
||||
:class:`~openstack.load_balancer.v2.l7_policy.L7Policy`
|
||||
instance that the l7rule belongs to.
|
||||
:class:`~openstack.load_balancer.v2.l7_policy.L7Policy`
|
||||
instance that the l7rule belongs to.
|
||||
|
||||
:returns: One :class:`~openstack.load_balancer.v2.l7_rule.L7Rule`
|
||||
:raises: :class:`~openstack.exceptions.ResourceNotFound`
|
||||
when no resource can be found.
|
||||
when no resource can be found.
|
||||
"""
|
||||
l7policyobj = self._get_resource(_l7policy.L7Policy, l7_policy)
|
||||
return self._get(_l7rule.L7Rule, l7rule,
|
||||
@ -692,10 +687,10 @@ class Proxy(proxy.Proxy):
|
||||
"""Return a generator of l7rules
|
||||
|
||||
:param l7_policy: The l7_policy can be either the ID of a l7_policy or
|
||||
:class:`~openstack.load_balancer.v2.l7_policy.L7Policy`
|
||||
instance that the l7rule belongs to.
|
||||
:class:`~openstack.load_balancer.v2.l7_policy.L7Policy`
|
||||
instance that the l7rule belongs to.
|
||||
:param dict query: Optional query parameters to be sent to limit
|
||||
the resources being returned. Valid parameters are:
|
||||
the resources being returned. Valid parameters are:
|
||||
|
||||
:returns: A generator of l7rule objects
|
||||
:rtype: :class:`~openstack.load_balancer.v2.l7_rule.L7Rule`
|
||||
@ -707,13 +702,13 @@ class Proxy(proxy.Proxy):
|
||||
"""Update a l7rule
|
||||
|
||||
:param l7rule: Either the ID of a l7rule or a
|
||||
:class:`~openstack.load_balancer.v2.l7_rule.L7Rule`
|
||||
instance.
|
||||
:class:`~openstack.load_balancer.v2.l7_rule.L7Rule`
|
||||
instance.
|
||||
:param l7_policy: The l7_policy can be either the ID of a l7policy or
|
||||
:class:`~openstack.load_balancer.v2.l7_policy.L7Policy`
|
||||
instance that the l7rule belongs to.
|
||||
:class:`~openstack.load_balancer.v2.l7_policy.L7Policy`
|
||||
instance that the l7rule belongs to.
|
||||
:param dict attrs: The attributes to update on the l7rule
|
||||
represented by ``l7rule``.
|
||||
represented by ``l7rule``.
|
||||
|
||||
:returns: The updated l7rule
|
||||
:rtype: :class:`~openstack.load_balancer.v2.l7_rule.L7Rule`
|
||||
@ -726,8 +721,8 @@ class Proxy(proxy.Proxy):
|
||||
"""Return a generator of quotas
|
||||
|
||||
:param dict query: Optional query parameters to be sent to limit
|
||||
the resources being returned. Currently no query
|
||||
parameter is supported.
|
||||
the resources being returned. Currently no query
|
||||
parameter is supported.
|
||||
|
||||
:returns: A generator of quota objects
|
||||
:rtype: :class:`~openstack.load_balancer.v2.quota.Quota`
|
||||
@ -738,13 +733,13 @@ class Proxy(proxy.Proxy):
|
||||
"""Get a quota
|
||||
|
||||
:param quota: The value can be the ID of a quota or a
|
||||
:class:`~openstack.load_balancer.v2.quota.Quota`
|
||||
instance. The ID of a quota is the same as the project
|
||||
ID for the quota.
|
||||
:class:`~openstack.load_balancer.v2.quota.Quota`
|
||||
instance. The ID of a quota is the same as the project
|
||||
ID for the quota.
|
||||
|
||||
:returns: One :class:`~openstack.load_balancer.v2.quota.Quota`
|
||||
:raises: :class:`~openstack.exceptions.ResourceNotFound`
|
||||
when no resource can be found.
|
||||
when no resource can be found.
|
||||
"""
|
||||
return self._get(_quota.Quota, quota)
|
||||
|
||||
@ -752,11 +747,11 @@ class Proxy(proxy.Proxy):
|
||||
"""Update a quota
|
||||
|
||||
:param quota: Either the ID of a quota or a
|
||||
:class:`~openstack.load_balancer.v2.quota.Quota`
|
||||
instance. The ID of a quota is the same as the
|
||||
project ID for the quota.
|
||||
:class:`~openstack.load_balancer.v2.quota.Quota`
|
||||
instance. The ID of a quota is the same as the
|
||||
project ID for the quota.
|
||||
:param dict attrs: The attributes to update on the quota represented
|
||||
by ``quota``.
|
||||
by ``quota``.
|
||||
|
||||
:returns: The updated quota
|
||||
:rtype: :class:`~openstack.load_balancer.v2.quota.Quota`
|
||||
@ -774,14 +769,14 @@ class Proxy(proxy.Proxy):
|
||||
"""Delete a quota (i.e. reset to the default quota)
|
||||
|
||||
:param quota: The value can be either the ID of a quota or a
|
||||
:class:`~openstack.load_balancer.v2.quota.Quota`
|
||||
instance. The ID of a quota is the same as the
|
||||
project ID for the quota.
|
||||
:class:`~openstack.load_balancer.v2.quota.Quota`
|
||||
instance. The ID of a quota is the same as the
|
||||
project ID for the quota.
|
||||
:param bool ignore_missing: When set to ``False``
|
||||
:class:`~openstack.exceptions.ResourceNotFound` will be
|
||||
raised when quota does not exist.
|
||||
When set to ``True``, no exception will be set when
|
||||
attempting to delete a nonexistent quota.
|
||||
:class:`~openstack.exceptions.ResourceNotFound` will be
|
||||
raised when quota does not exist.
|
||||
When set to ``True``, no exception will be set when
|
||||
attempting to delete a nonexistent quota.
|
||||
|
||||
:returns: ``None``
|
||||
"""
|
||||
@ -805,27 +800,25 @@ 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`
|
||||
:class:`~openstack.load_balancer.v2.flavor_profile.FlavorProfile`
|
||||
"""
|
||||
return self._get(_flavor_profile.FlavorProfile, *attrs)
|
||||
|
||||
@ -875,11 +868,11 @@ class Proxy(proxy.Proxy):
|
||||
:class:`~openstack.load_balancer.v2.flavor_profile.FlavorProfile`
|
||||
instance
|
||||
:param dict attrs: The attributes to update on the flavor profile
|
||||
represented by ``flavor_profile``.
|
||||
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`
|
||||
@ -901,10 +893,10 @@ class Proxy(proxy.Proxy):
|
||||
"""Get a flavor
|
||||
|
||||
:param flavor: The value can be the name of a flavor
|
||||
or :class:`~openstack.load_balancer.v2.flavor.Flavor` instance.
|
||||
or :class:`~openstack.load_balancer.v2.flavor.Flavor` instance.
|
||||
|
||||
:returns: One
|
||||
:class:`~openstack.load_balancer.v2.flavor.Flavor`
|
||||
:class:`~openstack.load_balancer.v2.flavor.Flavor`
|
||||
"""
|
||||
return self._get(_flavor.Flavor, *attrs)
|
||||
|
||||
@ -951,7 +943,7 @@ class Proxy(proxy.Proxy):
|
||||
:param flavor: The flavor can be either the name or a
|
||||
:class:`~openstack.load_balancer.v2.flavor.Flavor` instance
|
||||
:param dict attrs: The attributes to update on the flavor
|
||||
represented by ``flavor``.
|
||||
represented by ``flavor``.
|
||||
|
||||
:returns: The updated flavor
|
||||
:rtype: :class:`~openstack.load_balancer.v2.flavor.Flavor`
|
||||
@ -969,10 +961,10 @@ class Proxy(proxy.Proxy):
|
||||
"""Get a amphora
|
||||
|
||||
:param amphora: The value can be the ID of an amphora
|
||||
or :class:`~openstack.load_balancer.v2.amphora.Amphora` instance.
|
||||
or :class:`~openstack.load_balancer.v2.amphora.Amphora` instance.
|
||||
|
||||
:returns: One
|
||||
:class:`~openstack.load_balancer.v2.amphora.Amphora`
|
||||
:class:`~openstack.load_balancer.v2.amphora.Amphora`
|
||||
"""
|
||||
return self._get(_amphora.Amphora, *attrs)
|
||||
|
||||
@ -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,12 +1020,12 @@ 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`
|
||||
:class:`~openstack.load_balancer.v2.availability_zone_profile.AvailabilityZoneProfile`
|
||||
"""
|
||||
return self._get(_availability_zone_profile.AvailabilityZoneProfile,
|
||||
*attrs)
|
||||
@ -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:
|
||||
@ -1118,12 +1107,12 @@ class Proxy(proxy.Proxy):
|
||||
"""Get an availability zone
|
||||
|
||||
:param availability_zone: The value can be the name of a
|
||||
availability_zone or
|
||||
:class:`~openstack.load_balancer.v2.availability_zone.AvailabilityZone`
|
||||
instance.
|
||||
availability_zone or
|
||||
:class:`~openstack.load_balancer.v2.availability_zone.AvailabilityZone`
|
||||
instance.
|
||||
|
||||
:returns: One
|
||||
:class:`~openstack.load_balancer.v2.availability_zone.AvailabilityZone`
|
||||
:class:`~openstack.load_balancer.v2.availability_zone.AvailabilityZone`
|
||||
"""
|
||||
return self._get(_availability_zone.AvailabilityZone, *attrs)
|
||||
|
||||
@ -1175,7 +1164,7 @@ class Proxy(proxy.Proxy):
|
||||
:class:`~openstack.load_balancer.v2.availability_zone.AvailabilityZone`
|
||||
instance
|
||||
:param dict attrs: The attributes to update on the availability_zone
|
||||
represented by ``availability_zone``.
|
||||
represented by ``availability_zone``.
|
||||
|
||||
:returns: The updated availability_zone
|
||||
:rtype:
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user