dasl-client 1.0.6__py3-none-any.whl → 1.0.9__py3-none-any.whl

dasl_client/types/dbui.py

@@ -24,12 +24,16 @@ class Dbui(BaseModel):
         Table column details.
 
         Attributes:
-            name (Optional[str]): The column name.
-            type_name (Optional[str]): The name of the column type.
-            type_detail (Optional[str]): Additional information about the
-                column's type.
-            position (Optional[int]): The column's index in the table.
-            nullable (Optional[bool]): Indicates if this column is nullable.
+            name (Optional[str]):
+                The column name.
+            type_name (Optional[str]):
+                The name of the column type.
+            type_detail (Optional[str]):
+                Additional information about the column's type.
+            position (Optional[int]):
+                The column's index in the table.
+            nullable (Optional[bool]):
+                Indicates if this column is nullable.
         """
 
         name: Optional[str] = None
@@ -125,12 +129,14 @@ class TransformRequest(BaseModel):
     silver).
 
     Attributes:
-        input (TransformRequest.Input): The input block containing the
-            columns metadata and data.
+        input (TransformRequest.Input):
+            The input block containing the columns metadata and data.
         autoloader_input (DataSource.Autoloader):
-        use_preset (str): Indicates which preset to use for the transforms.
-        transforms (List[TransformRequest.Transform]): A list of transform
-            configurations.
+            The autoloader input configuration.
+        use_preset (str):
+            Indicates which preset to use for the transforms.
+        transforms (List[TransformRequest.Transform]):
+            A list of transform configurations.
     """
 
     class Input(BaseModel):
@@ -138,10 +144,10 @@ class TransformRequest(BaseModel):
         Input data for the transform request.
 
         Attributes:
-            columns (List[Dbui.TableColumnDetails]): A list of metadata about
-                the columns.
-            data (List[Dict[str, str]]): The data represented as a list of
-                dictionaries.
+            columns (List[Dbui.TableColumnDetails]):
+                A list of metadata about the columns.
+            data (List[Dict[str, str]]):
+                The data represented as a list of dictionaries.
         """
 
         columns: List[Dbui.TableColumnDetails]
@@ -171,19 +177,24 @@ class TransformRequest(BaseModel):
         A transform configuration to apply to the data.
 
         Attributes:
-            transform_type (str): The type of transform (one of
-                SilverPreTransform, SilverTransform, Gold).
-            use_pre_transform_preset (str): Indicates which pre-transform
-                preset to use if requested.
-            use_preset_table (str): Indicates which table to use within the
-                preset's transform type for Silver and Gold.
+            transform_type (str):
+                The type of transform (one of SilverPreTransform,
+                SilverTransform, Gold).
+            use_pre_transform_preset (str):
+                Indicates which pre-transform preset to use if requested.
+            use_preset_table (str):
+                Indicates which table to use within the preset's transform
+                type for Silver and Gold.
             filter (str):
+                Filter expression.
             post_filter (str):
+                Filter expression applied after the transform.
             preset_overrides (TransformRequest.Transform.PresetOverrides):
                 Overrides for the preset configuration.
-            add_fields (List[FieldSpec]): Additional field specifications
-                to add.
-            utils (FieldUtils): Utility configurations for handling fields.
+            add_fields (List[FieldSpec]):
+                Additional field specifications to add.
+            utils (FieldUtils):
+                Utility configurations for handling fields.
         """
 
         class PresetOverrides(BaseModel):
@@ -191,8 +202,8 @@ class TransformRequest(BaseModel):
             Preset overrides for a transform configuration.
 
             Attributes:
-                omit_fields (List[str]): A list of fields to omit from
-                    the preset.
+                omit_fields (List[str]):
+                    A list of fields to omit from the preset.
             """
 
             omit_fields: Optional[List[str]] = None
@@ -293,8 +304,8 @@ class TransformResponse(BaseModel):
     applied on the data.
 
     Attributes:
-        stages (List[TransformResponse.Stages]): A list of stages
-            representing each intermediate transform step.
+        stages (List[TransformResponse.Stages]):
+            A list of stages representing each intermediate transform step.
     """
 
     class Stages(BaseModel):
