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

acryl_datahub_cloud/metadata/schemas/SchemaProposals.avsc

@@ -0,0 +1,73 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "schemaProposals"
+  },
+  "name": "SchemaProposals",
+  "namespace": "com.linkedin.pegasus2avro.schema",
+  "fields": [
+    {
+      "type": {
+        "type": "array",
+        "items": {
+          "type": "record",
+          "name": "SchemaProposal",
+          "namespace": "com.linkedin.pegasus2avro.schema",
+          "fields": [
+            {
+              "type": "string",
+              "name": "fieldPath",
+              "doc": "FieldPath uniquely identifying the SchemaField this metadata is associated with"
+            },
+            {
+              "Searchable": {
+                "/*": {
+                  "fieldName": "proposedSchemaTags",
+                  "fieldType": "URN",
+                  "filterNameOverride": "Proposed Schema Tag"
+                }
+              },
+              "type": [
+                "null",
+                {
+                  "type": "array",
+                  "items": "string"
+                }
+              ],
+              "name": "proposedSchemaTags",
+              "default": null,
+              "doc": "Proposed tags for a given entity",
+              "Urn": "Urn",
+              "urn_is_array": true
+            },
+            {
+              "Searchable": {
+                "/*": {
+                  "fieldName": "proposedSchemaGlossaryTerms",
+                  "fieldType": "URN",
+                  "filterNameOverride": "Proposed Schema Glossary Term"
+                }
+              },
+              "type": [
+                "null",
+                {
+                  "type": "array",
+                  "items": "string"
+                }
+              ],
+              "name": "proposedSchemaGlossaryTerms",
+              "default": null,
+              "doc": "Proposed glossary terms for a given entity",
+              "Urn": "Urn",
+              "urn_is_array": true
+            }
+          ],
+          "doc": "Schema proposal aspect for proposed schema tags and proposed schema glossary terms\nThese are secondary indices and ActionRequests remain the source of truth."
+        }
+      },
+      "name": "schemaProposals",
+      "doc": "Array of SchemaProposal"
+    }
+  ],
+  "doc": "Schema proposals aspect for proposed tags and glossary terms on schema metadata."
+}

acryl_datahub_cloud/metadata/schemas/Share.avsc

