File: query.py

package info (click to toggle)
python-influxdb-client 1.40.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 7,216 kB
  • sloc: python: 60,236; sh: 64; makefile: 53
file content (239 lines) | stat: -rw-r--r-- 7,407 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
# coding: utf-8

"""
InfluxDB OSS API Service.

The InfluxDB v2 API provides a programmatic interface for all interactions with InfluxDB. Access the InfluxDB API using the `/api/v2/` endpoint.   # noqa: E501

OpenAPI spec version: 2.0.0
Generated by: https://openapi-generator.tech
"""


import pprint
import re  # noqa: F401


class Query(object):
    """NOTE: This class is auto generated by OpenAPI Generator.

    Ref: https://openapi-generator.tech

    Do not edit the class manually.
    """

    """
    Attributes:
      openapi_types (dict): The key is attribute name
                            and the value is attribute type.
      attribute_map (dict): The key is attribute name
                            and the value is json key in definition.
    """
    openapi_types = {
        'extern': 'File',
        'query': 'str',
        'type': 'str',
        'params': 'dict(str, object)',
        'dialect': 'Dialect',
        'now': 'datetime'
    }

    attribute_map = {
        'extern': 'extern',
        'query': 'query',
        'type': 'type',
        'params': 'params',
        'dialect': 'dialect',
        'now': 'now'
    }

    def __init__(self, extern=None, query=None, type=None, params=None, dialect=None, now=None):  # noqa: E501,D401,D403
        """Query - a model defined in OpenAPI."""  # noqa: E501
        self._extern = None
        self._query = None
        self._type = None
        self._params = None
        self._dialect = None
        self._now = None
        self.discriminator = None

        if extern is not None:
            self.extern = extern
        self.query = query
        if type is not None:
            self.type = type
        if params is not None:
            self.params = params
        if dialect is not None:
            self.dialect = dialect
        if now is not None:
            self.now = now

    @property
    def extern(self):
        """Get the extern of this Query.

        :return: The extern of this Query.
        :rtype: File
        """  # noqa: E501
        return self._extern

    @extern.setter
    def extern(self, extern):
        """Set the extern of this Query.

        :param extern: The extern of this Query.
        :type: File
        """  # noqa: E501
        self._extern = extern

    @property
    def query(self):
        """Get the query of this Query.

        The query script to execute.

        :return: The query of this Query.
        :rtype: str
        """  # noqa: E501
        return self._query

    @query.setter
    def query(self, query):
        """Set the query of this Query.

        The query script to execute.

        :param query: The query of this Query.
        :type: str
        """  # noqa: E501
        if query is None:
            raise ValueError("Invalid value for `query`, must not be `None`")  # noqa: E501
        self._query = query

    @property
    def type(self):
        """Get the type of this Query.

        The type of query. Must be "flux".

        :return: The type of this Query.
        :rtype: str
        """  # noqa: E501
        return self._type

    @type.setter
    def type(self, type):
        """Set the type of this Query.

        The type of query. Must be "flux".

        :param type: The type of this Query.
        :type: str
        """  # noqa: E501
        self._type = type

    @property
    def params(self):
        r"""Get the params of this Query.

        Key-value pairs passed as parameters during query execution.  To use parameters in your query, pass a _`query`_ with `params` references (in dot notation)--for example:  ```json   query: "from(bucket: params.mybucket)\\               |> range(start: params.rangeStart) |> limit(n:1)" ```  and pass _`params`_ with the key-value pairs--for example:  ```json   params: {     "mybucket": "environment",     "rangeStart": "-30d"   } ```  During query execution, InfluxDB passes _`params`_ to your script and substitutes the values.  #### Limitations  - If you use _`params`_, you can't use _`extern`_.

        :return: The params of this Query.
        :rtype: dict(str, object)
        """  # noqa: E501
        return self._params

    @params.setter
    def params(self, params):
        r"""Set the params of this Query.

        Key-value pairs passed as parameters during query execution.  To use parameters in your query, pass a _`query`_ with `params` references (in dot notation)--for example:  ```json   query: "from(bucket: params.mybucket)\\               |> range(start: params.rangeStart) |> limit(n:1)" ```  and pass _`params`_ with the key-value pairs--for example:  ```json   params: {     "mybucket": "environment",     "rangeStart": "-30d"   } ```  During query execution, InfluxDB passes _`params`_ to your script and substitutes the values.  #### Limitations  - If you use _`params`_, you can't use _`extern`_.

        :param params: The params of this Query.
        :type: dict(str, object)
        """  # noqa: E501
        self._params = params

    @property
    def dialect(self):
        """Get the dialect of this Query.

        :return: The dialect of this Query.
        :rtype: Dialect
        """  # noqa: E501
        return self._dialect

    @dialect.setter
    def dialect(self, dialect):
        """Set the dialect of this Query.

        :param dialect: The dialect of this Query.
        :type: Dialect
        """  # noqa: E501
        self._dialect = dialect

    @property
    def now(self):
        """Get the now of this Query.

        Specifies the time that should be reported as `now` in the query. Default is the server `now` time.

        :return: The now of this Query.
        :rtype: datetime
        """  # noqa: E501
        return self._now

    @now.setter
    def now(self, now):
        """Set the now of this Query.

        Specifies the time that should be reported as `now` in the query. Default is the server `now` time.

        :param now: The now of this Query.
        :type: datetime
        """  # noqa: E501
        self._now = now

    def to_dict(self):
        """Return the model properties as a dict."""
        result = {}

        for attr, _ in self.openapi_types.items():
            value = getattr(self, attr)
            if isinstance(value, list):
                result[attr] = list(map(
                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
                    value
                ))
            elif hasattr(value, "to_dict"):
                result[attr] = value.to_dict()
            elif isinstance(value, dict):
                result[attr] = dict(map(
                    lambda item: (item[0], item[1].to_dict())
                    if hasattr(item[1], "to_dict") else item,
                    value.items()
                ))
            else:
                result[attr] = value

        return result

    def to_str(self):
        """Return the string representation of the model."""
        return pprint.pformat(self.to_dict())

    def __repr__(self):
        """For `print` and `pprint`."""
        return self.to_str()

    def __eq__(self, other):
        """Return true if both objects are equal."""
        if not isinstance(other, Query):
            return False

        return self.__dict__ == other.__dict__

    def __ne__(self, other):
        """Return true if both objects are not equal."""
        return not self == other