@@ -302,12 +313,13 @@ class TransformResponse(BaseModel):
         A stage in the transform response.
 
         Attributes:
-            transform_type (str): The type of transform applied in this stage
-                (one of SilverPreTransform, SilverTransform, Gold, Input).
-            columns (List[Dbui.TableColumnDetails]): A list of metadata about
-                the columns returned in this stage.
-            data (List[Dict[str, str]]): The data represented as a list
-                of dictionaries.
+            transform_type (str):
+                The type of transform applied in this stage (one of
+                SilverPreTransform, SilverTransform, Gold, Input).
+            columns (List[Dbui.TableColumnDetails]):
+                A list of metadata about the columns returned in this stage.
+            data (List[Dict[str, str]]):
+                The data represented as a list of dictionaries.
         """
 
         transform_type: str

dasl_client/types/rule.py

@@ -29,15 +29,22 @@ class Rule(BaseModel):
     Rules define how to generate notables from input data.
 
     Attributes:
-        metadata (Optional[Metadata]): Standard object metadata.
-        rule_metadata (Optional[Rule.RuleMetadata]): The rule configuration
-            metadata.
-        schedule (Schedule): The rule schedule.
-        input (Rule.Input): The rule input configuration.
-        observables (Optional[List[Rule.Observable]]): A list of observables.
-        output (Rule.Output): The rule output configuration.
-        collate (Optional[Rule.Collate]): The collate configuration.
-        status (Optional[ResourceStatus]): The current status of the rule.
+        metadata (Optional[Metadata]):
+            Standard object metadata.
+        rule_metadata (Optional[Rule.RuleMetadata]):
+            The rule configuration metadata.
+        schedule (Schedule):
+            The rule schedule.
+        input (Rule.Input):
+            The rule input configuration.
+        observables (Optional[List[Rule.Observable]]):
+            A list of observables.
+        output (Rule.Output):
+            The rule output configuration.
+        collate (Optional[Rule.Collate]):
+            The collate configuration.
+        status (Optional[ResourceStatus]):
+            The current status of the rule.
     """
 
     class RuleMetadata(BaseModel):
@@ -45,23 +52,26 @@ class Rule(BaseModel):
         RuleMetadata object wrapping CoreV1RuleSpecMetadata.
 
         Attributes:
-            version (Optional[Union[float, int]]): The current version of
-                the rule.
-            category (Optional[str]): The category of this detection. The
-                available values are configured in workspace config.
-            severity (Optional[str]): The threat level associated with the
-                notable.
-            fidelity (Optional[str]): Fidelity is used to capture the maturity
-                of a rule. Newly created, untested rules should be marked as
-                Investigative fidelity. Older, more well-tested rules should
-                be marked as High fidelity. This helps an analyst determine
-                how likely a notable is a false positive.
-            mitre (Optional[List[Rule.RuleMetadata.Mitre]]): Mitre ATT&CK
-                tactic information.
-            objective (Optional[str]): A longer form description of what this
-                rule is attempting to detect (objectMeta.comment is a summary).
-            response (Optional[Rule.RuleMetadata.Response]): Response
-                configuration for the rule.
+            version (Optional[Union[float, int]]):
+                The current version of the rule.
+            category (Optional[str]):
+                The category of this detection. The available values are
+                configured in workspace config.
+            severity (Optional[str]):
+                The threat level associated with the notable.
+            fidelity (Optional[str]):
+                Fidelity is used to capture the maturity of a rule. Newly
+                created, untested rules should be marked as Investigative
+                fidelity. Older, more well-tested rules should be marked as
+                High fidelity. This helps an analyst determine how likely a
+                notable is a false positive.
+            mitre (Optional[List[Rule.RuleMetadata.Mitre]]):
+                Mitre ATT&CK tactic information.
+            objective (Optional[str]):
+                A longer form description of what this rule is attempting to
+                detect (objectMeta.comment is a summary).
+            response (Optional[Rule.RuleMetadata.Response]):
+                Response configuration for the rule.
         """
 
         class Mitre(BaseModel):
@@ -69,16 +79,18 @@ class Rule(BaseModel):
             Mitre ATT&CK details associated with a Rule.
 
             Attributes:
-                taxonomy (Optional[str]): Mitre ATT&CK taxonomy.
-                tactic (Optional[str]): Mitre ATT&CK tactic.
-                technique_id (Optional[str]): The Mitre ATT&CK technique
-                    identifier.
-                technique (Optional[str]): The Mitre ATT&CK technique human-
-                    readable name.
-                sub_technique_id (Optional[str]): The Mitre ATT&CK sub-
-                    technique identifier.
-                sub_technique (Optional[str]): The Mitre ATT&CK sub-technique
-                    human-readable name.
+                taxonomy (Optional[str]):
+                    Mitre ATT&CK taxonomy.
+                tactic (Optional[str]):
+                    Mitre ATT&CK tactic.
+                technique_id (Optional[str]):
+                    The Mitre ATT&CK technique identifier.
+                technique (Optional[str]):
+                    The Mitre ATT&CK technique human-readable name.
+                sub_technique_id (Optional[str]):
+                    The Mitre ATT&CK sub-technique identifier.
+                sub_technique (Optional[str]):
+                    The Mitre ATT&CK sub-technique human-readable name.
             """
 
             taxonomy: Optional[str] = None
