acryl-datahub-cloud 0.3.8rc7__py3-none-any.whl → 0.3.8rc9__py3-none-any.whl

acryl_datahub_cloud/metadata/schemas/AssertionSummary.avsc

@@ -0,0 +1,50 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "assertionSummary"
+  },
+  "name": "AssertionSummary",
+  "namespace": "com.linkedin.pegasus2avro.assertion",
+  "fields": [
+    {
+      "Searchable": {
+        "fieldName": "lastFailedAtMillis",
+        "fieldType": "DATETIME"
+      },
+      "type": [
+        "null",
+        "long"
+      ],
+      "name": "lastFailedAtMillis",
+      "default": null,
+      "doc": "The last failure event timestamp field as epoch at UTC in milliseconds."
+    },
+    {
+      "Searchable": {
+        "fieldName": "lastErroredAtMillis",
+        "fieldType": "DATETIME"
+      },
+      "type": [
+        "null",
+        "long"
+      ],
+      "name": "lastErroredAtMillis",
+      "default": null,
+      "doc": "The last error event timestamp field as epoch at UTC in milliseconds."
+    },
+    {
+      "Searchable": {
+        "fieldName": "lastPassedAtMillis",
+        "fieldType": "DATETIME"
+      },
+      "type": [
+        "null",
+        "long"
+      ],
+      "name": "lastPassedAtMillis",
+      "default": null,
+      "doc": "The last pass event timestamp field as epoch at UTC in milliseconds."
+    }
+  ],
+  "doc": "Derived.\nTracks the latest summary details of an assertion."
+}

acryl_datahub_cloud/metadata/schemas/AssertionsSummary.avsc

