acryl-datahub-cloud 0.3.7.7rc4__py3-none-any.whl → 0.3.8rc0__py3-none-any.whl

acryl_datahub_cloud/metadata/schema.avsc

@@ -1680,6 +1680,7 @@
                                         "type": "enum",
                                         "symbolDocs": {
                                           "ANCESTORS_INCL": "Represent the relation: URN field matches any nested parent in addition to the given URN",
+                                          "BETWEEN": "Represent the relation within an inclusive range, e.g. 3 <= ownerCount <= 5. Note that the values in Criterion must have two entries for a lower and upper bound.",
                                           "CONTAIN": "Represent the relation: String field contains value, e.g. name contains Profile",
                                           "DESCENDANTS_INCL": "Represent the relation: URN field any nested children in addition to the given URN",
                                           "END_WITH": "Represent the relation: String field ends with value, e.g. name ends with Event",
@@ -1709,6 +1710,7 @@
                                           "IN",
                                           "LESS_THAN",
                                           "LESS_THAN_OR_EQUAL_TO",
+                                          "BETWEEN",
                                           "START_WITH",
                                           "DESCENDANTS_INCL",
                                           "ANCESTORS_INCL",
@@ -2418,6 +2420,32 @@
       }
     ]
   },
+  {
+    "type": "record",
+    "Aspect": {
+      "name": "versionSetKey",
+      "keyForEntity": "versionSet",
+      "entityCategory": "core",
+      "entityAspects": [
+        "versionSetProperties"
+      ]
+    },
+    "name": "VersionSetKey",
+    "namespace": "com.linkedin.pegasus2avro.metadata.key",
+    "fields": [
+      {
+        "type": "string",
+        "name": "id",
+        "doc": "ID of the Version Set, generated from platform + asset id / name"
+      },
+      {
+        "type": "string",
+        "name": "entityType",
+        "doc": "Type of entities included in version set, limits to a single entity type between linked versioned entities"
+      }
+    ],
+    "doc": "Key for a Version Set entity"
+  },
   {
     "type": "record",
     "Aspect": {
@@ -3389,7 +3417,8 @@
         "documentation",
         "testResults",
         "schemaFieldProfile",
-        "lineageFeatures"
+        "lineageFeatures",
+        "deprecation"
       ]
     },
     "name": "SchemaFieldKey",
@@ -4090,7 +4119,8 @@
         "share",
         "origin",
         "documentation",
-        "entityInferenceMetadata"
+        "entityInferenceMetadata",
+        "versionProperties"
       ],
       "entityDoc": "Datasets represent logical or physical data assets stored or represented in various data platforms. Tables, Views, Streams are all instances of datasets."
     },
@@ -4409,7 +4439,8 @@
         "origin",
         "lineageFeatures",
         "documentation",
-        "incidentsSummary"
+        "incidentsSummary",
+        "versionProperties"
       ]
     },
     "name": "MLModelKey",
@@ -6195,6 +6226,7 @@
       "entityCategory": "core",
       "entityAspects": [
         "propertyDefinition",
+        "structuredPropertySettings",
         "institutionalMemory",
         "status",
         "share",
@@ -6536,6 +6568,7 @@
         "Searchable": {
           "fieldType": "KEYWORD"
         },
+        "deprecated": true,
         "type": [
           {
             "type": "enum",
@@ -6554,10 +6587,81 @@
         ],
         "name": "filterStatus",
         "default": "DISABLED",
-        "doc": "The filter status of this structured property - whether it will show up in search filters or not"
+        "doc": "The filter status of this structured property - whether it will show up in search filters or not\nDeprecated! Use structuredPropertySettings.showInSearchFilters instead"
       }
     ]
   },
