osm_common/dataclasses/temporal_dataclasses.py

#######################################################################################
# Copyright ETSI Contributors and Others.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
# implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#######################################################################################

from dataclasses import dataclass

# Workflow Dataclasses


@dataclass
class VimOperationInput:
    """
    Input dataclass for workflows that perform operations
    (create, update, delete) on VIMs.

    Attributes:
    -----------
    vim_uuid : str
        The UUID of the VIM account as stored in the OSM vim
        collection in Mongo

    op_id: str
        The operation (task) id for this workflow.  This is used
        by the workflow at the end to update the status of the
        operation in Mongo vim collection.
    """
    vim_uuid: str
    op_id: str


# Activity Dataclasses


@dataclass
class TestVimConnectivityInput:
    """
    Input dataclass for the Test Vim Connectivity Ativity

    Attributes:
    -----------
    vim_uuid : str
        The UUID of the VIM account as stored in the OSM vim
        collection in Mongo
    """
    vim_uuid: str


@dataclass
class UpdateVimStateInput:
    """
    Input dataclass for updating VIM state in the DB

    Attributes:
    -----------
    vim_uuid : str
        The UUID of the VIM account as stored in the OSM vim
        collection in Mongo

    operational_state : str
        A representation of the operational state (ENABLED or ERROR)
        of the VIM.

    message : str
        Human readable message providing additional details to the
        operational state, such as the error message associated
        with the ERROR operational_state.
    """
    vim_uuid: str
    operational_state: str
    message: str


@dataclass
class UpdateVimOperationStateInput:
    """
    Input dataclass for updating VIM Operations in the Mongo VIM
    collection.

    Attributes:
    -----------
    vim_uuid : str
        The UUID of the VIM account as stored in the OSM vim
        collection in Mongo

    op_id: str
        The operation (task) id for this workflow.  This is used
        to update the status of the operation in Mongo vim collection.

    op_state : str
        A representation of the state of the specified operation id,
        such as COMPLETED, or FAILED.

    message : str
        Human readable message providing additional details to the
        operation state, such as the error message explaining why
        the operation failed.
    """
    vim_uuid: str
    op_id: str
    op_state: str
    message: str