@@ -0,0 +1,189 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "assertionsSummary"
+  },
+  "name": "AssertionsSummary",
+  "namespace": "com.linkedin.pegasus2avro.common",
+  "fields": [
+    {
+      "deprecated": true,
+      "type": {
+        "type": "array",
+        "items": "string"
+      },
+      "name": "failingAssertions",
+      "default": [],
+      "doc": "Failing assertions for an asset\nDeprecated! Use failingAssertionDetails.",
+      "Urn": "Urn",
+      "urn_is_array": true
+    },
+    {
+      "deprecated": true,
+      "type": {
+        "type": "array",
+        "items": "string"
+      },
+      "name": "passingAssertions",
+      "default": [],
+      "doc": "Passing assertions for an asset\nDeprecated! Use passingAssertionDetails.",
+      "Urn": "Urn",
+      "urn_is_array": true
+    },
+    {
+      "Relationship": {
+        "/*/urn": {
+          "entityTypes": [
+            "assertion"
+          ],
+          "name": "PassingAssertions"
+        }
+      },
+      "Searchable": {
+        "/*/lastResultAt": {
+          "fieldName": "passingAssertionResultTimes",
+          "fieldType": "DATETIME",
+          "queryByDefault": false
+        },
+        "/*/source": {
+          "fieldName": "passingAssertionSources",
+          "queryByDefault": false
+        },
+        "/*/type": {
+          "fieldName": "passingAssertionTypes",
+          "fieldType": "KEYWORD",
+          "queryByDefault": false
+        },
+        "/*/urn": {
+          "fieldName": "passingAssertions",
+          "fieldType": "URN",
+          "hasValuesFieldName": "hasPassingAssertions",
+          "numValuesFieldName": "numPassingAssertions",
+          "queryByDefault": false
+        }
+      },
+      "type": {
+        "type": "array",
+        "items": {
+          "type": "record",
+          "name": "AssertionSummaryDetails",
+          "namespace": "com.linkedin.pegasus2avro.common",
+          "fields": [
+            {
+              "java": {
+                "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+              },
+              "type": "string",
+              "name": "urn",
+              "doc": "The urn of the assertion",
+              "Urn": "Urn"
+            },
+            {
+              "type": "string",
+              "name": "type",
+              "doc": "The top-level type of an assertion"
+            },
+            {
+              "type": "long",
+              "name": "lastResultAt",
+              "doc": "The time at which the last result was produced."
+            },
+            {
+              "type": [
+                "null",
+                "string"
+              ],
+              "name": "source",
+              "default": null,
+              "doc": "The source of the assertion"
+            }
+          ],
+          "doc": "Summary statistics about assertions on an entity."
+        }
+      },
+      "name": "passingAssertionDetails",
+      "default": [],
+      "doc": "Summary details about the set of passing assertions"
+    },
+    {
+      "Relationship": {
+        "/*/urn": {
+          "entityTypes": [
+            "assertion"
+          ],
+          "name": "FailingAssertions"
+        }
+      },
+      "Searchable": {
+        "/*/lastResultAt": {
+          "fieldName": "failingAssertionResultTimes",
+          "fieldType": "DATETIME",
+          "queryByDefault": false
+        },
+        "/*/source": {
+          "fieldName": "failingAssertionSources",
+          "queryByDefault": false
+        },
+        "/*/type": {
+          "fieldName": "failingAssertionType",
+          "fieldType": "KEYWORD",
+          "queryByDefault": false
+        },
+        "/*/urn": {
+          "addHasValuesToFilters": true,
+          "fieldName": "failingAssertions",
+          "fieldType": "URN",
+          "hasValuesFieldName": "hasFailingAssertions",
+          "numValuesFieldName": "numFailingAssertions",
+          "queryByDefault": false
+        }
+      },
+      "type": {
+        "type": "array",
+        "items": "com.linkedin.pegasus2avro.common.AssertionSummaryDetails"
+      },
+      "name": "failingAssertionDetails",
+      "default": [],
+      "doc": "Summary details about the set of failing assertions"
+    },
+    {
+      "Relationship": {
+        "/*/urn": {
+          "entityTypes": [
+            "assertion"
+          ],
+          "name": "ErroringAssertions"
+        }
+      },
+      "Searchable": {
+        "/*/lastResultAt": {
+          "fieldName": "erroringAssertionResultTimes",
+          "fieldType": "DATETIME"
+        },
+        "/*/source": {
+          "fieldName": "erroringAssertionSources",
+          "queryByDefault": false
+        },
+        "/*/type": {
+          "fieldName": "erroringAssertionType",
+          "fieldType": "KEYWORD"
+        },
+        "/*/urn": {
+          "fieldName": "erroringAssertions",
+          "fieldType": "URN",
+          "hasValuesFieldName": "hasErroringAssertions",
+          "numValuesFieldName": "numErroringAssertions",
+          "queryByDefault": false
+        }
+      },
+      "type": {
+        "type": "array",
+        "items": "com.linkedin.pegasus2avro.common.AssertionSummaryDetails"
+      },
+      "name": "erroringAssertionDetails",
+      "default": [],
+      "doc": "Summary details about the set of erroring assertions"
+    }
+  ],
+  "doc": "Summary related to entity assertions"
+}

acryl_datahub_cloud/metadata/schemas/BatchTestRunEvent.avsc