+  {
+    "type": "record",
+    "Aspect": {
+      "name": "structuredPropertySettings"
+    },
+    "name": "StructuredPropertySettings",
+    "namespace": "com.linkedin.pegasus2avro.structured",
+    "fields": [
+      {
+        "Searchable": {
+          "fieldType": "BOOLEAN"
+        },
+        "type": "boolean",
+        "name": "isHidden",
+        "default": false,
+        "doc": "Whether or not this asset should be hidden in the main application"
+      },
+      {
+        "Searchable": {
+          "fieldType": "BOOLEAN"
+        },
+        "type": "boolean",
+        "name": "showInSearchFilters",
+        "default": false,
+        "doc": "Whether or not this asset should be displayed as a search filter"
+      },
+      {
+        "Searchable": {
+          "fieldType": "BOOLEAN"
+        },
+        "type": "boolean",
+        "name": "showInAssetSummary",
+        "default": false,
+        "doc": "Whether or not this asset should be displayed in the asset sidebar"
+      },
+      {
+        "Searchable": {
+          "fieldType": "BOOLEAN"
+        },
+        "type": "boolean",
+        "name": "showAsAssetBadge",
+        "default": false,
+        "doc": "Whether or not this asset should be displayed as an asset badge on other\nasset's headers"
+      },
+      {
+        "Searchable": {
+          "fieldType": "BOOLEAN"
+        },
+        "type": "boolean",
+        "name": "showInColumnsTable",
+        "default": false,
+        "doc": "Whether or not this asset should be displayed as a column in the schema field table\nin a Dataset's \"Columns\" tab."
+      },
+      {
+        "Searchable": {
+          "/time": {
+            "fieldName": "lastModifiedSettings",
+            "fieldType": "DATETIME"
+          }
+        },
+        "type": [
+          "null",
+          "com.linkedin.pegasus2avro.common.AuditStamp"
+        ],
+        "name": "lastModified",
+        "default": null,
+        "doc": "Last Modified Audit stamp"
+      }
+    ],
+    "doc": "Settings specific to a structured property entity"
+  },
   {
     "type": "record",
     "Aspect": {
@@ -10249,7 +10353,7 @@
                                                                             "doc": "The adjustment algorithm to use when determining the threshold for an assertion."
                                                                           },
                                                                           "name": "algorithm",
-                                                                          "doc": "The algorithm to use to adjust assertion values to power the sensitivity control feature"
+                                                                          "doc": "The algorithm to use to adjust assertion values to power the sensitivity control feature\n\nNote that for algorithm \"STDDEV\" which leverages the standard deviation of trailing values,\nthe \"stdDev\" field must be provided inside of AssertionEvaluationContext.pdl by the offline pipeline."
                                                                         },
                                                                         {
                                                                           "type": "string",
@@ -10335,6 +10439,15 @@
                                 "name": "embeddedAssertions",
                                 "default": null,
                                 "doc": "Currently used for Smart Assertions\nAn embedded copy of the assertion used to evaluate which will overwrite the referenced assertion\nif present and if the EmbeddedAssertion's evaluationTimeWindow period is valid"
+                              },
+                              {
+                                "type": [
+                                  "null",
+                                  "float"
+                                ],
+                                "name": "stdDev",
+                                "default": null,
+                                "doc": "The std deviation of the metric values used for training.\nThis is used to determine the final adjusted threshold for the assertion."
                               }
                             ],
                             "doc": "Additional context about assertion being evaluated."
@@ -11820,6 +11933,132 @@
     ],
     "doc": "Proposals aspect for proposed tags and glossary terms for an entity.\nThese are secondary indices and ActionRequests remain the source of truth."
   },