@@ -120,7 +132,9 @@ class Rule(BaseModel):
 
             Attributes:
                 guidelines (Optional[str]):
+                    Response guidelines.
                 playbooks (Optional[List[Rule.RuleMetadata.Response.Playbook]]):
+                    Suggested response playbooks.
             """
 
             class Playbook(BaseModel):
@@ -130,9 +144,10 @@ class Rule(BaseModel):
 
                 Attributes:
                     notebook (Optional[str]):
-                    options (Optional[Dict[str, str]]): These are templated,
-                        if they contain ${} this will be filled in using the
-                        notable.
+                        Notebook to run.
+                    options (Optional[Dict[str, str]]):
+                        These are templated, if they contain ${} this will be
+                        filled in using the notable.
                 """
 
                 notebook: Optional[str] = None
@@ -231,7 +246,9 @@ class Rule(BaseModel):
 
         Attributes:
             stream (Optional[Rule.Input.Stream]):
+                Input if the Rule should operate on streaming input data.
             batch (Optional[Rule.Input.Batch]):
+                Input if the rule should operate on batched input data.
         """
 
         class Custom(BaseModel):
@@ -282,16 +299,21 @@ class Rule(BaseModel):
 
                 Attributes:
                     name (Optional[str]):
+                        Name of the table.
                     watermark (Optional[Rule.Input.Stream.Table.Watermark]):
-                    alias (Optional[str]): Alias name for the table.
-                    join_type (Optional[str]): For tables other than the
-                        first, how to join to the preceding table.
-                    join_expr (Optional[str]): For tables other than the
-                        first, the join condition expression to join with
-                        the preceding table.
-                    streaming (Optional[bool]): For tables other than the
-                        first, is this a streaming join or static. Default
-                        is false, except on the first table.
+                        Watermark configuration.
+                    alias (Optional[str]):
+                        Alias name for the table.
+                    join_type (Optional[str]):
+                        For tables other than the first, how to join to the
+                        preceding table.
+                    join_expr (Optional[str]):
+                        For tables other than the first, the join condition
+                        expression to join with the preceding table.
+                    streaming (Optional[bool]):
+                        For tables other than the first, is this a streaming
+                        join or static. Default is false, except on the first
+                        table.
                 """
 
                 class Watermark(BaseModel):
@@ -299,13 +321,14 @@ class Rule(BaseModel):
                     Watermark for a streaming input table.
 
                     Attributes:
-                        event_time_column (str): Which column is the event
-                            time for the delay threshold.
-                        delay_threshold (str): A time duration string for
-                            the watermark delay.
-                        drop_duplicates (Optional[List[str]]): Pass into
-                            pyspark dropDuplicates (effectively columns for
-                            group by).
+                        event_time_column (str):
+                            Which column is the event time for the delay
+                            threshold.
+                        delay_threshold (str):
+                            A time duration string for the watermark delay.
+                        drop_duplicates (Optional[List[str]]):
+                            Pass into pyspark dropDuplicates (effectively
+                            columns for group by).
                     """
 
                     event_time_column: str
@@ -467,10 +490,12 @@ class Rule(BaseModel):
             Risk level associated with an Observable.
 
             Attributes:
-                impact (str): A SQL expression indicating the impact (should
+                impact (str):
+                    A SQL expression indicating the impact (should evaluate to
+                    a number between 0-100).
+                confidence (str):
+                    A SQL expression indicating the confidence (should
                     evaluate to a number between 0-100).
-                confidence (str): A SQL expression indicating the confidence
-                    (should evaluate to a number between 0-100).
             """
 
             impact: str