@@ -0,0 +1,286 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "batchTestRunEvent",
+    "type": "timeseries"
+  },
+  "name": "BatchTestRunEvent",
+  "namespace": "com.linkedin.pegasus2avro.test",
+  "fields": [
+    {
+      "Searchable": {
+        "fieldName": "lastCompletedTime",
+        "fieldType": "DATETIME"
+      },
+      "type": "long",
+      "name": "timestampMillis",
+      "doc": "The event timestamp field as epoch at UTC in milli seconds."
+    },
+    {
+      "TimeseriesField": {},
+      "type": {
+        "type": "enum",
+        "symbolDocs": {
+          "COMPLETE": "The Test Run has completed",
+          "RUNNING": "The Test is currently in progress"
+        },
+        "name": "BatchTestRunStatus",
+        "namespace": "com.linkedin.pegasus2avro.test",
+        "symbols": [
+          "RUNNING",
+          "COMPLETE"
+        ]
+      },
+      "name": "status",
+      "doc": "The status of the Test run as per this timeseries event."
+    },
+    {
+      "type": [
+        "null",
+        {
+          "type": "record",
+          "name": "BatchTestRunResult",
+          "namespace": "com.linkedin.pegasus2avro.test",
+          "fields": [
+            {
+              "type": "long",
+              "name": "passingCount",
+              "doc": "Number of assets that were passing the test."
+            },
+            {
+              "type": "long",
+              "name": "failingCount",
+              "doc": "Number of assets that were failing the test."
+            },
+            {
+              "type": [
+                "null",
+                "string"
+              ],
+              "name": "testDefinition",
+              "default": null,
+              "doc": "Test definition that was used to run the test."
+            },
+            {
+              "type": [
+                "null",
+                {
+                  "type": "record",
+                  "name": "TestReport",
+                  "namespace": "com.linkedin.pegasus2avro.test",
+                  "fields": [
+                    {
+                      "type": [
+                        "null",
+                        {
+                          "type": "record",
+                          "name": "TestActionsReport",
+                          "namespace": "com.linkedin.pegasus2avro.test",
+                          "fields": [
+                            {
+                              "type": [
+                                "null",
+                                {
+                                  "type": "array",
+                                  "items": {
+                                    "type": "record",
+                                    "name": "TestActionsError",
+                                    "namespace": "com.linkedin.pegasus2avro.test",
+                                    "fields": [
+                                      {
+                                        "type": "string",
+                                        "name": "actionType",
+                                        "doc": "The type of action being taken in this test"
+                                      },
+                                      {
+                                        "java": {
+                                          "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+                                        },
+                                        "type": [
+                                          "null",
+                                          "string"
+                                        ],
+                                        "name": "urn",
+                                        "default": null,
+                                        "doc": "The asset urn related to this error",
+                                        "Urn": "Urn"
+                                      },
+                                      {
+                                        "type": [
+                                          "null",
+                                          "string"
+                                        ],
+                                        "name": "message",
+                                        "default": null,
+                                        "doc": "Any additional info about this error"
+                                      }
+                                    ],
+                                    "doc": "Error related to the actions applied in this test"
+                                  }
+                                }
+                              ],
+                              "name": "errors",
+                              "default": null,
+                              "doc": "Errors related to the actions applied in this test"
+                            },
+                            {
+                              "type": [
+                                "null",
+                                "long"
+                              ],
+                              "name": "totalEntityCount",
+                              "default": null,
+                              "doc": "The total number of entities that are affected by the actions of this test"
+                            },
+                            {
+                              "type": [
+                                "null",
+                                "long"
+                              ],
+                              "name": "processedEntityCount",
+                              "default": null,
+                              "doc": "The number of entities that have already been acted upon by this test automation"
+                            }
+                          ],
+                          "doc": "Report related to the actions applied in this test"
+                        }
+                      ],
+                      "name": "actions",
+                      "default": null,
+                      "doc": "Report related to the actions applied in this test"
+                    }
+                  ]
+                }
+              ],
+              "name": "report",
+              "default": null,
+              "doc": "Reporting information about the run event of this metadata test"
+            }
+          ],
+          "doc": "The result of running a batch metadata test"
+        }
+      ],
+      "name": "result",
+      "default": null,
+      "doc": "Results of test, present if the status is COMPLETE"
+    },
+    {
+      "type": [
+        "null",
+        {
+          "type": "record",
+          "name": "TimeWindowSize",
+          "namespace": "com.linkedin.pegasus2avro.timeseries",
+          "fields": [
+            {
+              "type": {
+                "type": "enum",
+                "name": "CalendarInterval",
+                "namespace": "com.linkedin.pegasus2avro.timeseries",
+                "symbols": [
+                  "SECOND",
+                  "MINUTE",
+                  "HOUR",
+                  "DAY",
+                  "WEEK",
+                  "MONTH",
+                  "QUARTER",
+                  "YEAR"
+                ]
+              },
+              "name": "unit",
+              "doc": "Interval unit such as minute/hour/day etc."
+            },
+            {
+              "type": "int",
+              "name": "multiple",
+              "default": 1,
+              "doc": "How many units. Defaults to 1."
+            }
+          ],
+          "doc": "Defines the size of a time window."
+        }
+      ],
+      "name": "eventGranularity",
+      "default": null,
+      "doc": "Granularity of the event if applicable"
+    },
+    {
+      "type": [
+        {
+          "type": "record",
+          "name": "PartitionSpec",
+          "namespace": "com.linkedin.pegasus2avro.timeseries",
+          "fields": [
+            {
+              "TimeseriesField": {},
+              "type": "string",
+              "name": "partition",
+              "doc": "A unique id / value for the partition for which statistics were collected,\ngenerated by applying the key definition to a given row."
+            },
+            {
+              "type": [
+                "null",
+                {
+                  "type": "record",
+                  "name": "TimeWindow",
+                  "namespace": "com.linkedin.pegasus2avro.timeseries",
+                  "fields": [
+                    {
+                      "type": "long",
+                      "name": "startTimeMillis",
+                      "doc": "Start time as epoch at UTC."
+                    },
+                    {
+                      "type": "com.linkedin.pegasus2avro.timeseries.TimeWindowSize",
+                      "name": "length",
+                      "doc": "The length of the window."
+                    }
+                  ]
+                }
+              ],
+              "name": "timePartition",
+              "default": null,
+              "doc": "Time window of the partition, if we are able to extract it from the partition key."
+            },
+            {
+              "deprecated": true,
+              "type": {
+                "type": "enum",
+                "name": "PartitionType",
+                "namespace": "com.linkedin.pegasus2avro.timeseries",
+                "symbols": [
+                  "FULL_TABLE",
+                  "QUERY",
+                  "PARTITION"
+                ]
+              },
+              "name": "type",
+              "default": "PARTITION",
+              "doc": "Unused!"
+            }
+          ],
+          "doc": "A reference to a specific partition in a dataset."
+        },
+        "null"
+      ],
+      "name": "partitionSpec",
+      "default": {
+        "partition": "FULL_TABLE_SNAPSHOT",
+        "type": "FULL_TABLE",
+        "timePartition": null
+      },
+      "doc": "The optional partition specification."
+    },
+    {
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "messageId",
+      "default": null,
+      "doc": "The optional messageId, if provided serves as a custom user-defined unique identifier for an aspect value."
+    }
+  ],
+  "doc": "An event representing the current status of evaluating a batch metadata test (run offline)"
+}