+  {
+    "type": "record",
+    "Aspect": {
+      "name": "versionProperties"
+    },
+    "name": "VersionProperties",
+    "namespace": "com.linkedin.pegasus2avro.common",
+    "fields": [
+      {
+        "Relationship": {
+          "entityTypes": [
+            "versionSet"
+          ],
+          "name": "VersionOf"
+        },
+        "Searchable": {
+          "queryByDefault": false
+        },
+        "java": {
+          "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+        },
+        "Urn": "Urn",
+        "entityTypes": [
+          "versionSet"
+        ],
+        "type": "string",
+        "name": "versionSet",
+        "doc": "The linked Version Set entity that ties multiple versioned assets together"
+      },
+      {
+        "Searchable": {
+          "/versionTag": {
+            "fieldName": "version",
+            "queryByDefault": false
+          }
+        },
+        "type": {
+          "type": "record",
+          "name": "VersionTag",
+          "namespace": "com.linkedin.pegasus2avro.common",
+          "fields": [
+            {
+              "type": [
+                "null",
+                "string"
+              ],
+              "name": "versionTag",
+              "default": null
+            },
+            {
+              "type": [
+                "null",
+                "com.linkedin.pegasus2avro.common.MetadataAttribution"
+              ],
+              "name": "metadataAttribution",
+              "default": null
+            }
+          ],
+          "doc": "A resource-defined string representing the resource state for the purpose of concurrency control"
+        },
+        "name": "version",
+        "doc": "Label for this versioned asset, is unique within a version set"
+      },
+      {
+        "Searchable": {
+          "/*/versionTag": {
+            "fieldName": "aliases",
+            "queryByDefault": false
+          }
+        },
+        "type": {
+          "type": "array",
+          "items": "com.linkedin.pegasus2avro.common.VersionTag"
+        },
+        "name": "aliases",
+        "default": [],
+        "doc": "Associated aliases for this versioned asset"
+      },
+      {
+        "type": [
+          "null",
+          "string"
+        ],
+        "name": "comment",
+        "default": null,
+        "doc": "Comment documenting what this version was created for, changes, or represents"
+      },
+      {
+        "Searchable": {
+          "fieldName": "versionSortId",
+          "queryByDefault": false
+        },
+        "type": "string",
+        "name": "sortId",
+        "doc": "Sort identifier that determines where a version lives in the order of the Version Set.\nWhat this looks like depends on the Version Scheme. For sort ids generated by DataHub we use an 8 character string representation."
+      },
+      {
+        "type": [
+          "null",
+          "com.linkedin.pegasus2avro.common.AuditStamp"
+        ],
+        "name": "sourceCreatedTimestamp",
+        "default": null,
+        "doc": "Timestamp reflecting when this asset version was created in the source system."
+      },
+      {
+        "type": [
+          "null",
+          "com.linkedin.pegasus2avro.common.AuditStamp"
+        ],
+        "name": "metadataCreatedTimestamp",
+        "default": null,
+        "doc": "Timestamp reflecting when the metadata for this version was created in DataHub"
+      },
+      {
+        "type": [
+          "null",
+          "boolean"
+        ],
+        "name": "isLatest",
+        "default": null,
+        "doc": "Marks whether this version is currently the latest. Set by a side effect and should not be modified by API."
+      }
+    ],
+    "doc": "Properties about a versioned asset i.e. dataset, ML Model, etc."
+  },
   {
     "type": "record",
     "Aspect": {
@@ -13383,6 +13622,18 @@
         "type": "string",
         "name": "actor",
         "doc": "The user URN which will be credited for modifying this deprecation content."
+      },
+      {
+        "java": {
+          "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+        },
+        "Urn": "Urn",
+        "type": [
+          "null",
+          "string"
+        ],
+        "name": "replacement",
+        "default": null
       }
     ],
     "doc": "Deprecation status of an entity"
@@ -14080,6 +14331,9 @@
         "doc": "The display name of the ingestion source"
       },
       {
+        "Searchable": {
+          "fieldType": "TEXT_PARTIAL"
+        },
         "type": "string",
         "name": "type",
         "doc": "The type of the source itself, e.g. mysql, bigquery, bigquery-usage. Should match the recipe."
@@ -14144,6 +14398,9 @@
               "doc": "The PyPI version of the datahub CLI to use when executing a recipe"
             },
             {
+              "Searchable": {
+                "fieldName": "sourceExecutorId"
+              },
               "type": [
                 "null",
                 "string"
@@ -22048,22 +22305,7 @@
                         {
                           "type": [
                             "null",
-                            {
-                              "type": "record",
-                              "name": "VersionTag",
-                              "namespace": "com.linkedin.pegasus2avro.common",
-                              "fields": [
-                                {
-                                  "type": [
-                                    "null",
-                                    "string"
-                                  ],
-                                  "name": "versionTag",
-                                  "default": null
-                                }
-                              ],
-                              "doc": "A resource-defined string representing the resource state for the purpose of concurrency control"
-                            }
+                            "com.linkedin.pegasus2avro.common.VersionTag"
                           ],
                           "name": "version",
                           "default": null,
@@ -26385,6 +26627,55 @@
     ],
     "doc": "A request to send a notification."
   },
+  {
+    "type": "record",
+    "Aspect": {
+      "name": "versionSetProperties"
+    },
+    "name": "VersionSetProperties",
+    "namespace": "com.linkedin.pegasus2avro.versionset",
+    "fields": [
+      {
+        "Searchable": {
+          "/*": {
+            "fieldType": "TEXT",
+            "queryByDefault": true
+          }
+        },
+        "type": {
+          "type": "map",
+          "values": "string"
+        },
+        "name": "customProperties",
+        "default": {},
+        "doc": "Custom property bag."
+      },
+      {
+        "Searchable": {
+          "queryByDefault": "false"
+        },
+        "java": {
+          "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+        },
+        "Urn": "Urn",
+        "type": "string",
+        "name": "latest",
+        "doc": "The latest versioned entity linked to in this version set"
+      },
+      {
+        "type": {
+          "type": "enum",
+          "name": "VersioningScheme",
+          "namespace": "com.linkedin.pegasus2avro.versionset",
+          "symbols": [
+            "ALPHANUMERIC_GENERATED_BY_DATAHUB"
+          ]
+        },
+        "name": "versioningScheme",
+        "doc": "What versioning scheme is being utilized for the versioned entities sort criterion. Static once set"
+      }
+    ]
+  },
   {
     "type": "record",
     "Aspect": {