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

acryl_datahub_cloud/metadata/schemas/ChartUsageStatistics.avsc

@@ -0,0 +1,195 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "chartUsageStatistics",
+    "type": "timeseries"
+  },
+  "name": "ChartUsageStatistics",
+  "namespace": "com.linkedin.pegasus2avro.chart",
+  "fields": [
+    {
+      "type": "long",
+      "name": "timestampMillis",
+      "doc": "The event timestamp field as epoch at UTC in milli seconds."
+    },
+    {
+      "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."
+    },
+    {
+      "TimeseriesField": {},
+      "type": [
+        "null",
+        "int"
+      ],
+      "name": "viewsCount",
+      "default": null,
+      "doc": "The total number of times chart has been viewed"
+    },
+    {
+      "TimeseriesField": {},
+      "type": [
+        "null",
+        "int"
+      ],
+      "name": "uniqueUserCount",
+      "default": null,
+      "doc": "Unique user count"
+    },
+    {
+      "TimeseriesFieldCollection": {
+        "key": "user"
+      },
+      "type": [
+        "null",
+        {
+          "type": "array",
+          "items": {
+            "type": "record",
+            "name": "ChartUserUsageCounts",
+            "namespace": "com.linkedin.pegasus2avro.chart",
+            "fields": [
+              {
+                "java": {
+                  "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+                },
+                "type": "string",
+                "name": "user",
+                "doc": "The unique id of the user.",
+                "Urn": "Urn"
+              },
+              {
+                "TimeseriesField": {},
+                "type": [
+                  "null",
+                  "int"
+                ],
+                "name": "viewsCount",
+                "default": null,
+                "doc": "The number of times the user has viewed the chart"
+              }
+            ],
+            "doc": "Records a single user's usage counts for a given resource"
+          }
+        }
+      ],
+      "name": "userCounts",
+      "default": null,
+      "doc": "Users within this bucket, with frequency counts"
+    }
+  ],
+  "doc": "Experimental (Subject to breaking change) -- Stats corresponding to chart's usage.\n\nIf this aspect represents the latest snapshot of the statistics about a Chart, the eventGranularity field should be null.\nIf this aspect represents a bucketed window of usage statistics (e.g. over a day), then the eventGranularity field should be set accordingly."
+}

acryl_datahub_cloud/metadata/schemas/ConstraintInfo.avsc