acryl_datahub_cloud/metadata/schemas/BrowsePaths.avsc

@@ -0,0 +1,25 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "browsePaths"
+  },
+  "name": "BrowsePaths",
+  "namespace": "com.linkedin.pegasus2avro.common",
+  "fields": [
+    {
+      "Searchable": {
+        "/*": {
+          "fieldName": "browsePaths",
+          "fieldType": "BROWSE_PATH"
+        }
+      },
+      "type": {
+        "type": "array",
+        "items": "string"
+      },
+      "name": "paths",
+      "doc": "A list of valid browse paths for the entity.\n\nBrowse paths are expected to be forward slash-separated strings. For example: 'prod/snowflake/datasetName'"
+    }
+  ],
+  "doc": "Shared aspect containing Browse Paths to be indexed for an entity."
+}

acryl_datahub_cloud/metadata/schemas/BrowsePathsV2.avsc

@@ -0,0 +1,50 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "browsePathsV2"
+  },
+  "name": "BrowsePathsV2",
+  "namespace": "com.linkedin.pegasus2avro.common",
+  "fields": [
+    {
+      "Searchable": {
+        "/*/id": {
+          "fieldName": "browsePathV2",
+          "fieldType": "BROWSE_PATH_V2"
+        }
+      },
+      "type": {
+        "type": "array",
+        "items": {
+          "type": "record",
+          "name": "BrowsePathEntry",
+          "namespace": "com.linkedin.pegasus2avro.common",
+          "fields": [
+            {
+              "type": "string",
+              "name": "id",
+              "doc": "The ID of the browse path entry. This is what gets stored in the index.\nIf there's an urn associated with this entry, id and urn will be the same"
+            },
+            {
+              "java": {
+                "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+              },
+              "type": [
+                "null",
+                "string"
+              ],
+              "name": "urn",
+              "default": null,
+              "doc": "Optional urn pointing to some entity in DataHub",
+              "Urn": "Urn"
+            }
+          ],
+          "doc": "Represents a single level in an entity's browsePathV2"
+        }
+      },
+      "name": "path",
+      "doc": "A valid browse path for the entity. This field is provided by DataHub by default.\nThis aspect is a newer version of browsePaths where we can encode more information in the path.\nThis path is also based on containers for a given entity if it has containers.\n\nThis is stored in elasticsearch as unit-separator delimited strings and only includes platform specific folders or containers.\nThese paths should not include high level info captured elsewhere ie. Platform and Environment."
+    }
+  ],
+  "doc": "Shared aspect containing a Browse Path to be indexed for an entity."
+}