@@ -550,13 +575,14 @@ class Rule(BaseModel):
         within a given timeframe.
 
         Attributes:
-            collate_on (Optional[List[str]]): SQL column(s) to collate
-                notables on. This must be either 'summary', 'context', or
-                a JSON key within 'context'. Only one level of nesting is
-                currently supported.
-            within (Optional[str]): A time duration string for the window
-                to collate within.
-            action (Optional[str]): append | updateStats | inhibit.
+            collate_on (Optional[List[str]]):
+                SQL column(s) to collate notables on. This must be either
+                'summary', 'context', or a JSON key within 'context'. Only
+                one level of nesting is currently supported.
+            within (Optional[str]):
+                A time duration string for the window to collate within.
+            action (Optional[str]):
+                append | updateStats | inhibit.
         """
 
         collate_on: Optional[List[str]] = None

dasl_client/types/types.py

@@ -9,36 +9,46 @@ from dasl_api import (
     CoreV1Schedule,
 )
 
+from dasl_client.conn.client_identifier import get_client_identifier
+
 
 class Metadata(BaseModel):
     """
     General resource metadata.
 
     Attributes:
-        name (Optional[str]): The name of the resource.
-        workspace (Optional[str]): The workspace to which the resource belongs.
-        comment (Optional[str]): A description or comment associated with
-            the resource.
-        annotations (Optional[Dict[str, Optional[str]]]): Annotations is an
-            unstructured key value map stored with a resource that may be set
-            by external tools to store and retrieve arbitrary metadata. They
-            are not queryable and should be preserved when modifying objects.
-        created_timestamp (Optional[datetime]): The time at which this
-            resource was created.
-        created_by (Optional[str]): The account that created this resource.
-        modified_timestamp (Optional[datetime]): The last time at which this
-            resource was modified.
-        last_successful_run_timestamp (Optional[datetime]): The last time at
-            which the job associated with this resource successfuly completed.
-        modified_by (Optional[str]): The account that modified this resource
-            most recently.
-        version (Optional[int]): The resource's version.
-        deleted (Optional[bool]): Indicates whether the resource has been
-            deleted.
-        resource_status (Optional[str]): Internal resource status. Cannot
-            be updated by the user.
-        ui_status (Optional[str]): Internal resource status. Cannot be
-            updated by the user.
+        name (Optional[str]):
+            The name of the resource.
+        workspace (Optional[str]):
+            The workspace to which the resource belongs.
+        comment (Optional[str]):
+            A description or comment associated with the resource.
+        annotations (Optional[Dict[str, Optional[str]]]):
+            Annotations is an unstructured key value map stored with a
+            resource that may be set by external tools to store and retrieve
+            arbitrary metadata. They are not queryable and should be preserved
+            when modifying objects.
+        created_timestamp (Optional[datetime]):
+            The time at which this resource was created.
+        created_by (Optional[str]):
+            The account that created this resource.
+        modified_timestamp (Optional[datetime]):
+            The last time at which this resource was modified.
+        last_successful_run_timestamp (Optional[datetime]):
+            The last time at which the job associated with this resource
+            successfuly completed.
+        modified_by (Optional[str]):
+            The account that modified this resource most recently.
+        version (Optional[int]):
+            The resource's version.
+        deleted (Optional[bool]):
+            Indicates whether the resource has been deleted.
+        resource_status (Optional[str]):
+            Internal resource status. Cannot be updated by the user.
+        ui_status (Optional[str]):
+            Internal resource status. Cannot be updated by the user.
+        client_of_origin (Optional[str]):
+            The client that last created or modified this resource.
     """
 
     name: Optional[str] = None
@@ -54,6 +64,7 @@ class Metadata(BaseModel):
     deleted: Optional[bool] = None
     resource_status: Optional[str] = None
     ui_status: Optional[str] = None
+    client_of_origin: Optional[str] = None
 
     @staticmethod
     def from_api_obj(obj: Optional[CommonV1ObjectMeta]) -> "Metadata":
@@ -73,6 +84,7 @@ class Metadata(BaseModel):
             deleted=obj.deleted,
             resource_status=obj.resource_status,
             ui_status=obj.ui_status,
+            client_of_origin=obj.client_of_origin,
         )
 
     def to_api_obj(self) -> CommonV1ObjectMeta:
@@ -90,6 +102,7 @@ class Metadata(BaseModel):
             deleted=self.deleted,
             resource_status=self.resource_status,
             ui_status=self.ui_status,
+            client_of_origin=self.client_of_origin or get_client_identifier(),
         )
 
 
@@ -98,16 +111,21 @@ class ResourceStatus(BaseModel):
     The status of the resource, along with status update events.
 
     Attributes:
-        job_id (Optional[int]): The associated Databricks Job ID.
-        job_name (str): The associated Databricks Job name.
-        enabled (bool): Indicates whether the resource is enabled.
-        notebook_path (str): The path to the Databricks notebook that the
-            Job has been scheduled with.
-        created_at (datetime): The time at which the resources were created
-            in Databricks.
-        job_status (str): The current reported status of the job.
-        events (List[StatusEvent]): The most recent 25 events related to
-            this resource.
+        job_id (Optional[int]):
+            The associated Databricks Job ID.
+        job_name (str):
+            The associated Databricks Job name.
+        enabled (bool):
+            Indicates whether the resource is enabled.
+        notebook_path (str):
+            The path to the Databricks notebook that the Job has been
+            scheduled with.
+        created_at (datetime):
+            The time at which the resources were created in Databricks.
+        job_status (str):
+            The current reported status of the job.
+        events (List[StatusEvent]):
+            The most recent 25 events related to this resource.
     """
 
     class StatusEvent(BaseModel):
