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 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569
|
# 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 Task(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 = {
'id': 'str',
'org_id': 'str',
'org': 'str',
'name': 'str',
'owner_id': 'str',
'description': 'str',
'status': 'TaskStatusType',
'labels': 'list[Label]',
'authorization_id': 'str',
'flux': 'str',
'every': 'str',
'cron': 'str',
'offset': 'str',
'latest_completed': 'datetime',
'last_run_status': 'str',
'last_run_error': 'str',
'created_at': 'datetime',
'updated_at': 'datetime',
'links': 'TaskLinks'
}
attribute_map = {
'id': 'id',
'org_id': 'orgID',
'org': 'org',
'name': 'name',
'owner_id': 'ownerID',
'description': 'description',
'status': 'status',
'labels': 'labels',
'authorization_id': 'authorizationID',
'flux': 'flux',
'every': 'every',
'cron': 'cron',
'offset': 'offset',
'latest_completed': 'latestCompleted',
'last_run_status': 'lastRunStatus',
'last_run_error': 'lastRunError',
'created_at': 'createdAt',
'updated_at': 'updatedAt',
'links': 'links'
}
def __init__(self, id=None, org_id=None, org=None, name=None, owner_id=None, description=None, status=None, labels=None, authorization_id=None, flux=None, every=None, cron=None, offset=None, latest_completed=None, last_run_status=None, last_run_error=None, created_at=None, updated_at=None, links=None): # noqa: E501,D401,D403
"""Task - a model defined in OpenAPI.""" # noqa: E501
self._id = None
self._org_id = None
self._org = None
self._name = None
self._owner_id = None
self._description = None
self._status = None
self._labels = None
self._authorization_id = None
self._flux = None
self._every = None
self._cron = None
self._offset = None
self._latest_completed = None
self._last_run_status = None
self._last_run_error = None
self._created_at = None
self._updated_at = None
self._links = None
self.discriminator = None
self.id = id
self.org_id = org_id
if org is not None:
self.org = org
self.name = name
if owner_id is not None:
self.owner_id = owner_id
if description is not None:
self.description = description
if status is not None:
self.status = status
if labels is not None:
self.labels = labels
if authorization_id is not None:
self.authorization_id = authorization_id
self.flux = flux
if every is not None:
self.every = every
if cron is not None:
self.cron = cron
if offset is not None:
self.offset = offset
if latest_completed is not None:
self.latest_completed = latest_completed
if last_run_status is not None:
self.last_run_status = last_run_status
if last_run_error is not None:
self.last_run_error = last_run_error
if created_at is not None:
self.created_at = created_at
if updated_at is not None:
self.updated_at = updated_at
if links is not None:
self.links = links
@property
def id(self):
"""Get the id of this Task.
:return: The id of this Task.
:rtype: str
""" # noqa: E501
return self._id
@id.setter
def id(self, id):
"""Set the id of this Task.
:param id: The id of this Task.
:type: str
""" # noqa: E501
if id is None:
raise ValueError("Invalid value for `id`, must not be `None`") # noqa: E501
self._id = id
@property
def org_id(self):
"""Get the org_id of this Task.
An [organization](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization) ID. Specifies the organization that owns the task.
:return: The org_id of this Task.
:rtype: str
""" # noqa: E501
return self._org_id
@org_id.setter
def org_id(self, org_id):
"""Set the org_id of this Task.
An [organization](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization) ID. Specifies the organization that owns the task.
:param org_id: The org_id of this Task.
:type: str
""" # noqa: E501
if org_id is None:
raise ValueError("Invalid value for `org_id`, must not be `None`") # noqa: E501
self._org_id = org_id
@property
def org(self):
"""Get the org of this Task.
An [organization](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization) name. Specifies the organization that owns the task.
:return: The org of this Task.
:rtype: str
""" # noqa: E501
return self._org
@org.setter
def org(self, org):
"""Set the org of this Task.
An [organization](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization) name. Specifies the organization that owns the task.
:param org: The org of this Task.
:type: str
""" # noqa: E501
self._org = org
@property
def name(self):
"""Get the name of this Task.
The name of the task.
:return: The name of this Task.
:rtype: str
""" # noqa: E501
return self._name
@name.setter
def name(self, name):
"""Set the name of this Task.
The name of the task.
:param name: The name of this Task.
:type: str
""" # noqa: E501
if name is None:
raise ValueError("Invalid value for `name`, must not be `None`") # noqa: E501
self._name = name
@property
def owner_id(self):
"""Get the owner_id of this Task.
A [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) ID. Specifies the owner of the task. To find a user ID, you can use the [`GET /api/v2/users` endpoint](#operation/GetUsers) to list users.
:return: The owner_id of this Task.
:rtype: str
""" # noqa: E501
return self._owner_id
@owner_id.setter
def owner_id(self, owner_id):
"""Set the owner_id of this Task.
A [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) ID. Specifies the owner of the task. To find a user ID, you can use the [`GET /api/v2/users` endpoint](#operation/GetUsers) to list users.
:param owner_id: The owner_id of this Task.
:type: str
""" # noqa: E501
self._owner_id = owner_id
@property
def description(self):
"""Get the description of this Task.
A description of the task.
:return: The description of this Task.
:rtype: str
""" # noqa: E501
return self._description
@description.setter
def description(self, description):
"""Set the description of this Task.
A description of the task.
:param description: The description of this Task.
:type: str
""" # noqa: E501
self._description = description
@property
def status(self):
"""Get the status of this Task.
:return: The status of this Task.
:rtype: TaskStatusType
""" # noqa: E501
return self._status
@status.setter
def status(self, status):
"""Set the status of this Task.
:param status: The status of this Task.
:type: TaskStatusType
""" # noqa: E501
self._status = status
@property
def labels(self):
"""Get the labels of this Task.
:return: The labels of this Task.
:rtype: list[Label]
""" # noqa: E501
return self._labels
@labels.setter
def labels(self, labels):
"""Set the labels of this Task.
:param labels: The labels of this Task.
:type: list[Label]
""" # noqa: E501
self._labels = labels
@property
def authorization_id(self):
"""Get the authorization_id of this Task.
An authorization ID. Specifies the authorization used when the task communicates with the query engine. To find an authorization ID, use the [`GET /api/v2/authorizations` endpoint](#operation/GetAuthorizations) to list authorizations.
:return: The authorization_id of this Task.
:rtype: str
""" # noqa: E501
return self._authorization_id
@authorization_id.setter
def authorization_id(self, authorization_id):
"""Set the authorization_id of this Task.
An authorization ID. Specifies the authorization used when the task communicates with the query engine. To find an authorization ID, use the [`GET /api/v2/authorizations` endpoint](#operation/GetAuthorizations) to list authorizations.
:param authorization_id: The authorization_id of this Task.
:type: str
""" # noqa: E501
self._authorization_id = authorization_id
@property
def flux(self):
"""Get the flux of this Task.
The Flux script that the task executes.
:return: The flux of this Task.
:rtype: str
""" # noqa: E501
return self._flux
@flux.setter
def flux(self, flux):
"""Set the flux of this Task.
The Flux script that the task executes.
:param flux: The flux of this Task.
:type: str
""" # noqa: E501
if flux is None:
raise ValueError("Invalid value for `flux`, must not be `None`") # noqa: E501
self._flux = flux
@property
def every(self):
"""Get the every of this Task.
The interval ([duration literal](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp)) at which the task runs. `every` also determines when the task first runs, depending on the specified time.
:return: The every of this Task.
:rtype: str
""" # noqa: E501
return self._every
@every.setter
def every(self, every):
"""Set the every of this Task.
The interval ([duration literal](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp)) at which the task runs. `every` also determines when the task first runs, depending on the specified time.
:param every: The every of this Task.
:type: str
""" # noqa: E501
self._every = every
@property
def cron(self):
"""Get the cron of this Task.
A [Cron expression](https://en.wikipedia.org/wiki/Cron#Overview) that defines the schedule on which the task runs. InfluxDB uses the system time when evaluating Cron expressions.
:return: The cron of this Task.
:rtype: str
""" # noqa: E501
return self._cron
@cron.setter
def cron(self, cron):
"""Set the cron of this Task.
A [Cron expression](https://en.wikipedia.org/wiki/Cron#Overview) that defines the schedule on which the task runs. InfluxDB uses the system time when evaluating Cron expressions.
:param cron: The cron of this Task.
:type: str
""" # noqa: E501
self._cron = cron
@property
def offset(self):
"""Get the offset of this Task.
A [duration](https://docs.influxdata.com/flux/v0.x/spec/lexical-elements/#duration-literals) to delay execution of the task after the scheduled time has elapsed. `0` removes the offset.
:return: The offset of this Task.
:rtype: str
""" # noqa: E501
return self._offset
@offset.setter
def offset(self, offset):
"""Set the offset of this Task.
A [duration](https://docs.influxdata.com/flux/v0.x/spec/lexical-elements/#duration-literals) to delay execution of the task after the scheduled time has elapsed. `0` removes the offset.
:param offset: The offset of this Task.
:type: str
""" # noqa: E501
self._offset = offset
@property
def latest_completed(self):
"""Get the latest_completed of this Task.
A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run.
:return: The latest_completed of this Task.
:rtype: datetime
""" # noqa: E501
return self._latest_completed
@latest_completed.setter
def latest_completed(self, latest_completed):
"""Set the latest_completed of this Task.
A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run.
:param latest_completed: The latest_completed of this Task.
:type: datetime
""" # noqa: E501
self._latest_completed = latest_completed
@property
def last_run_status(self):
"""Get the last_run_status of this Task.
:return: The last_run_status of this Task.
:rtype: str
""" # noqa: E501
return self._last_run_status
@last_run_status.setter
def last_run_status(self, last_run_status):
"""Set the last_run_status of this Task.
:param last_run_status: The last_run_status of this Task.
:type: str
""" # noqa: E501
self._last_run_status = last_run_status
@property
def last_run_error(self):
"""Get the last_run_error of this Task.
:return: The last_run_error of this Task.
:rtype: str
""" # noqa: E501
return self._last_run_error
@last_run_error.setter
def last_run_error(self, last_run_error):
"""Set the last_run_error of this Task.
:param last_run_error: The last_run_error of this Task.
:type: str
""" # noqa: E501
self._last_run_error = last_run_error
@property
def created_at(self):
"""Get the created_at of this Task.
:return: The created_at of this Task.
:rtype: datetime
""" # noqa: E501
return self._created_at
@created_at.setter
def created_at(self, created_at):
"""Set the created_at of this Task.
:param created_at: The created_at of this Task.
:type: datetime
""" # noqa: E501
self._created_at = created_at
@property
def updated_at(self):
"""Get the updated_at of this Task.
:return: The updated_at of this Task.
:rtype: datetime
""" # noqa: E501
return self._updated_at
@updated_at.setter
def updated_at(self, updated_at):
"""Set the updated_at of this Task.
:param updated_at: The updated_at of this Task.
:type: datetime
""" # noqa: E501
self._updated_at = updated_at
@property
def links(self):
"""Get the links of this Task.
:return: The links of this Task.
:rtype: TaskLinks
""" # noqa: E501
return self._links
@links.setter
def links(self, links):
"""Set the links of this Task.
:param links: The links of this Task.
:type: TaskLinks
""" # noqa: E501
self._links = links
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, Task):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
"""Return true if both objects are not equal."""
return not self == other
|