Merge "Move examples service filter to code"

This commit is contained in:
Jenkins
2014-11-11 20:53:16 +00:00
committed by Gerrit Code Review
2 changed files with 29 additions and 29 deletions

View File

@@ -8,32 +8,3 @@ ServiceFilter object
.. autoclass:: openstack.auth.service_filter.ServiceFilter
:members:
Examples
--------
The :class:`~openstack.auth.service_filter.ServiceFilter` class can be built
with a service type, visibility, region, name, and version.
Create a service filter
~~~~~~~~~~~~~~~~~~~~~~~
Create a compute service and service preference. Join the services
and match::
from openstack.auth import service_filter
from openstack.compute import compute_service
default = compute_service.ComputeService()
preference = service_filter.ServiceFilter('compute', version='v2')
result = preference.join(default)
matches = (result.match_service_type('compute') and
result.match_service_name('Hal9000') and
result.match_region('DiscoveryOne') and
result.match_visibility('public'))
print(str(result))
print("matches=" + str(matches))
The resulting output from the code::
service_type=compute,visibility=public,version=v2
matches=True

View File

@@ -20,6 +20,35 @@ The preferences are stored in the
:class:`~openstack.user_preference.UserPreference` object.
The service preference and the service identifier are joined to create a
filter to match a service.
Examples
--------
The :class:`~openstack.auth.service_filter.ServiceFilter` class can be built
with a service type, visibility, region, name, and version.
Create a service filter
~~~~~~~~~~~~~~~~~~~~~~~
Create a compute service and service preference. Join the services
and match::
from openstack.auth import service_filter
from openstack.compute import compute_service
default = compute_service.ComputeService()
preference = service_filter.ServiceFilter('compute', version='v2')
result = preference.join(default)
matches = (result.match_service_type('compute') and
result.match_service_name('Hal9000') and
result.match_region('DiscoveryOne') and
result.match_visibility('public'))
print(str(result))
print("matches=" + str(matches))
The resulting output from the code::
service_type=compute,visibility=public,version=v2
matches=True
"""
from openstack import exceptions