@@ -115,12 +133,12 @@ class ResourceStatus(BaseModel):
         An event related to changes in the status of the resource.
 
         Attributes:
-            action (Optional[str]): The action taken as part of the lifecycle
-                of a resource.
-            message (Optional[str]): A human-readable message describing the
-                event.
-            recorded_at (Optional[datetime]): The timestamp associated with
-                the event.
+            action (Optional[str]):
+                The action taken as part of the lifecycle of a resource.
+            message (Optional[str]):
+                A human-readable message describing the event.
+            recorded_at (Optional[datetime]):
+                The timestamp associated with the event.
         """
 
         action: Optional[str] = None
@@ -183,18 +201,20 @@ class Schedule(BaseModel):
     A schedule for recurring dispatch of the Job(s) associated with a resource.
 
     Attributes:
-        at_least_every (Optional[str]): A duration string defining the
-            schedule. The string may contain components for days, hours,
-            minutes and seconds. Examples include '5d', '5d3h', '3d2h5m12s',
-            and '12m16s'.
-        exactly (Optional[str]): A quartz cron expression defining the
-            precise schedule for dispatch.
-        continuous (Optional[bool]): True if the Job should be continuously
-            dispatched, False/None otherwise.
-        compute_group (Optional[str]): 'dedicated', 'automatic' or a custom
-            group name.
-        enabled (Optional[bool]): Whether the schedule (and hence Job
-            associated with the resource) is active.
+        at_least_every (Optional[str]):
+            A duration string defining the schedule. The string may contain
+            components for days, hours, minutes and seconds. Examples include
+            '5d', '5d3h', '3d2h5m12s', and '12m16s'.
+        exactly (Optional[str]):
+            A quartz cron expression defining the precise schedule for dispatch.
+        continuous (Optional[bool]):
+            True if the Job should be continuously dispatched, False/None
+            otherwise.
+        compute_group (Optional[str]):
+            'dedicated', 'automatic' or a custom group name.
+        enabled (Optional[bool]):
+            Whether the schedule (and hence Job associated with the resource)
+            is active.
     """
 
     at_least_every: Optional[str] = None