onapsdk.aai package¶
Subpackages¶
- onapsdk.aai.business package
- Submodules
- onapsdk.aai.business.customer module
- onapsdk.aai.business.instance module
- onapsdk.aai.business.line_of_business module
- onapsdk.aai.business.network module
- onapsdk.aai.business.owning_entity module
- onapsdk.aai.business.platform module
- onapsdk.aai.business.pnf module
- onapsdk.aai.business.project module
- onapsdk.aai.business.service module
- onapsdk.aai.business.sp_partner module
- onapsdk.aai.business.vf_module module
- onapsdk.aai.business.vnf module
- Module contents
- onapsdk.aai.cloud_infrastructure package
Submodules¶
onapsdk.aai.aai_element module¶
AAI Element module.
-
class
onapsdk.aai.aai_element.
AaiElement
¶ Bases:
onapsdk.onap_service.OnapService
Mother Class of all A&AI elements.
-
api_version
= '/aai/v23'¶
-
base_url
= 'https://aai.api.sparky.simpledemo.onap.org:30233'¶
-
classmethod
get_guis
()¶ Retrieve the status of the AAI GUIs.
Only one GUI is referenced for AAI the AAI sparky GUI
Return the list of GUIs
- Return type
GuiItem
-
-
class
onapsdk.aai.aai_element.
AaiResource
¶ Bases:
onapsdk.aai.aai_element.AaiElement
A&AI resource class.
-
add_relationship
(relationship)¶ Add relationship to aai resource.
Add relationship to resource using A&AI API
- Parameters
relationship (Relationship) – Relationship to add
- Return type
-
classmethod
count
(*args, **kwargs)¶ Get the count number of all objects of given class.
- Get the response, iterate through response (each class has different response)
– the first key value is the count.
- Returns
Count of the objects
- Return type
-
classmethod
filter_none_key_values
(dict_to_filter)¶ Filter out None key values from dictionary.
Iterate through given dictionary and filter None values.
- Parameters
dict_to_filter (Dict) – Dictionary to filter out None
- Returns:dataclasse init a field
Dict[str, str]: Filtered dictionary
-
classmethod
get_all_url
(*args, **kwargs)¶ Return an url for all objects of given class.
- Returns
URL to get all objects of given class
- Return type
-
property
relationships
¶ Resource relationships iterator.
- Yields
Relationship – resource relationship
- Raises
RelationshipNotFound – if request for relationships returned 404
- Return type
-
-
class
onapsdk.aai.aai_element.
Relationship
(related_to, related_link, relationship_data, relationship_label='', related_to_property=<factory>)¶ Bases:
object
Relationship class.
A&AI elements could have relationship with other A&AI elements. Relationships are represented by this class objects.
-
get_relationship_data
(relationship_key)¶ Get relationship data for given relationship key.
- From list of relationship data get the value for
given key
-
onapsdk.aai.bulk module¶
onapsdk.aai.service_design_and_creation module¶
AAI service-design-and-creation module.
-
class
onapsdk.aai.service_design_and_creation.
Model
(invariant_id, model_type, resource_version)¶ Bases:
onapsdk.aai.aai_element.AaiResource
Model resource class.
-
classmethod
get_all_url
()¶ Return url to get all models.
- Returns
Url to get all models
- Return type
-
classmethod
-
class
onapsdk.aai.service_design_and_creation.
Service
(service_id, service_description, resource_version)¶ Bases:
onapsdk.aai.aai_element.AaiResource
SDC service class.
-
classmethod
create
(service_id, service_description)¶ Create service.
-
classmethod
get_all
(service_id=None, service_description=None)¶ Services iterator.
Stand-in for service model definitions.
- Returns
Service
- Return type
Iterator[Service]
-
classmethod
get_all_url
()¶ Return url to get all services.
- Returns
Url to get all services
- Return type
-
classmethod
Module contents¶
ONAP SDK AAI package.