streamsets 6.5.0rc1__tar.gz → 6.6.0.dev1__tar.gz

{streamsets-6.5.0rc1 → streamsets-6.6.0.dev1}/HISTORY.rst

@@ -3,6 +3,24 @@
 
 History
 =======
+6.5.0 (November 2024)
+-----------------
+* The :py:class:`streamsets.sdk.sch_models.Step` class now supports Finish Conditions and has a new attribute ``name`` which will allow retrieving and setting the name of a step.
+
+* Added support for running an arbitrary step using the The :py:meth:`streamsets.sdk.ControlHub.run_job_sequence` method.
+
+* Extended AQL functionality to now support searching on :py:class:`streamsets.sdk.sch_models.JobSequence` objects.
+
+* Updated API calls to be more efficient by changing the default page size to `250` instead of `50`.
+
+* Added SDK support for creating connections without an authoring engine specified (engineless connections).
+
+* Added SDK support for stopping a Deployment through the :py:meth:`streamsets.sdk.ControlHub.delete_deployment` method.
+
+* Added the ability to specify the ``install_type`` for a self-managed deployment when retrieving the install script.
+
+* Bug fixes and improvements.
+
 6.4.0 (July 2024)
 -----------------
 * Added :py:meth:`streamsets.sdk.ControlHub.clone_deployment` method to easily a clone a deployment.
@@ -19,7 +37,6 @@ History
 
 * Bug fixes and improvements.
 
-
 6.3.0 (May 2024)
 ----------------
 * The :py:meth:`streamsets.sdk.ControlHub.get_self_managed_deployment_install_script` method now accepts a parameter ``java_version`` that can be used to specify which java version to be used when generating an install script.

{streamsets-6.5.0rc1 → streamsets-6.6.0.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: streamsets
-Version: 6.5.0rc1
+Version: 6.6.0.dev1
 Summary: A Python SDK for StreamSets
 Author: StreamSets Inc
 Classifier: Development Status :: 5 - Production/Stable

{streamsets-6.5.0rc1 → streamsets-6.6.0.dev1}/docs/usage/set_up/connections/connections.rst

@@ -40,7 +40,7 @@ To create a new Connection and add it to the Platform via the SDK, you will need
 To instantiate a builder instance, use the :py:meth:`streamsets.sdk.ControlHub.get_connection_builder` method.
 
 Once you've instantiated the builder, you will call the :py:meth:`streamsets.sdk.sch_models.ConnectionBuilder.build` method, along with a few parameters, to create the desired :py:class:`streamsets.sdk.sch_models.Connection` instance.
-The parameters you'll need to provide for the Connection are ``title``, ``connection_type``, ``authoring_data_collector``, and (optionally) ``tags`` to associate with the Connection:
+The parameters you'll need to provide for the Connection are ``title``, ``connection_type``, ``authoring_data_collector`` (optional), and ``tags`` (optional) to associate with the Connection:
 
 .. code-block:: python
 
@@ -54,6 +54,9 @@ The parameters you'll need to provide for the Connection are ``title``, ``connec
                                           authoring_data_collector=engine,
                                           tags=['sdk_example', 's3_connection'])
 
+.. tip::
+  Supplying an existing, responsive :py:class:`streamsets.sdk.sch_models.Engine` instance via the ``authoring_data_collector`` parameter is the recommended best practice when building a connection.
+
 .. tip::
   The available options for the ``connection_type`` in the :py:meth:`streamsets.sdk.sch_models.ConnectionBuilder.build` method are:
   ``'STREAMSETS_AWS_EMR_CLUSTER'``, ``'STREAMSETS_MYSQL'``, ``'STREAMSETS_SNOWFLAKE'``, ``'STREAMSETS_COAP_CLIENT'``, ``'STREAMSETS_OPC_UA_CLIENT'``, ``'STREAMSETS_GOOGLE_PUB_SUB'``, ``'STREAMSETS_MQTT'``, ``'STREAMSETS_POSTGRES'``, ``'STREAMSETS_GOOGLE_CLOUD_STORAGE'``, ``'STREAMSETS_AWS_REDSHIFT'``, ``'STREAMSETS_GOOGLE_BIG_QUERY'``, ``'STREAMSETS_ORACLE'``, ``'STREAMSETS_AWS_S3'``, ``'STREAMSETS_REMOTE_FILE'``, ``'STREAMSETS_SQLSERVER'``, ``'STREAMSETS_AWS_SQS'``, ``'STREAMSETS_SNOWPIPE'``, and ``'STREAMSETS_JDBC'``.

streamsets-6.6.0.dev1/streamsets/sdk/__version__.py

@@ -0,0 +1,5 @@
+#  IBM Confidential
+#  PID 5900-BAF
+#  Copyright StreamSets Inc., an IBM Company 2024
+
+__version__ = "6.6.0.dev1"

{streamsets-6.5.0rc1 → streamsets-6.6.0.dev1}/streamsets/sdk/sch_models.py

@@ -10,6 +10,7 @@ import collections
 import copy
 import enum
 import io
+import ipaddress
 import json
 import logging
 import re
