558 lines
18 KiB
Python
558 lines
18 KiB
Python
# coding: utf-8
|
|
|
|
"""
|
|
ThingsBoard REST API
|
|
|
|
ThingsBoard Professional Edition IoT platform REST API documentation. # noqa: E501
|
|
|
|
OpenAPI spec version: 3.5.0PE
|
|
Contact: info@thingsboard.io
|
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
"""
|
|
|
|
# Copyright 2023. ThingsBoard
|
|
#
|
|
# 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.
|
|
|
|
import pprint
|
|
import re # noqa: F401
|
|
|
|
import six
|
|
|
|
class Integration(object):
|
|
"""NOTE: This class is auto generated by the swagger code generator program.
|
|
|
|
Do not edit the class manually.
|
|
"""
|
|
"""
|
|
Attributes:
|
|
swagger_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.
|
|
"""
|
|
swagger_types = {
|
|
'id': 'IntegrationId',
|
|
'created_time': 'int',
|
|
'tenant_id': 'TenantId',
|
|
'default_converter_id': 'ConverterId',
|
|
'downlink_converter_id': 'ConverterId',
|
|
'routing_key': 'str',
|
|
'type': 'str',
|
|
'debug_mode': 'bool',
|
|
'enabled': 'bool',
|
|
'remote': 'bool',
|
|
'allow_create_devices_or_assets': 'bool',
|
|
'secret': 'str',
|
|
'configuration': 'JsonNode',
|
|
'additional_info': 'JsonNode',
|
|
'name': 'str',
|
|
'edge_template': 'bool',
|
|
'external_id': 'EntityId'
|
|
}
|
|
|
|
attribute_map = {
|
|
'id': 'id',
|
|
'created_time': 'createdTime',
|
|
'tenant_id': 'tenantId',
|
|
'default_converter_id': 'defaultConverterId',
|
|
'downlink_converter_id': 'downlinkConverterId',
|
|
'routing_key': 'routingKey',
|
|
'type': 'type',
|
|
'debug_mode': 'debugMode',
|
|
'enabled': 'enabled',
|
|
'remote': 'remote',
|
|
'allow_create_devices_or_assets': 'allowCreateDevicesOrAssets',
|
|
'secret': 'secret',
|
|
'configuration': 'configuration',
|
|
'additional_info': 'additionalInfo',
|
|
'name': 'name',
|
|
'edge_template': 'edgeTemplate',
|
|
'external_id': 'externalId'
|
|
}
|
|
|
|
def __init__(self, id=None, external_id=None, created_time=None, tenant_id=None, default_converter_id=None, downlink_converter_id=None, routing_key=None, type=None, debug_mode=None, enabled=None, remote=None, allow_create_devices_or_assets=None, secret=None, configuration=None, additional_info=None, name=None, edge_template=None): # noqa: E501
|
|
"""Integration - a model defined in Swagger""" # noqa: E501
|
|
self._id = None
|
|
self._created_time = None
|
|
self._tenant_id = None
|
|
self._default_converter_id = None
|
|
self._downlink_converter_id = None
|
|
self._routing_key = None
|
|
self._type = None
|
|
self._debug_mode = None
|
|
self._enabled = None
|
|
self._remote = None
|
|
self._allow_create_devices_or_assets = None
|
|
self._secret = None
|
|
self._configuration = None
|
|
self._additional_info = None
|
|
self._name = None
|
|
self._edge_template = None
|
|
self._external_id = None
|
|
self.discriminator = None
|
|
self.external_id = external_id
|
|
if id is not None:
|
|
self.id = id
|
|
if created_time is not None:
|
|
self.created_time = created_time
|
|
if tenant_id is not None:
|
|
self.tenant_id = tenant_id
|
|
self.default_converter_id = default_converter_id
|
|
if downlink_converter_id is not None:
|
|
self.downlink_converter_id = downlink_converter_id
|
|
self.routing_key = routing_key
|
|
self.type = type
|
|
if debug_mode is not None:
|
|
self.debug_mode = debug_mode
|
|
if enabled is not None:
|
|
self.enabled = enabled
|
|
if remote is not None:
|
|
self.remote = remote
|
|
if allow_create_devices_or_assets is not None:
|
|
self.allow_create_devices_or_assets = allow_create_devices_or_assets
|
|
if secret is not None:
|
|
self.secret = secret
|
|
self.configuration = configuration
|
|
if additional_info is not None:
|
|
self.additional_info = additional_info
|
|
self.name = name
|
|
if edge_template is not None:
|
|
self.edge_template = edge_template
|
|
|
|
@property
|
|
def id(self):
|
|
"""Gets the id of this Integration. # noqa: E501
|
|
|
|
|
|
:return: The id of this Integration. # noqa: E501
|
|
:rtype: IntegrationId
|
|
"""
|
|
return self._id
|
|
|
|
@id.setter
|
|
def id(self, id):
|
|
"""Sets the id of this Integration.
|
|
|
|
|
|
:param id: The id of this Integration. # noqa: E501
|
|
:type: IntegrationId
|
|
"""
|
|
|
|
self._id = id
|
|
|
|
@property
|
|
def external_id(self):
|
|
return self._external_id
|
|
|
|
@external_id.setter
|
|
def external_id(self, external_id):
|
|
self._external_id = external_id
|
|
|
|
@property
|
|
def created_time(self):
|
|
"""Gets the created_time of this Integration. # noqa: E501
|
|
|
|
Timestamp of the integration creation, in milliseconds # noqa: E501
|
|
|
|
:return: The created_time of this Integration. # noqa: E501
|
|
:rtype: int
|
|
"""
|
|
return self._created_time
|
|
|
|
@created_time.setter
|
|
def created_time(self, created_time):
|
|
"""Sets the created_time of this Integration.
|
|
|
|
Timestamp of the integration creation, in milliseconds # noqa: E501
|
|
|
|
:param created_time: The created_time of this Integration. # noqa: E501
|
|
:type: int
|
|
"""
|
|
|
|
self._created_time = created_time
|
|
|
|
@property
|
|
def tenant_id(self):
|
|
"""Gets the tenant_id of this Integration. # noqa: E501
|
|
|
|
|
|
:return: The tenant_id of this Integration. # noqa: E501
|
|
:rtype: TenantId
|
|
"""
|
|
return self._tenant_id
|
|
|
|
@tenant_id.setter
|
|
def tenant_id(self, tenant_id):
|
|
"""Sets the tenant_id of this Integration.
|
|
|
|
|
|
:param tenant_id: The tenant_id of this Integration. # noqa: E501
|
|
:type: TenantId
|
|
"""
|
|
|
|
self._tenant_id = tenant_id
|
|
|
|
@property
|
|
def default_converter_id(self):
|
|
"""Gets the default_converter_id of this Integration. # noqa: E501
|
|
|
|
|
|
:return: The default_converter_id of this Integration. # noqa: E501
|
|
:rtype: ConverterId
|
|
"""
|
|
return self._default_converter_id
|
|
|
|
@default_converter_id.setter
|
|
def default_converter_id(self, default_converter_id):
|
|
"""Sets the default_converter_id of this Integration.
|
|
|
|
|
|
:param default_converter_id: The default_converter_id of this Integration. # noqa: E501
|
|
:type: ConverterId
|
|
"""
|
|
if default_converter_id is None:
|
|
raise ValueError("Invalid value for `default_converter_id`, must not be `None`") # noqa: E501
|
|
|
|
self._default_converter_id = default_converter_id
|
|
|
|
@property
|
|
def downlink_converter_id(self):
|
|
"""Gets the downlink_converter_id of this Integration. # noqa: E501
|
|
|
|
|
|
:return: The downlink_converter_id of this Integration. # noqa: E501
|
|
:rtype: ConverterId
|
|
"""
|
|
return self._downlink_converter_id
|
|
|
|
@downlink_converter_id.setter
|
|
def downlink_converter_id(self, downlink_converter_id):
|
|
"""Sets the downlink_converter_id of this Integration.
|
|
|
|
|
|
:param downlink_converter_id: The downlink_converter_id of this Integration. # noqa: E501
|
|
:type: ConverterId
|
|
"""
|
|
|
|
self._downlink_converter_id = downlink_converter_id
|
|
|
|
@property
|
|
def routing_key(self):
|
|
"""Gets the routing_key of this Integration. # noqa: E501
|
|
|
|
String value used by HTTP based integrations for the base URL construction and by the remote integrations. Remote integration uses this value along with the 'secret' for kind of security and validation to be able to connect to the platform using Grpc # noqa: E501
|
|
|
|
:return: The routing_key of this Integration. # noqa: E501
|
|
:rtype: str
|
|
"""
|
|
return self._routing_key
|
|
|
|
@routing_key.setter
|
|
def routing_key(self, routing_key):
|
|
"""Sets the routing_key of this Integration.
|
|
|
|
String value used by HTTP based integrations for the base URL construction and by the remote integrations. Remote integration uses this value along with the 'secret' for kind of security and validation to be able to connect to the platform using Grpc # noqa: E501
|
|
|
|
:param routing_key: The routing_key of this Integration. # noqa: E501
|
|
:type: str
|
|
"""
|
|
if routing_key is None:
|
|
raise ValueError("Invalid value for `routing_key`, must not be `None`") # noqa: E501
|
|
|
|
self._routing_key = routing_key
|
|
|
|
@property
|
|
def type(self):
|
|
"""Gets the type of this Integration. # noqa: E501
|
|
|
|
The type of the integration # noqa: E501
|
|
|
|
:return: The type of this Integration. # noqa: E501
|
|
:rtype: str
|
|
"""
|
|
return self._type
|
|
|
|
@type.setter
|
|
def type(self, type):
|
|
"""Sets the type of this Integration.
|
|
|
|
The type of the integration # noqa: E501
|
|
|
|
:param type: The type of this Integration. # noqa: E501
|
|
:type: str
|
|
"""
|
|
if type is None:
|
|
raise ValueError("Invalid value for `type`, must not be `None`") # noqa: E501
|
|
allowed_values = ["APACHE_PULSAR", "AWS_IOT", "AWS_KINESIS", "AWS_SQS", "AZURE_EVENT_HUB", "AZURE_IOT_HUB", "AZURE_SERVICE_BUS", "CHIRPSTACK", "COAP", "CUSTOM", "HTTP", "IBM_WATSON_IOT", "KAFKA", "LORIOT", "MQTT", "OCEANCONNECT", "OPC_UA", "PUB_SUB", "RABBITMQ", "SIGFOX", "TCP", "THINGPARK", "TMOBILE_IOT_CDP", "TPE", "TTI", "TTN", "TUYA", "UDP"] # noqa: E501
|
|
if type not in allowed_values:
|
|
raise ValueError(
|
|
"Invalid value for `type` ({0}), must be one of {1}" # noqa: E501
|
|
.format(type, allowed_values)
|
|
)
|
|
|
|
self._type = type
|
|
|
|
@property
|
|
def debug_mode(self):
|
|
"""Gets the debug_mode of this Integration. # noqa: E501
|
|
|
|
Boolean flag to enable/disable saving received messages as debug events # noqa: E501
|
|
|
|
:return: The debug_mode of this Integration. # noqa: E501
|
|
:rtype: bool
|
|
"""
|
|
return self._debug_mode
|
|
|
|
@debug_mode.setter
|
|
def debug_mode(self, debug_mode):
|
|
"""Sets the debug_mode of this Integration.
|
|
|
|
Boolean flag to enable/disable saving received messages as debug events # noqa: E501
|
|
|
|
:param debug_mode: The debug_mode of this Integration. # noqa: E501
|
|
:type: bool
|
|
"""
|
|
|
|
self._debug_mode = debug_mode
|
|
|
|
@property
|
|
def enabled(self):
|
|
"""Gets the enabled of this Integration. # noqa: E501
|
|
|
|
Boolean flag to enable/disable the integration # noqa: E501
|
|
|
|
:return: The enabled of this Integration. # noqa: E501
|
|
:rtype: bool
|
|
"""
|
|
return self._enabled
|
|
|
|
@enabled.setter
|
|
def enabled(self, enabled):
|
|
"""Sets the enabled of this Integration.
|
|
|
|
Boolean flag to enable/disable the integration # noqa: E501
|
|
|
|
:param enabled: The enabled of this Integration. # noqa: E501
|
|
:type: bool
|
|
"""
|
|
|
|
self._enabled = enabled
|
|
|
|
@property
|
|
def remote(self):
|
|
"""Gets the remote of this Integration. # noqa: E501
|
|
|
|
Boolean flag to enable/disable the integration to be executed remotely. Remote integration is launched in a separate microservice. Local integration is executed by the platform core # noqa: E501
|
|
|
|
:return: The remote of this Integration. # noqa: E501
|
|
:rtype: bool
|
|
"""
|
|
return self._remote
|
|
|
|
@remote.setter
|
|
def remote(self, remote):
|
|
"""Sets the remote of this Integration.
|
|
|
|
Boolean flag to enable/disable the integration to be executed remotely. Remote integration is launched in a separate microservice. Local integration is executed by the platform core # noqa: E501
|
|
|
|
:param remote: The remote of this Integration. # noqa: E501
|
|
:type: bool
|
|
"""
|
|
|
|
self._remote = remote
|
|
|
|
@property
|
|
def allow_create_devices_or_assets(self):
|
|
"""Gets the allow_create_devices_or_assets of this Integration. # noqa: E501
|
|
|
|
Boolean flag to allow/disallow the integration to create devices or assets that send message and do not exist in the system yet # noqa: E501
|
|
|
|
:return: The allow_create_devices_or_assets of this Integration. # noqa: E501
|
|
:rtype: bool
|
|
"""
|
|
return self._allow_create_devices_or_assets
|
|
|
|
@allow_create_devices_or_assets.setter
|
|
def allow_create_devices_or_assets(self, allow_create_devices_or_assets):
|
|
"""Sets the allow_create_devices_or_assets of this Integration.
|
|
|
|
Boolean flag to allow/disallow the integration to create devices or assets that send message and do not exist in the system yet # noqa: E501
|
|
|
|
:param allow_create_devices_or_assets: The allow_create_devices_or_assets of this Integration. # noqa: E501
|
|
:type: bool
|
|
"""
|
|
|
|
self._allow_create_devices_or_assets = allow_create_devices_or_assets
|
|
|
|
@property
|
|
def secret(self):
|
|
"""Gets the secret of this Integration. # noqa: E501
|
|
|
|
String value used by the remote integrations. Remote integration uses this value along with the 'routingKey' for kind of security and validation to be able to connect to the platform using Grpc # noqa: E501
|
|
|
|
:return: The secret of this Integration. # noqa: E501
|
|
:rtype: str
|
|
"""
|
|
return self._secret
|
|
|
|
@secret.setter
|
|
def secret(self, secret):
|
|
"""Sets the secret of this Integration.
|
|
|
|
String value used by the remote integrations. Remote integration uses this value along with the 'routingKey' for kind of security and validation to be able to connect to the platform using Grpc # noqa: E501
|
|
|
|
:param secret: The secret of this Integration. # noqa: E501
|
|
:type: str
|
|
"""
|
|
|
|
self._secret = secret
|
|
|
|
@property
|
|
def configuration(self):
|
|
"""Gets the configuration of this Integration. # noqa: E501
|
|
|
|
|
|
:return: The configuration of this Integration. # noqa: E501
|
|
:rtype: JsonNode
|
|
"""
|
|
return self._configuration
|
|
|
|
@configuration.setter
|
|
def configuration(self, configuration):
|
|
"""Sets the configuration of this Integration.
|
|
|
|
|
|
:param configuration: The configuration of this Integration. # noqa: E501
|
|
:type: JsonNode
|
|
"""
|
|
if configuration is None:
|
|
raise ValueError("Invalid value for `configuration`, must not be `None`") # noqa: E501
|
|
|
|
self._configuration = configuration
|
|
|
|
@property
|
|
def additional_info(self):
|
|
"""Gets the additional_info of this Integration. # noqa: E501
|
|
|
|
|
|
:return: The additional_info of this Integration. # noqa: E501
|
|
:rtype: JsonNode
|
|
"""
|
|
return self._additional_info
|
|
|
|
@additional_info.setter
|
|
def additional_info(self, additional_info):
|
|
"""Sets the additional_info of this Integration.
|
|
|
|
|
|
:param additional_info: The additional_info of this Integration. # noqa: E501
|
|
:type: JsonNode
|
|
"""
|
|
|
|
self._additional_info = additional_info
|
|
|
|
@property
|
|
def name(self):
|
|
"""Gets the name of this Integration. # noqa: E501
|
|
|
|
Integration Name # noqa: E501
|
|
|
|
:return: The name of this Integration. # noqa: E501
|
|
:rtype: str
|
|
"""
|
|
return self._name
|
|
|
|
@name.setter
|
|
def name(self, name):
|
|
"""Sets the name of this Integration.
|
|
|
|
Integration Name # noqa: E501
|
|
|
|
:param name: The name of this Integration. # noqa: E501
|
|
:type: str
|
|
"""
|
|
if name is None:
|
|
raise ValueError("Invalid value for `name`, must not be `None`") # noqa: E501
|
|
|
|
self._name = name
|
|
|
|
@property
|
|
def edge_template(self):
|
|
"""Gets the edge_template of this Integration. # noqa: E501
|
|
|
|
Boolean flag that specifies that is regular or edge template integration # noqa: E501
|
|
|
|
:return: The edge_template of this Integration. # noqa: E501
|
|
:rtype: bool
|
|
"""
|
|
return self._edge_template
|
|
|
|
@edge_template.setter
|
|
def edge_template(self, edge_template):
|
|
"""Sets the edge_template of this Integration.
|
|
|
|
Boolean flag that specifies that is regular or edge template integration # noqa: E501
|
|
|
|
:param edge_template: The edge_template of this Integration. # noqa: E501
|
|
:type: bool
|
|
"""
|
|
|
|
self._edge_template = edge_template
|
|
|
|
def to_dict(self):
|
|
"""Returns the model properties as a dict"""
|
|
result = {}
|
|
|
|
for attr, _ in six.iteritems(self.swagger_types):
|
|
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
|
|
if issubclass(Integration, dict):
|
|
for key, value in self.items():
|
|
result[key] = value
|
|
|
|
return result
|
|
|
|
def to_str(self):
|
|
"""Returns 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):
|
|
"""Returns true if both objects are equal"""
|
|
if not isinstance(other, Integration):
|
|
return False
|
|
|
|
return self.__dict__ == other.__dict__
|
|
|
|
def __ne__(self, other):
|
|
"""Returns true if both objects are not equal"""
|
|
return not self == other
|