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

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

@@ -17,32 +17,38 @@ 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.
-        client_of_origin (Optional[str]): The client that last created or
-            modified this resource.
+        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
@@ -105,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):
@@ -122,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
@@ -190,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

dasl_client/types/workspace_config.py

@@ -30,13 +30,14 @@ class ExportConfig(BaseModel):
 
     Attributes:
         destination (Optional[str]):
-        export_open_only (Optional[bool]): If true, only open events are
-            exported. If false, any event not in state . ClosedAsExported
-            will be exported.
-        webhook_config (Optional[ExportConfig.WebhookConfig]): Set when
-            exporting to a webhook.
-        slack_config (Optional[ExportConfig.SlackConfig]): Set when exporting
-            to slack.
+            Name of the destination. 'webhook' or 'slack'.
+        export_open_only (Optional[bool]):
+            If true, only open events are exported. If false, any event not
+            in state ClosedAsExported  will be exported.
+        webhook_config (Optional[ExportConfig.WebhookConfig]):
+            Set when exporting to a webhook.
+        slack_config (Optional[ExportConfig.SlackConfig]):
+            Set when exporting to slack.
     """
 
     class WebhookDestination(BaseModel):
@@ -245,15 +246,15 @@ class DefaultConfig(BaseModel):
     specified DefaultConfig.
 
     Attributes:
-        datasources (Optional[DefaultConfig.Config]): Configuration that
-            applies to DataSources. May be omitted.
-        transforms (Optional[DefaultConfig.Config]): Configuration that
-            applies to Transforms. May be omitted.
-        rules (Optional[DefaultConfig.Config]): Configuration that applies
-            to Rules. May be omitted.
-        var_global (Optional[DefaultConfig.Config]): Configuration that
-            applies globally to resources without a resource-specific
-            configuration specified. Must be specified.
+        datasources (Optional[DefaultConfig.Config]):
+            Configuration that applies to DataSources. May be omitted.
+        transforms (Optional[DefaultConfig.Config]):
+            Configuration that applies to Transforms. May be omitted.
+        rules (Optional[DefaultConfig.Config]):
+            Configuration that applies to Rules. May be omitted.
+        var_global (Optional[DefaultConfig.Config]):
+            Configuration that applies globally to resources without a
+            resource-specific configuration specified. Must be specified.
     """
 
     class Config(BaseModel):
@@ -261,26 +262,25 @@ class DefaultConfig(BaseModel):
         Default configuration for a specific resource type.
 
         Attributes:
-            notebook_location (Optional[str]): A location for user created/
-                edited/provided notebook.
-            bronze_schema (Optional[str]): Name of the bronze schema in
-                the catalog.
-            silver_schema (Optional[str]): Name of the silver schema in
-                the catalog.
-            gold_schema (Optional[str]): Name of the gold schema in
-                the catalog.
-            catalog_name (Optional[str]): The catalog name to use as the
-                resource's default.
-            default_max_resources_per_job (Optional[int]): Default maximum
-                number of resources that can be placed into a single job,
-                subject to compute_group_overrides.
-            checkpoint_location (Optional[str]): The location to store
-                checkpoints for streaming writes. If not provided, the
-                daslStoragePath will be used.
-            compute_group_overrides (Optional[Dict[str, DefaultConfig.
-                Config.ComputeGroupOverrides]]): Overrides for the maximum
-                number of resources that can be placed into a single job,
-                keyed by the compute group name.
+            notebook_location (Optional[str]):
+                A location for user created/edited/provided notebook.
+            bronze_schema (Optional[str]):
+                Name of the bronze schema in the catalog.
+            silver_schema (Optional[str]):
+                Name of the silver schema in the catalog.
+            gold_schema (Optional[str]):
+                Name of the gold schema in the catalog.
+            catalog_name (Optional[str]):
+                The catalog name to use as the resource's default.
+            default_max_resources_per_job (Optional[int]):
+                Default maximum number of resources that can be placed into
+                a single job, subject to compute_group_overrides.
+            checkpoint_location (Optional[str]):
+                The location to store checkpoints for streaming writes. If
+                not provided, the daslStoragePath will be used.
+            compute_group_overrides (Optional[Dict[str, DefaultConfig.Config.ComputeGroupOverrides]]):
+                Overrides for the maximum number of resources that can be
+                placed into a single job, keyed by the compute group name.
         """
 
         class ComputeGroupOverrides(BaseModel):
@@ -289,9 +289,9 @@ class DefaultConfig(BaseModel):
             into a single job.
 
             Attributes:
-                max_resources_per_job (Optional[int]): The maximum number
-                    of resources that can be placed into a job before a
-                    new job will be created.
+                max_resources_per_job (Optional[int]):
+                    The maximum number of resources that can be placed into a
+                    job before a new job will be created.
             """
 
             max_resources_per_job: Optional[int] = None
@@ -408,14 +408,18 @@ class ManagedRetention(BaseModel):
     Configuration of cleanup jobs for old data stored by DASL.
 
     Attributes:
-        catalog (str): The name of the catalog.
-        var_schema (str): The name of the schema.
+        catalog (str):
+            The name of the catalog.
+        var_schema (str):
+            The name of the schema.
         column (Optional[str]):
-        duration (Optional[str]): The duration for which to retain data in
-            the schema. It may also be "forever" to indicate data should not
-            be deleted.
-        overrides (Optional[List[ManagedRetention.Overrides]]): Overrides for
-            per-table retention rules within the specified catalog and schema.
+            The name of the column.
+        duration (Optional[str]):
+            The duration for which to retain data in the schema. It may also
+            be "forever" to indicate data should not be deleted.
+        overrides (Optional[List[ManagedRetention.Overrides]]):
+            Overrides for per-table retention rules within the specified
+            catalog and schema.
     """
 
     class Overrides(BaseModel):
@@ -423,11 +427,13 @@ class ManagedRetention(BaseModel):
         Per-table retention override settings.
 
         Attributes:
-            table (str): The name of the table in the catalog and schema.
+            table (str):
+                The name of the table in the catalog and schema.
             column (Optional[str]):
-            duration (Optional[str]): The duration for which to retain data
-                in the table. It may also be "forever" to indicate data
-                should not be deleted.
+                The name of the column.
+            duration (Optional[str]):
+                The duration for which to retain data in the table. It may
+                also be "forever" to indicate data should not be deleted.
         """
 
         table: str
@@ -495,8 +501,10 @@ class SystemTablesConfig(BaseModel):
     control plane) will be stored.
 
     Attributes:
-        catalog_name (str): The name of the catalog in which to store data.
-        var_schema (str): The name of the schema in which to create tables.
+        catalog_name (str):
+            The name of the catalog in which to store data.
+        var_schema (str):
+            The name of the schema in which to create tables.
     """
 
     catalog_name: str
@@ -549,29 +557,33 @@ class WorkspaceConfig(BaseModel):
     General configuration settings for the Workspace.
 
     Attributes:
-        metadata (Optional[Metadata]): Common resource metadata; generally
-            managed by the control plane.
-        system_tables_config (SystemTablesConfig): Configuration for the
-            storage of metadata by the control plane.
-        default_sql_warehouse (Optional[str]): Default SQL warehouse to use
-            for executing certain queries. May be overridden in some cases.
+        metadata (Optional[Metadata]):
+            Common resource metadata; generally managed by the control plane.
+        system_tables_config (SystemTablesConfig):
+            Configuration for the storage of metadata by the control plane.
+        default_sql_warehouse (Optional[str]):
+            Default SQL warehouse to use for executing certain queries. May
+            be overridden in some cases.
         detection_rule_metadata (Optional[DetectionRuleMetadata]):
-        notable_export (Optional[ExportConfig]): Settings related to the
-            export of notables to various destinations.
-        operational_alert_export (Optional[ExportConfig]): Settings related
-            to the export of operational alerts to various destinations.
-        observables (Optional[WorkspaceConfigObservables]): Declaration of
-            the types of observables generated by the system.
-        dasl_storage_path (Optional[str]): The path to a directory where
-            DASL can store internal files and state.
-        default_config (Optional[DefaultConfig]): Configuration settings
-            regarding storage of bronze, silver, and gold tables and
-            related assets for each resource type.
-        managed_retention (Optional[List[ManagedRetention]]): Configuration
-            of regular cleanup (i.e. pruning) jobs for various catalogs,
-            schemas, and tables.
-        status (Optional[ResourceStatus]): Common resource status; wholly
-            managed by the control plane.
+            Detection rule metadata.
+        notable_export (Optional[ExportConfig]):
+            Settings related to the export of notables to various destinations.
+        operational_alert_export (Optional[ExportConfig]):
+            Settings related to the export of operational alerts to various
+            destinations.
+        observables (Optional[WorkspaceConfigObservables]):
+            Declaration of the types of observables generated by the system.
+        dasl_storage_path (Optional[str]):
+            The path to a directory where DASL can store internal files and
+            state.
+        default_config (Optional[DefaultConfig]):
+            Configuration settings regarding storage of bronze, silver, and
+            gold tables and related assets for each resource type.
+        managed_retention (Optional[List[ManagedRetention]]):
+            Configuration of regular cleanup (i.e. pruning) jobs for various
+            catalogs, schemas, and tables.
+        status (Optional[ResourceStatus]):
+            Common resource status; wholly managed by the control plane.
     """
 
     metadata: Optional[Metadata] = None

{dasl_client-1.0.7.dist-info → dasl_client-1.0.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dasl_client
-Version: 1.0.7
+Version: 1.0.9
 Summary: The DASL client library used for interacting with the DASL workspace
 Home-page: https://github.com/antimatter/asl
 Author: Antimatter Team
@@ -11,6 +11,7 @@ License-File: LICENSE
 Requires-Dist: dasl-api ==0.1.12
 Requires-Dist: databricks-sdk >=0.41.0
 Requires-Dist: pydantic >=2
+Requires-Dist: typing-extensions ==4.10.0
 
 # DASL Client Library