@@ -0,0 +1,182 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "constraintInfo"
+  },
+  "name": "ConstraintInfo",
+  "namespace": "com.linkedin.pegasus2avro.constraint",
+  "fields": [
+    {
+      "Searchable": {
+        "fieldType": "KEYWORD"
+      },
+      "type": "string",
+      "name": "displayName",
+      "doc": "Display name of the constraint"
+    },
+    {
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "description",
+      "default": null,
+      "doc": "Description of the Constraint"
+    },
+    {
+      "type": "string",
+      "name": "type",
+      "doc": "The type of constraint"
+    },
+    {
+      "type": [
+        "null",
+        {
+          "type": "record",
+          "name": "DataHubResourceFilter",
+          "namespace": "com.linkedin.pegasus2avro.policy",
+          "fields": [
+            {
+              "deprecated": true,
+              "type": [
+                "null",
+                "string"
+              ],
+              "name": "type",
+              "default": null,
+              "doc": "The type of resource that the policy applies to. This will most often be a data asset entity name, for\nexample 'dataset'. It is not strictly required because in the future we will want to support filtering a resource\nby domain, as well."
+            },
+            {
+              "deprecated": true,
+              "type": [
+                "null",
+                {
+                  "type": "array",
+                  "items": "string"
+                }
+              ],
+              "name": "resources",
+              "default": null,
+              "doc": "A specific set of resources to apply the policy to, e.g. asset urns"
+            },
+            {
+              "deprecated": true,
+              "type": "boolean",
+              "name": "allResources",
+              "default": false,
+              "doc": "Whether the policy should be applied to all assets matching the filter."
+            },
+            {
+              "type": [
+                "null",
+                {
+                  "type": "record",
+                  "name": "PolicyMatchFilter",
+                  "namespace": "com.linkedin.pegasus2avro.policy",
+                  "fields": [
+                    {
+                      "type": {
+                        "type": "array",
+                        "items": {
+                          "type": "record",
+                          "name": "PolicyMatchCriterion",
+                          "namespace": "com.linkedin.pegasus2avro.policy",
+                          "fields": [
+                            {
+                              "type": "string",
+                              "name": "field",
+                              "doc": "The name of the field that the criterion refers to"
+                            },
+                            {
+                              "type": {
+                                "type": "array",
+                                "items": "string"
+                              },
+                              "name": "values",
+                              "doc": "Values. Matches criterion if any one of the values matches condition (OR-relationship)"
+                            },
+                            {
+                              "type": {
+                                "type": "enum",
+                                "symbolDocs": {
+                                  "EQUALS": "Whether the field matches the value",
+                                  "STARTS_WITH": "Whether the field value starts with the value"
+                                },
+                                "name": "PolicyMatchCondition",
+                                "namespace": "com.linkedin.pegasus2avro.policy",
+                                "symbols": [
+                                  "EQUALS",
+                                  "STARTS_WITH"
+                                ],
+                                "doc": "The matching condition in a filter criterion"
+                              },
+                              "name": "condition",
+                              "default": "EQUALS",
+                              "doc": "The condition for the criterion"
+                            }
+                          ],
+                          "doc": "A criterion for matching a field with given value"
+                        }
+                      },
+                      "name": "criteria",
+                      "doc": "A list of criteria to apply conjunctively (so all criteria must pass)"
+                    }
+                  ],
+                  "doc": "The filter for specifying the resource or actor to apply privileges to"
+                }
+              ],
+              "name": "filter",
+              "default": null,
+              "doc": "Filter to apply privileges to"
+            }
+          ],
+          "doc": "Information used to filter DataHub resource."
+        }
+      ],
+      "name": "resources",
+      "default": null,
+      "doc": "The resource that the policy applies to. Not required for some 'Platform' privileges."
+    },
+    {
+      "type": [
+        "null",
+        {
+          "type": "record",
+          "name": "ConstraintParams",
+          "namespace": "com.linkedin.pegasus2avro.constraint",
+          "fields": [
+            {
+              "type": [
+                "null",
+                {
+                  "type": "record",
+                  "name": "GlossaryTermInNodeConstraint",
+                  "namespace": "com.linkedin.pegasus2avro.constraint",
+                  "fields": [
+                    {
+                      "java": {
+                        "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+                      },
+                      "type": "string",
+                      "name": "glossaryNode",
+                      "doc": "The glossary node which the constrained entities must have attached to them",
+                      "Urn": "Urn"
+                    }
+                  ]
+                }
+              ],
+              "name": "hasGlossaryTermInNodeParams",
+              "default": null,
+              "doc": "An optional set of information specific to glossary node constraints."
+            }
+          ],
+          "doc": "Params provided for a specific instance of a constraint."
+        }
+      ],
+      "name": "params",
+      "default": null,
+      "doc": "Parameters specific for a particular Constraint type"
+    }
+  ],
+  "doc": "Information about a constraint."
+}

acryl_datahub_cloud/metadata/schemas/ConstraintKey.avsc

@@ -0,0 +1,20 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "constraintKey",
+    "keyForEntity": "constraint",
+    "entityCategory": "_unset_",
+    "entityAspects": [
+      "constraintInfo"
+    ]
+  },
+  "name": "ConstraintKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "type": "string",
+      "name": "id"
+    }
+  ],
+  "doc": "Key for a Constraint"
+}

acryl_datahub_cloud/metadata/schemas/Container.avsc

@@ -0,0 +1,36 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "container"
+  },
+  "name": "Container",
+  "namespace": "com.linkedin.pegasus2avro.container",
+  "fields": [
+    {
+      "Relationship": {
+        "entityTypes": [
+          "container"
+        ],
+        "name": "IsPartOf"
+      },
+      "Searchable": {
+        "addToFilters": true,
+        "fieldName": "container",
+        "fieldType": "URN",
+        "filterNameOverride": "Container",
+        "hasValuesFieldName": "hasContainer"
+      },
+      "java": {
+        "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+      },
+      "type": "string",
+      "name": "container",
+      "doc": "The parent container of an asset",
+      "Urn": "Urn",
+      "entityTypes": [
+        "container"
+      ]
+    }
+  ],
+  "doc": "Link from an asset to its parent container"
+}

acryl_datahub_cloud/metadata/schemas/ContainerKey.avsc

@@ -0,0 +1,47 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "containerKey",
+    "keyForEntity": "container",
+    "entityCategory": "core",
+    "entityAspects": [
+      "containerProperties",
+      "editableContainerProperties",
+      "dataPlatformInstance",
+      "subTypes",
+      "ownership",
+      "deprecation",
+      "container",
+      "globalTags",
+      "glossaryTerms",
+      "institutionalMemory",
+      "browsePaths",
+      "status",
+      "domains",
+      "proposals",
+      "browsePathsV2",
+      "structuredProperties",
+      "forms",
+      "testResults",
+      "access",
+      "share",
+      "origin",
+      "documentation"
+    ],
+    "entityDoc": "A container of related data assets."
+  },
+  "name": "ContainerKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "guid",
+      "default": null,
+      "doc": "Unique guid for container"
+    }
+  ],
+  "doc": "Key for an Asset Container"
+}

