onapsdk.cps package

Submodules

onapsdk.cps.anchor module

ONAP SDK CPS anchor module.

class onapsdk.cps.anchor.Anchor(name, schema_set)

Bases: onapsdk.cps.cps_element.CpsElement

CPS anchor class.

add_list_node(xpath, node_data)

Add an element to the list node of an anchor.

Parameters

• xpath (str) – Xpath to the list node.

• node_data (str) – Data to be added.

Return type

None

create_node(node_data)

Create anchor node.

Fill CPS anchor with a data.

Parameters

node_data (str) – Node data. Should be JSON formatted.

Return type

None

delete()

Delete anchor.

Return type

None

delete_nodes(xpath)

Delete nodes.

Use XPATH to delete Anchor nodes.

Parameters

xpath (str) – Nodes to delete

Return type

None

get_node(xpath, include_descendants=False)

Get anchor node data.

Using XPATH get anchor’s node data.

Parameters

• xpath (str) – Anchor node xpath.

• include_descendants (bool, optional) – Determies if descendants should be included in response. Defaults to False.

Returns

Anchor node data.

Return type

Dict[Any, Any]

query_node(query, include_descendants=False)

Query CPS anchor data.

Parameters

• query (str) – Query

• include_descendants (bool, optional) – Determies if descendants should be included in response. Defaults to False.

Returns

Query return values.

Return type

Dict[Any, Any]

replace_node(xpath, node_data)

Replace anchor node data.

Using XPATH replace anchor’s node data.

Parameters

• xpath (str) – Anchor node xpath.

• node_data (str) – Node data.

Return type

None

update_node(xpath, node_data)

Update anchor node data.

Using XPATH update anchor’s node data.

Parameters

• xpath (str) – Anchor node xpath.

• node_data (str) – Node data.

Return type

None

property url

Anchor url.

Returns

Anchor url

Return type

str

onapsdk.cps.cps_element module

ONAP SDK CPS element module.

class onapsdk.cps.cps_element.CpsElement

Bases: onapsdk.onap_service.OnapService

Mother Class of all CPS elements.

auth: tuple = ('cpsuser', 'cpsr0cks!')

onapsdk.cps.dataspace module

ONAP SDK CPS dataspace module.

class onapsdk.cps.dataspace.Dataspace(name)

Bases: onapsdk.cps.cps_element.CpsElement

CPS dataspace class.

classmethod create(dataspace_name)

Create dataspace with given name.

Parameters

dataspace_name (str) – Dataspace name

Returns

Newly created dataspace

Return type

Dataspace

create_anchor(schema_set, anchor_name)

Create anchor.

Parameters

• schema_set (SchemaSet) – Schema set object which is going to be used to create anchor.

• anchor_name (str) – Anchor name

Returns

Created anchor

Return type

Anchor

create_schema_set(schema_set_name, schema_set)

Create schema set.

Create CPS schema set in dataspace

Parameters

• schema_set_name (str) – Schema set name

• schema_set (bytes) – Schema set YANG

Returns

Created schema set object

Return type

SchemaSet

delete()

Delete dataspace.

Return type

None

get_anchor(anchor_name)

Get dataspace anchor by name.

To get anchor there is no need to use SchemaSet object, but to create anchor it it.

Parameters

anchor_name (str) – Anchor name.

Returns

Anchor object

Return type

Anchor

get_anchors()

Get all dataspace’s anchors.

Iterable of related with dataspace anchors.

Yields

Iterator[Anchor] – Anchor object

Return type

Iterable[Anchor]

get_schema_set(schema_set_name)

Get schema set by name.

Parameters

schema_set_name (str) – Schema set name

Returns

Schema set object

Return type

SchemaSet

property url

Dataspace url.

Returns

Dataspace url

Return type

str

onapsdk.cps.schemaset module

ONAP SDK CPS schemaset module.

class onapsdk.cps.schemaset.SchemaSet(name, dataspace, module_references=None)

Bases: onapsdk.cps.cps_element.CpsElement

Schema set class.

delete()

Delete schema set.

Return type

None

class onapsdk.cps.schemaset.SchemaSetModuleReference(name, namespace, revision)

Bases: object

Schema set module reference dataclass.

Stores all information about module reference.

name: str

namespace: str

revision: str

Module contents

ONAP SDK CPS package.