@@ -1769,6 +1770,129 @@ class Organization(BaseModel):
         """
         self._api_client.update_organization_configuration(self.id, value._data)
 
+    @property
+    def ip_auth_enabled(self):
+        """Returns whether IP Auth rules are enabled for the organization.
+
+        Returns:
+            An :obj:`bool`.
+        """
+        configs = self._api_client.get_organization_configuration_v2(org_id=self.id).response.json()
+        return configs.get('ipAuthRules', {}).get('enabled')
+
+    @ip_auth_enabled.setter
+    def ip_auth_enabled(self, value):
+        """Sets whether IP Auth rules are enabled for the organization.
+
+        Args:
+            value (:obj:`bool`): Whether IP Auth should be enabled for the organization.
+        """
+
+        if not isinstance(value, bool):
+            raise TypeError("ip_auth_enabled should be of type bool.")
+
+        configs = self._api_client.get_organization_configuration_v2(org_id=self.id).response.json()
+
+        if value is True and len(configs.get('ipAuthRules', {}).get('rules')) == 0:
+            raise ValueError("No rules added, add at least one rule before enabling IP Auth.")
+
+        configs['ipAuthRules']['enabled'] = value
+        # clear configs to avoid updating something that is not allowed by org admins.
+        configs['configs'].clear()
+        self._api_client.update_organization_configuration_v2(data=configs, org_id=self.id)
+
+    @property
+    def ip_auth_rules(self):
+        """The current set of IP Auth rules in the organization.
+
+        Returns:
+            An :obj:`tuple` containing :obj:`dict` for each IP Auth rule in the organization.
+        """
+        configs = self._api_client.get_organization_configuration_v2(org_id=self.id).response.json()
+
+        # casting the list to a tuple so that it is immutable by the user. To avoid any confusion with usability.
+        return tuple(configs.get('ipAuthRules', {}).get('rules'))
+
+    @ip_auth_rules.setter
+    def ip_auth_rules(self, value):
+        raise NotImplementedError(
+            "Not possible to directly set the value of IP auth rules."
+            "Use `add_ip_auth_ruleset` and `remove_ip_auth_ruleset` to modify the rules."
+        )
+
+    def add_ip_auth_ruleset(self, ip_address, bitmask=32, comment=''):
+        """Add a rule to the IP Auth ruleset.
+
+        Args:
+            ip_address (:obj:`str`): IP Address to be added. Should be IPv4.
+            bitmask (:obj:`int`, optional): Bitmask to apply to the IP Address. Default ``32``.
+            comment (:obj:`str`, optional): Comments to be made regarding the rule.
+
+        Returns:
+            An instance of :py:class:`streamsets.sdk.sch_api.Command`.
+        """
+
+        if not isinstance(ip_address, str):
+            raise TypeError("ip_address should be of type str")
+
+        try:
+            # ensure the address passed it a valid IPv4 address
+            ipaddress.IPv4Address(ip_address)
+        except ipaddress.AddressValueError:
+            raise ValueError("ip_address is not a valid IPv4 address.")
+
+        if not isinstance(bitmask, int):
+            raise TypeError("bitmask should be of type int")
+
+        if bitmask < 0 or bitmask > 32:
+            raise ValueError("bitmask value must be within the inclusive range 0-32.")
+
+        if not isinstance(comment, str):
+            raise TypeError("comment should be of type str")
+
+        new_rule = dict(ruleType='IPV4_ALLOW', address=ip_address, bitMask=bitmask, comment=comment)
+
+        configs = self._api_client.get_organization_configuration_v2(org_id=self.id).response.json()
+        configs['ipAuthRules']['rules'].append(new_rule)
+        # clear configs to avoid updating something that is not allowed by org admins.
+        configs['configs'].clear()
+
+        command = self._api_client.update_organization_configuration_v2(data=configs, org_id=self.id)
+        return command
+
+    def remove_ip_auth_ruleset(self, ip_address, bitmask=32):
+        """Remove all rules that have the same IP address and bitmask.
+
+        Args:
+            ip_address (:obj:`str`): IP address to remove from the ruleset.
+            bitmask (:obj:`int`, optional): Bitmask to remove from the ruleset. Default ``32``.
+
+        Returns:
+            An instance of :py:class:`streamsets.sdk.sch_api.Command`.
+        """
+
+        if not isinstance(ip_address, str):
+            raise TypeError("ip_address should be of type str")
+
+        if not isinstance(bitmask, int):
+            raise TypeError("bitmask should be of type int")
+
+        configs = self._api_client.get_organization_configuration_v2(org_id=self.id).response.json()
+        ip_rules = configs.get('ipAuthRules', {}).get('rules')
+
+        filtered_rules = list(
+            filter(lambda rule: not (rule.get('address') == ip_address and rule.get('bitMask') == bitmask), ip_rules)
+        )
+
+        if len(filtered_rules) == 0 and configs.get('ipAuthRules', {}).get('enabled'):
+            raise ValueError("Cannot delete all rules when IP Auth is enabled.")
+
+        configs['ipAuthRules']['rules'] = filtered_rules
+        # clear configs to avoid updating something that is not allowed by org admins.
+        configs['configs'].clear()
+        command = self._api_client.update_organization_configuration_v2(data=configs, org_id=self.id)
+        return command
+
 
 @analytics_class_decorator
 class Organizations(CollectionModel):

{streamsets-6.5.0rc1 → streamsets-6.6.0.dev1}/streamsets.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: streamsets
-Version: 6.5.0rc1
+Version: 6.6.0.dev1
 Summary: A Python SDK for StreamSets
 Author: StreamSets Inc
 Classifier: Development Status :: 5 - Production/Stable

streamsets-6.5.0rc1/streamsets/sdk/__version__.py

@@ -1,3 +0,0 @@
-# Copyright 2024 StreamSets Inc.
-
-__version__ = "6.5.0rc1"