onapsdk.aai package

Subpackages

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

headers: Dict[str, str] = {'Accept': 'application/json', 'Content-Type': 'application/json', 'authorization': 'Basic QUFJOkFBSQ==', 'x-fromappid': 'AAI', 'x-transactionid': '0a3f6713-ba96-4971-a6f8-c2da85a3176e'}
name: str = 'AAI'
server: str = 'AAI'
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

None

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

int

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

Return type

Dict[str, str]

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

str

property relationships

Resource relationships iterator.

Yields

Relationship – resource relationship

Raises

RelationshipNotFound – if request for relationships returned 404

Return type

Iterator[Relationship]

property url

Resource’s url.

Returns

Resource’s urldataclasse init a field

Return type

str

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

Parameters

relationship_key (str) – Key to get relationship data value

Returns

Relationship value or None if relationship data

with provided ket doesn’t exist

Return type

Optional[str]

related_to: str
related_to_property: List[Dict[str, str]]
relationship_data: List[Dict[str, str]]
relationship_label: str = ''

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()

Get all models.

Yields

Model – Model object

Return type

Iterator[Model]

classmethod get_all_url()

Return url to get all models.

Returns

Url to get all models

Return type

str

property url

Model instance url.

Returns

Model’s url

Return type

str

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.

Parameters
  • service_id (str) – service ID

  • service_description (str) – service description

Return type

None

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

str

property url

Service object url.

Returns

Service object url address

Return type

str

Module contents

ONAP SDK AAI package.