nyx_client.connection
=====================

.. py:module:: nyx_client.connection

.. autoapi-nested-parse::

   Module for connection (3rd party data integrations) definitions in Nyx.



Classes
-------

.. autoapisummary::

   nyx_client.connection.Connection


Module Contents
---------------

.. py:class:: Connection

   Represents a connection to a 3rd party data integration.


   .. py:attribute:: id
      :type:  str

      the id of the connection


   .. py:attribute:: name
      :type:  str

      the name of the connection


   .. py:attribute:: json_blob
      :type:  dict[str, Any]

      json blob of non sensitive storage config


   .. py:attribute:: description
      :type:  str
      :value: ''


      the description of the connection


   .. py:attribute:: allow_update
      :type:  bool
      :value: False


      boolean to denote if upload is allowed from this connection


   .. py:method:: from_dict(value)
      :classmethod:


      Builds a connection object from json.

      :param value: a dictionary of the connection object

      :returns: `Connection` object