acryl-datahub-cloud 0.3.10rc4__py3-none-any.whl → 0.3.16.1rc0__py3-none-any.whl

acryl_datahub_cloud/metadata/schemas/MetadataChangeLog.avsc

@@ -187,6 +187,9 @@
         "null",
         {
           "type": "record",
+          "Aspect": {
+            "name": "systemMetadata"
+          },
           "name": "SystemMetadata",
           "namespace": "com.linkedin.pegasus2avro.mxe",
           "fields": [
@@ -264,6 +267,67 @@
               "name": "version",
               "default": null,
               "doc": "Aspect version\n   Initial implementation will use the aspect version's number, however stored as\n   a string in the case where a different aspect versioning scheme is later adopted."
+            },
+            {
+              "type": [
+                "null",
+                {
+                  "type": "record",
+                  "name": "AuditStamp",
+                  "namespace": "com.linkedin.pegasus2avro.common",
+                  "fields": [
+                    {
+                      "type": "long",
+                      "name": "time",
+                      "doc": "When did the resource/association/sub-resource move into the specific lifecycle stage represented by this AuditEvent."
+                    },
+                    {
+                      "java": {
+                        "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+                      },
+                      "type": "string",
+                      "name": "actor",
+                      "doc": "The entity (e.g. a member URN) which will be credited for moving the resource/association/sub-resource into the specific lifecycle stage. It is also the one used to authorize the change.",
+                      "Urn": "Urn"
+                    },
+                    {
+                      "java": {
+                        "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+                      },
+                      "type": [
+                        "null",
+                        "string"
+                      ],
+                      "name": "impersonator",
+                      "default": null,
+                      "doc": "The entity (e.g. a service URN) which performs the change on behalf of the Actor and must be authorized to act as the Actor.",
+                      "Urn": "Urn"
+                    },
+                    {
+                      "type": [
+                        "null",
+                        "string"
+                      ],
+                      "name": "message",
+                      "default": null,
+                      "doc": "Additional context around how DataHub was informed of the particular change. For example: was the change created by an automated process, or manually."
+                    }
+                  ],
+                  "doc": "Data captured on a resource/association/sub-resource level giving insight into when that resource/association/sub-resource moved into a particular lifecycle stage, and who acted to move it into that specific lifecycle stage."
+                }
+              ],
+              "name": "aspectCreated",
+              "default": null,
+              "doc": "When the aspect was initially created and who created it, detected by version 0 -> 1 change"
+            },
+            {
+              "type": [
+                "null",
+                "com.linkedin.pegasus2avro.common.AuditStamp"
+              ],
+              "name": "aspectModified",
+              "default": null,
+              "doc": "When the aspect was last modified and the actor that performed the modification"
             }
           ],
           "doc": "Metadata associated with each metadata change that is processed by the system"
@@ -306,50 +370,7 @@
     {
       "type": [
         "null",
-        {
-          "type": "record",
-          "name": "AuditStamp",
-          "namespace": "com.linkedin.pegasus2avro.common",
-          "fields": [
-            {
-              "type": "long",
-              "name": "time",
-              "doc": "When did the resource/association/sub-resource move into the specific lifecycle stage represented by this AuditEvent."
-            },
-            {
-              "java": {
-                "class": "com.linkedin.pegasus2avro.common.urn.Urn"
-              },
-              "type": "string",
-              "name": "actor",
-              "doc": "The entity (e.g. a member URN) which will be credited for moving the resource/association/sub-resource into the specific lifecycle stage. It is also the one used to authorize the change.",
-              "Urn": "Urn"
-            },
-            {
-              "java": {
-                "class": "com.linkedin.pegasus2avro.common.urn.Urn"
-              },
-              "type": [
-                "null",
-                "string"
-              ],
-              "name": "impersonator",
-              "default": null,
-              "doc": "The entity (e.g. a service URN) which performs the change on behalf of the Actor and must be authorized to act as the Actor.",
-              "Urn": "Urn"
-            },
-            {
-              "type": [
-                "null",
-                "string"
-              ],
-              "name": "message",
-              "default": null,
-              "doc": "Additional context around how DataHub was informed of the particular change. For example: was the change created by an automated process, or manually."
-            }
-          ],
-          "doc": "Data captured on a resource/association/sub-resource level giving insight into when that resource/association/sub-resource moved into a particular lifecycle stage, and who acted to move it into that specific lifecycle stage."
-        }
+        "com.linkedin.pegasus2avro.common.AuditStamp"
       ],
       "name": "created",
       "default": null,

acryl_datahub_cloud/metadata/schemas/MetadataChangeProposal.avsc

@@ -187,6 +187,9 @@
         "null",
         {
           "type": "record",
+          "Aspect": {
+            "name": "systemMetadata"
+          },
           "name": "SystemMetadata",
           "namespace": "com.linkedin.pegasus2avro.mxe",
           "fields": [
@@ -264,6 +267,67 @@
               "name": "version",
               "default": null,
               "doc": "Aspect version\n   Initial implementation will use the aspect version's number, however stored as\n   a string in the case where a different aspect versioning scheme is later adopted."
+            },
+            {
+              "type": [
+                "null",
+                {
+                  "type": "record",
+                  "name": "AuditStamp",
+                  "namespace": "com.linkedin.pegasus2avro.common",
+                  "fields": [
+                    {
+                      "type": "long",
+                      "name": "time",
+                      "doc": "When did the resource/association/sub-resource move into the specific lifecycle stage represented by this AuditEvent."
+                    },
+                    {
+                      "java": {
+                        "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+                      },
+                      "type": "string",
+                      "name": "actor",
+                      "doc": "The entity (e.g. a member URN) which will be credited for moving the resource/association/sub-resource into the specific lifecycle stage. It is also the one used to authorize the change.",
+                      "Urn": "Urn"
+                    },
+                    {
+                      "java": {
+                        "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+                      },
+                      "type": [
+                        "null",
+                        "string"
+                      ],
+                      "name": "impersonator",
+                      "default": null,
+                      "doc": "The entity (e.g. a service URN) which performs the change on behalf of the Actor and must be authorized to act as the Actor.",
+                      "Urn": "Urn"
+                    },
+                    {
+                      "type": [
+                        "null",
+                        "string"
+                      ],
+                      "name": "message",
+                      "default": null,
+                      "doc": "Additional context around how DataHub was informed of the particular change. For example: was the change created by an automated process, or manually."
+                    }
+                  ],
+                  "doc": "Data captured on a resource/association/sub-resource level giving insight into when that resource/association/sub-resource moved into a particular lifecycle stage, and who acted to move it into that specific lifecycle stage."
+                }
+              ],
+              "name": "aspectCreated",
+              "default": null,
+              "doc": "When the aspect was initially created and who created it, detected by version 0 -> 1 change"
+            },
+            {
+              "type": [
+                "null",
+                "com.linkedin.pegasus2avro.common.AuditStamp"
+              ],
+              "name": "aspectModified",
+              "default": null,
+              "doc": "When the aspect was last modified and the actor that performed the modification"
             }
           ],
           "doc": "Metadata associated with each metadata change that is processed by the system"

acryl_datahub_cloud/metadata/schemas/MonitorAnomalyEvent.avsc

@@ -131,20 +131,24 @@
     },
     {
       "TimeseriesField": {},
-      "type": {
-        "type": "enum",
-        "symbolDocs": {
-          "CONFIRMED": "The anomaly has been confirmed by a human reviewer. This means the anomaly was validated.",
-          "REJECTED": "The anomaly has been dismissed, or ignored, by a human reviewer. This means the anomaly should have been ignored."
-        },
-        "name": "AnomalyReviewState",
-        "namespace": "com.linkedin.pegasus2avro.anomaly",
-        "symbols": [
-          "CONFIRMED",
-          "REJECTED"
-        ]
-      },
+      "type": [
+        "null",
+        {
+          "type": "enum",
+          "symbolDocs": {
+            "CONFIRMED": "The anomaly has been confirmed by a human reviewer. This means the anomaly was validated.",
+            "REJECTED": "The anomaly has been dismissed, or ignored, by a human reviewer. This means the anomaly should have been ignored."
+          },
+          "name": "AnomalyReviewState",
+          "namespace": "com.linkedin.pegasus2avro.anomaly",
+          "symbols": [
+            "CONFIRMED",
+            "REJECTED"
+          ]
+        }
+      ],
       "name": "state",
+      "default": null,
       "doc": "The review of the anomaly, based on human-provided feedback.\nIf this is not present, then the Anomaly has not yet been reviewed."
     },
     {
@@ -157,19 +161,28 @@
             "type": {
               "type": "enum",
               "symbolDocs": {
-                "INFERRED_ASSERTION_FAILURE": "An assertion has failed, triggering the anomaly."
+                "INFERRED_ASSERTION_FAILURE": "An assertion has failed, triggering the anomaly report.",
+                "USER_FEEDBACK": "An anomaly was reported by a user."
               },
               "name": "AnomalySourceType",
               "namespace": "com.linkedin.pegasus2avro.anomaly",
               "symbols": [
-                "INFERRED_ASSERTION_FAILURE"
+                "INFERRED_ASSERTION_FAILURE",
+                "USER_FEEDBACK"
               ]
             },
             "name": "type",
-            "doc": "Message associated with the anomaly"
+            "doc": "How this feedback was provided."
           },
           {
             "TimeseriesField": {},
+            "UrnValidation": {
+              "entityTypes": [
+                "assertion"
+              ],
+              "exist": false,
+              "strict": true
+            },
             "java": {
               "class": "com.linkedin.pegasus2avro.common.urn.Urn"
             },
@@ -179,9 +192,19 @@
             ],
             "name": "sourceUrn",
             "default": null,
-            "doc": "Reference to an URN related to the source of an anomaly.\nIf this anomaly was raised due to an inferred assertion failure, then this will contain the urn of the source Assertion.",
+            "doc": "Reference to an URN related to the source of an anomaly.\nFor assertion monitors, this will contain the urn of the source Assertion.",
             "Urn": "Urn"
           },
+          {
+            "TimeseriesField": {},
+            "type": [
+              "null",
+              "long"
+            ],
+            "name": "sourceEventTimestampMillis",
+            "default": null,
+            "doc": "The timestamp of the event that triggered the anomaly.\nFor assertion monitors, this will be the timestamp of the assertion run event."
+          },
           {
             "type": [
               "null",
@@ -191,23 +214,55 @@
                 "namespace": "com.linkedin.pegasus2avro.anomaly",
                 "fields": [
                   {
-                    "TimeseriesField": {},
                     "type": [
                       "null",
-                      "long"
+                      {
+                        "type": "record",
+                        "name": "AssertionMetric",
+                        "namespace": "com.linkedin.pegasus2avro.assertion",
+                        "fields": [
+                          {
+                            "type": "long",
+                            "name": "timestampMs",
+                            "doc": "The timestamp associated with the metric sampling time in milliseconds since epoch"
+                          },
+                          {
+                            "type": "float",
+                            "name": "value",
+                            "doc": "The value of the metric that was sampled"
+                          }
+                        ]
+                      }
                     ],
-                    "name": "assertionRunEventTime",
+                    "name": "assertionMetric",
                     "default": null,
-                    "doc": "The timestampMillis field of the AssertionRunEvent which altered the anomaly status the anomaly (if applicable)."
+                    "doc": "The monitor metric associated with the anomaly, if generated from an assertion monitor (the norm)."
                   },
                   {
                     "type": [
                       "null",
-                      "long"
+                      {
+                        "type": "record",
+                        "name": "OperationRange",
+                        "namespace": "com.linkedin.pegasus2avro.anomaly",
+                        "fields": [
+                          {
+                            "type": "long",
+                            "name": "startTimestampMillis",
+                            "doc": "The start timestamp of the operation in milliseconds since epoch."
+                          },
+                          {
+                            "type": "long",
+                            "name": "endTimestampMillis",
+                            "doc": "The end timestamp of the operation in milliseconds since epoch."
+                          }
+                        ],
+                        "doc": "The time range of the anomalous operation."
+                      }
                     ],
-                    "name": "metricCubeTimestamp",
+                    "name": "operationRange",
                     "default": null,
-                    "doc": "The timestamp associated with the metric cube value that triggered the anomaly."
+                    "doc": "The operation range associated with the anomaly, if generated from an assertion monitor (the norm).\nThis is specific to freshness assertions."
                   }
                 ],
                 "doc": "Ad-hoc properties about an anomaly source."
@@ -215,10 +270,10 @@
             ],
             "name": "properties",
             "default": null,
-            "doc": "Additional properties about the source, for example which evaluation\nof an assertion generated an Anomaly."
+            "doc": "Additional properties about the source, for example which metric\nof an assertion generated the anomaly."
           }
         ],
-        "doc": "Information about the source of an anomaly raised on an asset."
+        "doc": "Information about the source of feedback for an anomaly raised on an asset."
       },
       "name": "source",
       "doc": "The source of an anomaly, i.e. how it was generated."
@@ -252,14 +307,14 @@
         "doc": "A standard event timestamp"
       },
       "name": "created",
-      "doc": "The time at which the request was initially created"
+      "doc": "@Deprecated: this matches the timestampMillis field in the TimeseriesAspectBase."
     },
     {
       "TimeseriesField": {},
       "type": "com.linkedin.pegasus2avro.common.TimeStamp",
       "name": "lastUpdated",
-      "doc": "The time at which the request was initially created"
+      "doc": "The time at which the anomaly was last updated\n@Deprecated: this field is not used as this is an immutable log."
     }
   ],
-  "doc": "Information about an anomaly generated by a monitor"
+  "doc": "A feedback log of anomalies detected by a monitor\nNOTE: this is an immutable log. The most recent entry for a given run can be used to determine the state of the anomaly."
 }