acryl_datahub_cloud/metadata/schemas/ContainerProperties.avsc

@@ -0,0 +1,189 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "containerProperties"
+  },
+  "name": "ContainerProperties",
+  "namespace": "com.linkedin.pegasus2avro.container",
+  "fields": [
+    {
+      "Searchable": {
+        "/*": {
+          "fieldType": "TEXT",
+          "queryByDefault": true
+        }
+      },
+      "type": {
+        "type": "map",
+        "values": "string"
+      },
+      "name": "customProperties",
+      "default": {},
+      "doc": "Custom property bag."
+    },
+    {
+      "Searchable": {
+        "fieldType": "KEYWORD"
+      },
+      "java": {
+        "class": "com.linkedin.pegasus2avro.common.url.Url",
+        "coercerClass": "com.linkedin.pegasus2avro.common.url.UrlCoercer"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "externalUrl",
+      "default": null,
+      "doc": "URL where the reference exist"
+    },
+    {
+      "Searchable": {
+        "boostScore": 10.0,
+        "enableAutocomplete": true,
+        "fieldNameAliases": [
+          "_entityName"
+        ],
+        "fieldType": "WORD_GRAM"
+      },
+      "type": "string",
+      "name": "name",
+      "doc": "Display name of the Asset Container"
+    },
+    {
+      "Searchable": {
+        "boostScore": 10.0,
+        "enableAutocomplete": true,
+        "fieldType": "WORD_GRAM"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "qualifiedName",
+      "default": null,
+      "doc": "Fully-qualified name of the Container"
+    },
+    {
+      "Searchable": {
+        "fieldType": "TEXT",
+        "hasValuesFieldName": "hasDescription"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "description",
+      "default": null,
+      "doc": "Description of the Asset Container as it exists inside a source system"
+    },
+    {
+      "Searchable": {
+        "addToFilters": true,
+        "fieldType": "KEYWORD",
+        "filterNameOverride": "Environment",
+        "queryByDefault": false
+      },
+      "type": [
+        "null",
+        {
+          "type": "enum",
+          "symbolDocs": {
+            "CORP": "Designates corporation fabrics",
+            "DEV": "Designates development fabrics",
+            "EI": "Designates early-integration fabrics",
+            "NON_PROD": "Designates non-production fabrics",
+            "PRD": "Alternative Prod spelling",
+            "PRE": "Designates pre-production fabrics",
+            "PROD": "Designates production fabrics",
+            "QA": "Designates quality assurance fabrics",
+            "RVW": "Designates review fabrics",
+            "SANDBOX": "Designates sandbox fabrics",
+            "STG": "Designates staging fabrics",
+            "TEST": "Designates testing fabrics",
+            "TST": "Alternative Test spelling",
+            "UAT": "Designates user acceptance testing fabrics"
+          },
+          "name": "FabricType",
+          "namespace": "com.linkedin.pegasus2avro.common",
+          "symbols": [
+            "DEV",
+            "TEST",
+            "QA",
+            "UAT",
+            "EI",
+            "PRE",
+            "STG",
+            "NON_PROD",
+            "PROD",
+            "CORP",
+            "RVW",
+            "PRD",
+            "TST",
+            "SANDBOX"
+          ],
+          "doc": "Fabric group type"
+        }
+      ],
+      "name": "env",
+      "default": null,
+      "doc": "Environment for this flow"
+    },
+    {
+      "Searchable": {
+        "/time": {
+          "fieldName": "createdAt",
+          "fieldType": "DATETIME"
+        }
+      },
+      "type": [
+        "null",
+        {
+          "type": "record",
+          "name": "TimeStamp",
+          "namespace": "com.linkedin.pegasus2avro.common",
+          "fields": [
+            {
+              "type": "long",
+              "name": "time",
+              "doc": "When did the event occur"
+            },
+            {
+              "java": {
+                "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+              },
+              "type": [
+                "null",
+                "string"
+              ],
+              "name": "actor",
+              "default": null,
+              "doc": "Optional: The actor urn involved in the event.",
+              "Urn": "Urn"
+            }
+          ],
+          "doc": "A standard event timestamp"
+        }
+      ],
+      "name": "created",
+      "default": null,
+      "doc": "A timestamp documenting when the asset was created in the source Data Platform (not on DataHub)"
+    },
+    {
+      "Searchable": {
+        "/time": {
+          "fieldName": "lastModifiedAt",
+          "fieldType": "DATETIME"
+        }
+      },
+      "type": [
+        "null",
+        "com.linkedin.pegasus2avro.common.TimeStamp"
+      ],
+      "name": "lastModified",
+      "default": null,
+      "doc": "A timestamp documenting when the asset was last modified in the source Data Platform (not on DataHub)"
+    }
+  ],
+  "doc": "Information about a Asset Container as received from a 3rd party source system"
+}