kepconfig.structures

 1# -------------------------------------------------------------------------
 2# Copyright (c) PTC Inc. and/or all its affiliates. All rights reserved.
 3# See License.txt in the project root for
 4# license information.
 5# --------------------------------------------------------------------------
 6
 7r"""`structures` provides general data structures to help manage 
 8various objects for Kepware's configuration
 9"""
10from enum import Enum
11
12class KepServiceResponse:
13    '''A class to represent a return object when calling a "service" API of Kepware. This is
14    used to return the responses when a "service" is executed appropriately
15
16    :param code: HTTP code returned
17
18    :param message: return from the "service" call
19
20    :param href: URL reference to the JOB that is created by the service API
21    '''
22
23    def __init__(self, code: str = '', message: str = '', href: str = ''):
24        self.code = code
25        self.message = message
26        self.href = href
27    
28    def __str__(self):
29        return '{"code": %s, "message": %s, "href": %s}' % (self.code, self.message, self.href)
30
31class KepServiceStatus:
32    '''A class to represent a status object when checking on a "service" API job state in Kepware. This is
33    used to return the status of a "service" job
34
35    :param complete: Boolean of service job completion status
36
37    :param status: Status code of job
38
39    :param message: Error message if service job fails
40    
41    '''
42    def __init__(self, complete: bool = False, status: str = '', message: str = ''):
43        self.status = status
44        self.message = message
45        self.complete = complete
46    
47    def __str__(self):
48        return '{"complete": %s, "status": %s, "message": %s}' % (self.complete, self.status, self.message)
49
50class _HttpDataAbstract:
51    def __init__(self):
52        self.payload = ''
53        self.code = ''
54        self.reason = ''
55
56class FilterModifierEnum(Enum):
57    '''Enum class to represent the various filter types that can be used in the Kepware API'''
58    EQUAL = "eq"
59    NOTEQUAL = "neq"
60    GREATERTHAN = "gt"
61    LESSTTHAN = "lt"
62    GREATERTHANEQUAL = "gte"
63    LESSTHANEQUAL = "lte"
64    CONTAINS = "contains"
65    NOTCONTAINS = "ncontains"
66    STARTSWITH = "starts_with"
67    NOTSTARTSWITH = "nstarts_with"
68    ENDSWITH = "ends_with"
69    NOTENDSWITH = "nends_with"
70
71class FilterFieldEnum(Enum):
72    ID = "id"
73    TIMESTAMP = "timestamp"
74    ACTION = "action"
75    USER = "user"
76    INTERFACE = "interface"
77    DETAILS = "details"
78    DATA = "data"
79
80class Filter:
81    '''A class to represent a filter object when calling the Kepware API. This is used to
82    filter the results of a GET request for Audit Logs.
83
84    :param name: Name of the object to filter on
85
86    :param type: Type of filter to apply
87
88    :param value: Value to filter on
89    '''
90    def __init__(self, field: FilterFieldEnum = FilterFieldEnum.ID, modifier: FilterModifierEnum = FilterModifierEnum.EQUAL, value: str = ''):
91        self.field = field
92        self.modifier = modifier
93        self.value = value
94    
95    def __str__(self):
96        return '{"field": %s, "modifier": %s, "value": %s}' % (self.field, self.modifier, self.value)