@@ -0,0 +1,211 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "share"
+  },
+  "name": "Share",
+  "namespace": "com.linkedin.pegasus2avro.common",
+  "fields": [
+    {
+      "Searchable": {
+        "/*/destination": {
+          "fieldName": "shareDestinations",
+          "fieldType": "URN",
+          "hasValuesFieldName": "hasShareDestinations",
+          "queryByDefault": false
+        }
+      },
+      "type": {
+        "type": "array",
+        "items": {
+          "type": "record",
+          "name": "ShareResult",
+          "namespace": "com.linkedin.pegasus2avro.common",
+          "fields": [
+            {
+              "java": {
+                "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+              },
+              "type": "string",
+              "name": "destination",
+              "doc": "Urn of the DataHubConnection related to another Acryl instance",
+              "Urn": "Urn"
+            },
+            {
+              "java": {
+                "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+              },
+              "type": [
+                "null",
+                "string"
+              ],
+              "name": "implicitShareEntity",
+              "default": null,
+              "doc": "If this share happened implicitly due to another entity being shared, this field\nwill be populated with that entity urn. Example: if a dataset is shared, its containers\nwill also be shared. The share result for the container will have the dataset urn here.",
+              "Urn": "Urn"
+            },
+            {
+              "type": {
+                "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": "created",
+              "doc": "Audit stamp for when the first share request for the given destination occurred."
+            },
+            {
+              "type": "com.linkedin.pegasus2avro.common.AuditStamp",
+              "name": "lastAttempt",
+              "doc": "When did we get this share result and who requested the share. This will be the time\nthat we try and execute the share on the backend, regardless of success."
+            },
+            {
+              "type": [
+                "null",
+                "string"
+              ],
+              "name": "lastAttemptRequestId",
+              "default": null,
+              "doc": "The request id that generated this share result. This is the id of the request that triggered this share.\nThis is primarily used for debugging purposes."
+            },
+            {
+              "type": [
+                "null",
+                {
+                  "type": "record",
+                  "name": "ShareConfig",
+                  "namespace": "com.linkedin.pegasus2avro.common",
+                  "fields": [
+                    {
+                      "type": [
+                        "null",
+                        "boolean"
+                      ],
+                      "name": "enableUpstreamLineage",
+                      "default": null,
+                      "doc": "Upstream lineage was shared"
+                    },
+                    {
+                      "type": [
+                        "null",
+                        "boolean"
+                      ],
+                      "name": "enableDownstreamLineage",
+                      "default": null,
+                      "doc": "Downstream lineage was shared"
+                    }
+                  ]
+                }
+              ],
+              "name": "shareConfig",
+              "default": null,
+              "doc": "The config for this particular share result"
+            },
+            {
+              "type": [
+                "null",
+                "com.linkedin.pegasus2avro.common.AuditStamp"
+              ],
+              "name": "lastSuccess",
+              "default": null,
+              "doc": "Audit stamp for the last time a share to this above destination successfully occurred"
+            },
+            {
+              "type": {
+                "type": "enum",
+                "symbolDocs": {
+                  "FAILURE": "The share was a failure",
+                  "PARTIAL_SUCCESS": "The share was partially successful. Some, but not all, aspects were shared.",
+                  "RUNNING": "The share request is still in progress",
+                  "SUCCESS": "The share was successful"
+                },
+                "name": "ShareResultState",
+                "namespace": "com.linkedin.pegasus2avro.common",
+                "symbols": [
+                  "RUNNING",
+                  "SUCCESS",
+                  "PARTIAL_SUCCESS",
+                  "FAILURE"
+                ]
+              },
+              "name": "status",
+              "doc": "Status for this share result - whether or not it succeeded"
+            },
+            {
+              "type": [
+                "null",
+                "long"
+              ],
+              "name": "statusLastUpdated",
+              "default": null,
+              "doc": "The last time the status was updated. Timestamp in milliseconds since epoch.\nUseful for monitoring if the status is stale."
+            },
+            {
+              "type": [
+                "null",
+                "string"
+              ],
+              "name": "message",
+              "default": null,
+              "doc": "Optional message for this share result. Error messages will be stored here.\nThis message will be presented to the end user, so it should not include stack traces etc."
+            }
+          ],
+          "doc": "Info about the results from sharing metadata for a given entity"
+        }
+      },
+      "name": "lastShareResults",
+      "doc": "The last share result for each destination that this entity has been shared with"
+    },
+    {
+      "type": [
+        "null",
+        {
+          "type": "array",
+          "items": "com.linkedin.pegasus2avro.common.ShareResult"
+        }
+      ],
+      "name": "lastUnshareResults",
+      "default": null,
+      "doc": "The last unshare result for each destination that this entity was\npreviously shared with. A successfully unshared destination should not\nappear in the lastShareResults field."
+    }
+  ],
+  "doc": "Aspect used for keeping track of metadata sharing info"
+}

acryl_datahub_cloud/metadata/schemas/Siblings.avsc

@@ -0,0 +1,41 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "siblings"
+  },
+  "name": "Siblings",
+  "namespace": "com.linkedin.pegasus2avro.common",
+  "fields": [
+    {
+      "Relationship": {
+        "/*": {
+          "entityTypes": [
+            "dataset"
+          ],
+          "name": "SiblingOf"
+        }
+      },
+      "Searchable": {
+        "/*": {
+          "fieldName": "siblings",
+          "fieldType": "URN",
+          "queryByDefault": false
+        }
+      },
+      "type": {
+        "type": "array",
+        "items": "string"
+      },
+      "name": "siblings",
+      "doc": "List of sibling entities",
+      "Urn": "Urn",
+      "urn_is_array": true
+    },
+    {
+      "type": "boolean",
+      "name": "primary",
+      "doc": "If this is the leader entity of the set of siblings"
+    }
+  ],
+  "doc": "Siblings information of an entity."
+}

acryl_datahub_cloud/metadata/schemas/SlackUserInfo.avsc

@@ -0,0 +1,160 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "slackUserInfo"
+  },
+  "name": "SlackUserInfo",
+  "namespace": "com.linkedin.pegasus2avro.dataplatform.slack",
+  "fields": [
+    {
+      "Relationship": {
+        "entityTypes": [
+          "dataPlatformInstance"
+        ],
+        "name": "PartOfSlackWorkspace"
+      },
+      "java": {
+        "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+      },
+      "type": "string",
+      "name": "slackInstance",
+      "doc": "The dataplatform instance that this Slack member belongs to.",
+      "Urn": "Urn",
+      "entityTypes": [
+        "dataPlatformInstance"
+      ]
+    },
+    {
+      "type": "string",
+      "name": "id",
+      "doc": "The unique identifier for the Slack member."
+    },
+    {
+      "type": "string",
+      "name": "name",
+      "doc": "The username of the Slack member."
+    },
+    {
+      "type": "string",
+      "name": "realName",
+      "doc": "The real name of the Slack member."
+    },
+    {
+      "type": "string",
+      "name": "displayName",
+      "doc": "The display name of the Slack member."
+    },
+    {
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "email",
+      "default": null,
+      "doc": "The email associated with the Slack member."
+    },
+    {
+      "type": "string",
+      "name": "teamId",
+      "doc": "The ID associated with the Slack team."
+    },
+    {
+      "type": "boolean",
+      "name": "isDeleted",
+      "doc": "Whether the member is deleted or not."
+    },
+    {
+      "type": "boolean",
+      "name": "isAdmin",
+      "doc": "Whether the member is an admin."
+    },
+    {
+      "type": "boolean",
+      "name": "isOwner",
+      "doc": "Whether the member is an owner."
+    },
+    {
+      "type": "boolean",
+      "name": "isPrimaryOwner",
+      "doc": "Whether the member is a primary owner."
+    },
+    {
+      "type": "boolean",
+      "name": "isBot",
+      "doc": "Whether the member is a bot."
+    },
+    {
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "timezone",
+      "default": null,
+      "doc": "The timezone of the Slack member."
+    },
+    {
+      "type": [
+        "null",
+        "int"
+      ],
+      "name": "timezoneOffset",
+      "default": null,
+      "doc": "The timezone offset of the Slack member."
+    },
+    {
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "title",
+      "default": null,
+      "doc": "The title of the Slack member."
+    },
+    {
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "phone",
+      "default": null,
+      "doc": "The phone number of the Slack member."
+    },
+    {
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "profilePictureUrl",
+      "default": null,
+      "doc": "The URL of the member's profile picture."
+    },
+    {
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "statusText",
+      "default": null,
+      "doc": "The status text of the Slack member."
+    },
+    {
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "statusEmoji",
+      "default": null,
+      "doc": "The status emoji of the Slack member."
+    },
+    {
+      "type": [
+        "null",
+        "long"
+      ],
+      "name": "lastUpdatedSeconds",
+      "default": null,
+      "doc": "The timestamp of when the member was last updated. (in seconds)"
+    }
+  ],
+  "doc": "Information about a Slack user."
+}

