Source code for kappa_sdk.data_kind_enum

from enum import Enum




class DataKindEnum(Enum):
    """ Data kind enumeration.

    An enumeration of the kind of the :class:`Data` (e.g. gauge, basic data).
    """

    gauge = "Gauge"
    """ Gauge data.

    This kind of data originates from a data-source defined in the KAPPA Automate. This data is automatically mirrored.
    """

    basic_data = "BasicData"
    """ Basic data.

    This generic kind of data is created in the KAPPA Automate (although it can also be originating from an external data-source).
    It can be managed / updated by automation processes or externally (e.g. via ``kappa_sdk``).
    """

    data = "Data"
    """ General data type.

    Base data representation used for common data operations.
    """

    filter = "Filter"
    """ Filter data.

    This kind of data represents a filter created on other data.
    """

    shutin = "Shutin"
    """  Shut-in data representation.

    This represents periods when wells are intentionally closed for various operational reasons.
    """

    detected_shutin = "DetectedShutin"
    """ Alternative Shut-in data.

    This kind of logical data contains a detected shut-in.
    """

    function = "Function"
    """ Function data type.

    Represents data that is derived from a K-A Function.
    """

    production = "RawProduction"
    """ Raw production data.

    Contains data under a production folder.
    """

    corrected_production = "CorrectedProduction"
    """ Corrected production data.

    Contains data under a corrected production folder.
    """