Add shared manipulation

Author: adescamps

dataikuapi/dss/dataset.py

@@ -536,6 +536,26 @@ def move_to_zone(self, zone):
            zone = self.project.get_flow().get_zone(zone)
         zone.add_item(self)
 
+    def share_to_zone(self, zone):
+        """
+        Share this object to a flow zone
+
+        :param object zone: a :class:`dataikuapi.dss.flow.DSSFlowZone` where to share the object
+        """
+        if isinstance(zone, basestring):
+            zone = self.project.get_flow().get_zone(zone)
+        zone.add_shared(self)
+
+    def unshare_from_zone(self, zone):
+        """
+        Unshare this object from a flow zone
+
+        :param object zone: a :class:`dataikuapi.dss.flow.DSSFlowZone` from where to unshare the object
+        """
+        if isinstance(zone, basestring):
+            zone = self.project.get_flow().get_zone(zone)
+        zone.remove_shared(self)
+
     def get_usages(self):
         """
         Get the recipes or analyses referencing this dataset

dataikuapi/dss/flow.py

@@ -189,6 +189,10 @@ def id(self):
     def name(self):
         return self._raw["name"]
 
+    @property
+    def color(self):
+        return self._raw["color"]
+
     def __repr__(self):
         return "<dataikuapi.dss.flow.DSSFlowZone (id=%s, name=%s)>" % (self.id, self.name)
 
@@ -248,6 +252,28 @@ def items(self):
         """
         return [self._to_native_obj(i) for i in self._raw["items"]]
 
+    def add_shared(self, obj):
+        """
+        Share an item to this zone.
+
+        The item will not be automatically unshared from its existing zone.
+
+        :param object obj: A :class:`dataikuapi.dss.dataset.DSSDataset`, :class:`dataikuapi.dss.managedfolder.DSSManagedFolder`,
+                           or :class:`dataikuapi.dss.savedmodel.DSSSavedModel` to share to the zone
+        """
+        self._raw = self.client._perform_json("POST", "/projects/%s/flow/zones/%s/shared" % (self.flow.project.project_key, self.id),
+                                          body=self.flow._to_smart_ref(obj))
+
+    def remove_shared(self, obj):
+        """
+        Remove a shared item from this zone.
+
+        :param object obj: A :class:`dataikuapi.dss.dataset.DSSDataset`, :class:`dataikuapi.dss.managedfolder.DSSManagedFolder`,
+                           or :class:`dataikuapi.dss.savedmodel.DSSSavedModel` to share to the zone
+        """
+        smartRef = self.flow._to_smart_ref(obj)
+        self._raw = self.client._perform_json("DELETE", "/projects/%s/flow/zones/%s/shared/%s/%s" % (self.flow.project.project_key, self.id, smartRef['objectType'], smartRef['objectId']))
+
     @property
     def shared(self):
         """

dataikuapi/dss/managedfolder.py

@@ -177,6 +177,26 @@ def move_to_zone(self, zone):
            zone = self.project.get_flow().get_zone(zone)
         zone.add_item(self)
 
+    def share_to_zone(self, zone):
+        """
+        Share this object to a flow zone
+
+        :param object zone: a :class:`dataikuapi.dss.flow.DSSFlowZone` where to share the object
+        """
+        if isinstance(zone, basestring):
+            zone = self.project.get_flow().get_zone(zone)
+        zone.add_shared(self)
+
+    def unshare_from_zone(self, zone):
+        """
+        Unshare this object from a flow zone
+
+        :param object zone: a :class:`dataikuapi.dss.flow.DSSFlowZone` from where to unshare the object
+        """
+        if isinstance(zone, basestring):
+            zone = self.project.get_flow().get_zone(zone)
+        zone.remove_shared(self)
+
     def get_usages(self):
         """
         Get the recipes referencing this folder

dataikuapi/dss/savedmodel.py

@@ -145,6 +145,26 @@ def move_to_zone(self, zone):
            zone = self.project.get_flow().get_zone(zone)
         zone.add_item(self)
 
+    def share_to_zone(self, zone):
+        """
+        Share this object to a flow zone
+
+        :param object zone: a :class:`dataikuapi.dss.flow.DSSFlowZone` where to share the object
+        """
+        if isinstance(zone, basestring):
+            zone = self.project.get_flow().get_zone(zone)
+        zone.add_shared(self)
+
+    def unshare_from_zone(self, zone):
+        """
+        Unshare this object from a flow zone
+
+        :param object zone: a :class:`dataikuapi.dss.flow.DSSFlowZone` from where to unshare the object
+        """
+        if isinstance(zone, basestring):
+            zone = self.project.get_flow().get_zone(zone)
+        zone.remove_shared(self)
+
     def get_usages(self):
         """
         Get the recipes referencing this model

dataikuapi/dss/streaming_endpoint.py

@@ -136,9 +136,47 @@ def set_schema(self, schema):
                 body=schema)
 
     ########################################################
-    # Usages
+    # Misc
     ########################################################
 
+    def get_zone(self):
+        """
+        Gets the flow zone of this streaming endpoint
+
+        :rtype: :class:`dataikuapi.dss.flow.DSSFlowZone`
+        """
+        return self.project.get_flow().get_zone_of_object(self)
+
+    def move_to_zone(self, zone):
+        """
+        Moves this object to a flow zone
+
+        :param object zone: a :class:`dataikuapi.dss.flow.DSSFlowZone` where to move the object
+        """
+        if isinstance(zone, basestring):
+            zone = self.project.get_flow().get_zone(zone)
+        zone.add_item(self)
+
+    def share_to_zone(self, zone):
+        """
+        Share this object to a flow zone
+
+        :param object zone: a :class:`dataikuapi.dss.flow.DSSFlowZone` where to share the object
+        """
+        if isinstance(zone, basestring):
+            zone = self.project.get_flow().get_zone(zone)
+        zone.add_shared(self)
+
+    def unshare_from_zone(self, zone):
+        """
+        Unshare this object from a flow zone
+
+        :param object zone: a :class:`dataikuapi.dss.flow.DSSFlowZone` from where to unshare the object
+        """
+        if isinstance(zone, basestring):
+            zone = self.project.get_flow().get_zone(zone)
+        zone.remove_shared(self)
+
     def get_usages(self):
         """
         Get the recipes or analyses referencing this streaming endpoint