X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=osm_common%2Fdataclasses%2Ftemporal_dataclasses.py;h=a0e3d19bd066a750f2349937fcf47280e02ae183;hb=4ddf2c7055362b6f06ffc5b341f0cd0b54661fe6;hp=9bd637808f9ba36b839b4c00d0e17fb3318581eb;hpb=36a62b88b9ad60b2355fab6ab2868c5f10b192c7;p=osm%2Fcommon.git diff --git a/osm_common/dataclasses/temporal_dataclasses.py b/osm_common/dataclasses/temporal_dataclasses.py index 9bd6378..a0e3d19 100644 --- a/osm_common/dataclasses/temporal_dataclasses.py +++ b/osm_common/dataclasses/temporal_dataclasses.py @@ -18,6 +18,48 @@ from dataclasses import dataclass from enum import auto, IntEnum + +####################################################################################### +# Defining States +class VimState(IntEnum): + PROCESSING = auto() + ENABLED = auto() + ERROR = auto() + + +class VimOperationState(IntEnum): + COMPLETED = auto() + FAILED = auto() + + +class NsState(IntEnum): + PROCESSING = auto() + INSTANTIATED = auto() + ERROR = auto() + + +class VnfLcmOperationState(IntEnum): + PROCESSING = auto() + COMPLETED = auto() + FAILED = auto() + + +class VnfInstantiationState(IntEnum): + NOT_INSTANTIATED = auto() + INSTANTIATED = auto() + + +class VnfState(IntEnum): + STOPPED = auto() + STARTED = auto() + + +class LcmOperationState(IntEnum): + PROCESSING = auto() + COMPLETED = auto() + FAILED = auto() + + ####################################################################################### # Workflow Dataclasses @@ -118,14 +160,40 @@ class VduInstantiateInput: charm_info: CharmInfo -####################################################################################### -# Activity Dataclasses +@dataclass +class VnfInstantiateInput: + """ + Input dataclass for workflow that instantiates a VNF. + + Attributes: + ----------- + vnfr_uuid : str + The UUID of the VNF which is stored in the OSM vnfrs + collection in Mongo. + """ -class LcmOperationState(IntEnum): - PROCESSING = auto() - COMPLETED = auto() - FAILED = auto() + vnfr_uuid: str + + +@dataclass +class PrepareVnfInput: + """ + Input dataclass for workflow that instantiates a VNF. + + Attributes: + ----------- + vnfr_uuid : str + The UUID of the VNF which is stored in the OSM vnfrs + collection in Mongo. + + """ + + vnfr_uuid: str + + +####################################################################################### +# Activity Dataclasses @dataclass @@ -181,12 +249,6 @@ class TestVimConnectivityInput: vim_uuid: str -class VimState(IntEnum): - PROCESSING = auto() - ENABLED = auto() - ERROR = auto() - - @dataclass class UpdateVimStateInput: """ @@ -213,11 +275,6 @@ class UpdateVimStateInput: message: str -class VimOperationState(IntEnum): - COMPLETED = auto() - FAILED = auto() - - @dataclass class UpdateVimOperationStateInput: """ @@ -281,12 +338,6 @@ class DeployNsInput: ns_uuid: str -class NsState(IntEnum): - PROCESSING = auto() - INSTANTIATED = auto() - ERROR = auto() - - @dataclass class UpdateNsStateInput: """ @@ -314,9 +365,9 @@ class UpdateNsStateInput: @dataclass -class CreateModelInput: +class ModelInfo: """ - Input dataclass for creating a Juju Model. + Contains the information related to a model. Attributes: ----------- @@ -325,8 +376,77 @@ class CreateModelInput: collection in Mongo. model_name : str - Name of the model to create in Juju. + Name of the Juju model used to deploy charms. """ vim_uuid: str model_name: str + + +@dataclass +class ChangeNFStateInput: + """ + Input dataclass for creating a Juju Model. + + Attributes: + ----------- + vnfr_uuid : str + The UUID of the VNF which is stored in the OSM vnfrs + collection in Mongo. + + nf_state : VnfState + A representation of the VNF state (STOPPED or STARTED). + """ + + vnfr_uuid: str + state: VnfState + + +@dataclass +class ChangeNFInstantiationStateInput: + """ + Input dataclass for creating a Juju Model. + + Attributes: + ----------- + vnfr_uuid : str + The UUID of the VNF which is stored in the OSM vnfrs + collection in Mongo. + + nf_instantiation_state : VnfInstantiationState + A representation of the VNF instantiation state (NOT_INSTANTIATED or INSTANTIATED). + + """ + + vnfr_uuid: str + state: VnfInstantiationState + + +@dataclass +class GetTaskQueueInput: + """ + Input dataclass for creating a Juju Model. + + Attributes: + ----------- + vnfr_uuid : str + The UUID of the VNF which is stored in the OSM vnfrs + collection in Mongo. + + """ + + vnfr_uuid: str + + +@dataclass +class GetTaskQueueOutput: + """ + Output dataclass for get task queue activity. + + Attributes: + ----------- + task_queue : str + Name of the queue which is used to Deploy VNF. + """ + + task_queue: str