acryl_datahub_cloud/metadata/schemas/SourceCode.avsc

@@ -0,0 +1,49 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "sourceCode"
+  },
+  "name": "SourceCode",
+  "namespace": "com.linkedin.pegasus2avro.ml.metadata",
+  "fields": [
+    {
+      "type": {
+        "type": "array",
+        "items": {
+          "type": "record",
+          "name": "SourceCodeUrl",
+          "namespace": "com.linkedin.pegasus2avro.ml.metadata",
+          "fields": [
+            {
+              "type": {
+                "type": "enum",
+                "name": "SourceCodeUrlType",
+                "namespace": "com.linkedin.pegasus2avro.ml.metadata",
+                "symbols": [
+                  "ML_MODEL_SOURCE_CODE",
+                  "TRAINING_PIPELINE_SOURCE_CODE",
+                  "EVALUATION_PIPELINE_SOURCE_CODE"
+                ]
+              },
+              "name": "type",
+              "doc": "Source Code Url Types"
+            },
+            {
+              "java": {
+                "class": "com.linkedin.pegasus2avro.common.url.Url",
+                "coercerClass": "com.linkedin.pegasus2avro.common.url.UrlCoercer"
+              },
+              "type": "string",
+              "name": "sourceCodeUrl",
+              "doc": "Source Code Url"
+            }
+          ],
+          "doc": "Source Code Url Entity"
+        }
+      },
+      "name": "sourceCode",
+      "doc": "Source Code along with types"
+    }
+  ],
+  "doc": "Source Code"
+}

acryl_datahub_cloud/metadata/schemas/Status.avsc

@@ -0,0 +1,20 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "status"
+  },
+  "name": "Status",
+  "namespace": "com.linkedin.pegasus2avro.common",
+  "fields": [
+    {
+      "Searchable": {
+        "fieldType": "BOOLEAN"
+      },
+      "type": "boolean",
+      "name": "removed",
+      "default": false,
+      "doc": "Whether the entity has been removed (soft-deleted)."
+    }
+  ],
+  "doc": "The lifecycle status metadata of an entity, e.g. dataset, metric, feature, etc.\nThis aspect is used to represent soft deletes conventionally."
+}

acryl_datahub_cloud/metadata/schemas/StorageFeatures.avsc

@@ -0,0 +1,76 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "storageFeatures"
+  },
+  "name": "StorageFeatures",
+  "namespace": "com.linkedin.pegasus2avro.metadata.search.features",
+  "fields": [
+    {
+      "Searchable": {
+        "fieldName": "sizeInBytesFeature",
+        "fieldType": "COUNT"
+      },
+      "type": [
+        "null",
+        "long"
+      ],
+      "name": "sizeInBytes",
+      "default": null,
+      "doc": "The total size in bytes."
+    },
+    {
+      "type": [
+        "null",
+        "long"
+      ],
+      "name": "sizeInBytesPercentile",
+      "default": null,
+      "doc": "The percentile of size in bytes relative to other assets from the data plaform instance."
+    },
+    {
+      "type": [
+        "null",
+        "long"
+      ],
+      "name": "sizeInBytesRank",
+      "default": null,
+      "doc": "The absolute rank of size in bytes relative to other assets from the data plaform instance."
+    },
+    {
+      "Searchable": {
+        "fieldName": "rowCountFeature",
+        "fieldType": "COUNT"
+      },
+      "type": [
+        "null",
+        "long"
+      ],
+      "name": "rowCount",
+      "default": null,
+      "doc": "The total row count."
+    },
+    {
+      "Searchable": {
+        "fieldName": "rowCountPercentile",
+        "fieldType": "COUNT"
+      },
+      "type": [
+        "null",
+        "int"
+      ],
+      "name": "rowCountPercentile",
+      "default": null,
+      "doc": "The percentile of the total row / document count relative to other assets from the data platform instance."
+    },
+    {
+      "type": [
+        "null",
+        "int"
+      ],
+      "name": "rowCountRank",
+      "default": null,
+      "doc": "The absolute rank of size in bytes relative to other assets from the data plaform instance."
+    }
+  ]
+}