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

acryl_datahub_cloud/metadata/schemas/CorpGroupEditableInfo.avsc

@@ -0,0 +1,52 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "corpGroupEditableInfo"
+  },
+  "name": "CorpGroupEditableInfo",
+  "namespace": "com.linkedin.pegasus2avro.identity",
+  "fields": [
+    {
+      "Searchable": {
+        "fieldName": "editedDescription",
+        "fieldType": "TEXT"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "description",
+      "default": null,
+      "doc": "A description of the group"
+    },
+    {
+      "java": {
+        "class": "com.linkedin.pegasus2avro.common.url.Url",
+        "coercerClass": "com.linkedin.pegasus2avro.common.url.UrlCoercer"
+      },
+      "type": "string",
+      "name": "pictureLink",
+      "default": "https://raw.githubusercontent.com/datahub-project/datahub/master/datahub-web-react/src/images/default_avatar.png",
+      "doc": "A URL which points to a picture which user wants to set as the photo for the group"
+    },
+    {
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "slack",
+      "default": null,
+      "doc": "Slack channel for the group"
+    },
+    {
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "email",
+      "default": null,
+      "doc": "Email address to contact the group"
+    }
+  ],
+  "doc": "Group information that can be edited from UI"
+}

acryl_datahub_cloud/metadata/schemas/CorpGroupInfo.avsc

@@ -0,0 +1,177 @@
+{
+  "type": "record",
+  "Aspect": {
+    "EntityUrns": [
+      "com.linkedin.pegasus2avro.common.CorpGroupUrn"
+    ],
+    "name": "corpGroupInfo"
+  },
+  "name": "CorpGroupInfo",
+  "namespace": "com.linkedin.pegasus2avro.identity",
+  "fields": [
+    {
+      "Searchable": {
+        "boostScore": 10.0,
+        "enableAutocomplete": true,
+        "fieldNameAliases": [
+          "_entityName"
+        ],
+        "fieldType": "TEXT_PARTIAL",
+        "queryByDefault": true
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "displayName",
+      "default": null,
+      "doc": "The name of the group."
+    },
+    {
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "email",
+      "default": null,
+      "doc": "email of this group"
+    },
+    {
+      "Relationship": {
+        "/*": {
+          "entityTypes": [
+            "corpuser"
+          ],
+          "name": "OwnedBy"
+        }
+      },
+      "deprecated": true,
+      "type": {
+        "type": "array",
+        "items": "string"
+      },
+      "name": "admins",
+      "doc": "owners of this group\nDeprecated! Replaced by Ownership aspect.",
+      "Urn": "CorpuserUrn",
+      "urn_is_array": true
+    },
+    {
+      "Relationship": {
+        "/*": {
+          "entityTypes": [
+            "corpuser"
+          ],
+          "name": "IsPartOf"
+        }
+      },
+      "deprecated": true,
+      "type": {
+        "type": "array",
+        "items": "string"
+      },
+      "name": "members",
+      "doc": "List of ldap urn in this group.\nDeprecated! Replaced by GroupMembership aspect.",
+      "Urn": "CorpuserUrn",
+      "urn_is_array": true
+    },
+    {
+      "Relationship": {
+        "/*": {
+          "entityTypes": [
+            "corpGroup"
+          ],
+          "name": "IsPartOf"
+        }
+      },
+      "deprecated": true,
+      "type": {
+        "type": "array",
+        "items": "string"
+      },
+      "name": "groups",
+      "doc": "List of groups in this group.\nDeprecated! This field is unused.",
+      "Urn": "CorpGroupUrn",
+      "urn_is_array": true
+    },
+    {
+      "Searchable": {
+        "fieldType": "TEXT_PARTIAL"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "description",
+      "default": null,
+      "doc": "A description of the group."
+    },
+    {
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "slack",
+      "default": null,
+      "doc": "Slack channel for the group"
+    },
+    {
+      "Searchable": {
+        "/time": {
+          "fieldName": "createdTime",
+          "fieldType": "DATETIME"
+        }
+      },
+      "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": "created",
+      "default": null,
+      "doc": "Created Audit stamp"
+    }
+  ],
+  "doc": "Information about a Corp Group ingested from a third party source"
+}

acryl_datahub_cloud/metadata/schemas/CorpGroupKey.avsc

@@ -0,0 +1,39 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "corpGroupKey",
+    "keyForEntity": "corpGroup",
+    "entityCategory": "_unset_",
+    "entityAspects": [
+      "corpGroupInfo",
+      "corpGroupEditableInfo",
+      "globalTags",
+      "ownership",
+      "status",
+      "origin",
+      "corpGroupSettings",
+      "roleMembership",
+      "structuredProperties",
+      "forms",
+      "testResults",
+      "share"
+    ],
+    "entityDoc": "CorpGroup represents an identity of a group of users in the enterprise."
+  },
+  "name": "CorpGroupKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "Searchable": {
+        "boostScore": 10.0,
+        "enableAutocomplete": true,
+        "fieldType": "WORD_GRAM",
+        "queryByDefault": true
+      },
+      "type": "string",
+      "name": "name",
+      "doc": "The URL-encoded name of the AD/LDAP group. Serves as a globally unique identifier within DataHub."
+    }
+  ],
+  "doc": "Key for a CorpGroup"
+}

acryl_datahub_cloud/metadata/schemas/CorpGroupSettings.avsc

@@ -0,0 +1,106 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "corpGroupSettings"
+  },
+  "name": "CorpGroupSettings",
+  "namespace": "com.linkedin.pegasus2avro.identity",
+  "fields": [
+    {
+      "type": [
+        "null",
+        {
+          "type": "record",
+          "name": "NotificationSettings",
+          "namespace": "com.linkedin.pegasus2avro.event.notification.settings",
+          "fields": [
+            {
+              "type": {
+                "type": "array",
+                "items": {
+                  "type": "enum",
+                  "symbolDocs": {
+                    "EMAIL": "Email target type.",
+                    "SLACK": "Slack target type."
+                  },
+                  "name": "NotificationSinkType",
+                  "namespace": "com.linkedin.pegasus2avro.event.notification",
+                  "symbols": [
+                    "SLACK",
+                    "EMAIL"
+                  ],
+                  "doc": "A type of sink / platform to send a notification to."
+                }
+              },
+              "name": "sinkTypes",
+              "doc": "Sink types that notifications are sent to."
+            },
+            {
+              "type": [
+                "null",
+                {
+                  "type": "record",
+                  "name": "SlackNotificationSettings",
+                  "namespace": "com.linkedin.pegasus2avro.event.notification.settings",
+                  "fields": [
+                    {
+                      "type": [
+                        "null",
+                        "string"
+                      ],
+                      "name": "userHandle",
+                      "default": null,
+                      "doc": "Optional user handle"
+                    },
+                    {
+                      "type": [
+                        "null",
+                        {
+                          "type": "array",
+                          "items": "string"
+                        }
+                      ],
+                      "name": "channels",
+                      "default": null,
+                      "doc": "Optional list of channels to send notifications to"
+                    }
+                  ],
+                  "doc": "Slack Notification settings for an actor."
+                }
+              ],
+              "name": "slackSettings",
+              "default": null,
+              "doc": "Slack Notification Settings"
+            },
+            {
+              "type": [
+                "null",
+                {
+                  "type": "record",
+                  "name": "EmailNotificationSettings",
+                  "namespace": "com.linkedin.pegasus2avro.event.notification.settings",
+                  "fields": [
+                    {
+                      "type": "string",
+                      "name": "email",
+                      "doc": "Optional user or group email address"
+                    }
+                  ],
+                  "doc": "Email Notification settings for an actor."
+                }
+              ],
+              "name": "emailSettings",
+              "default": null,
+              "doc": "Email Notification Settings"
+            }
+          ],
+          "doc": "Notification settings for an actor or subscription."
+        }
+      ],
+      "name": "notificationSettings",
+      "default": null,
+      "doc": "Notification settings for a group"
+    }
+  ],
+  "doc": "Settings that a group can customize through the DataHub UI"
+}

acryl_datahub_cloud/metadata/schemas/CorpUserCredentials.avsc

@@ -0,0 +1,42 @@
+{
+  "type": "record",
+  "Aspect": {
+    "EntityUrns": [
+      "com.linkedin.pegasus2avro.common.CorpuserUrn"
+    ],
+    "name": "corpUserCredentials"
+  },
+  "name": "CorpUserCredentials",
+  "namespace": "com.linkedin.pegasus2avro.identity",
+  "fields": [
+    {
+      "type": "string",
+      "name": "salt",
+      "doc": "Salt used to hash password"
+    },
+    {
+      "type": "string",
+      "name": "hashedPassword",
+      "doc": "Hashed password generated by concatenating salt and password, then hashing"
+    },
+    {
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "passwordResetToken",
+      "default": null,
+      "doc": "Optional token needed to reset a user's password. Can only be set by the admin."
+    },
+    {
+      "type": [
+        "null",
+        "long"
+      ],
+      "name": "passwordResetTokenExpirationTimeMillis",
+      "default": null,
+      "doc": "When the password reset token expires."
+    }
+  ],
+  "doc": "Corp user credentials"
+}

acryl_datahub_cloud/metadata/schemas/CorpUserEditableInfo.avsc

@@ -0,0 +1,169 @@
+{
+  "type": "record",
+  "Aspect": {
+    "EntityUrns": [
+      "com.linkedin.pegasus2avro.common.CorpuserUrn"
+    ],
+    "name": "corpUserEditableInfo"
+  },
+  "name": "CorpUserEditableInfo",
+  "namespace": "com.linkedin.pegasus2avro.identity",
+  "fields": [
+    {
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "aboutMe",
+      "default": null,
+      "doc": "About me section of the user"
+    },
+    {
+      "Searchable": {
+        "/*": {
+          "fieldType": "TEXT"
+        }
+      },
+      "type": {
+        "type": "array",
+        "items": "string"
+      },
+      "name": "teams",
+      "default": [],
+      "doc": "Teams that the user belongs to e.g. Metadata"
+    },
+    {
+      "Searchable": {
+        "/*": {
+          "fieldType": "TEXT"
+        }
+      },
+      "type": {
+        "type": "array",
+        "items": "string"
+      },
+      "name": "skills",
+      "default": [],
+      "doc": "Skills that the user possesses e.g. Machine Learning"
+    },
+    {
+      "java": {
+        "class": "com.linkedin.pegasus2avro.common.url.Url",
+        "coercerClass": "com.linkedin.pegasus2avro.common.url.UrlCoercer"
+      },
+      "type": "string",
+      "name": "pictureLink",
+      "default": "https://raw.githubusercontent.com/datahub-project/datahub/master/datahub-web-react/src/images/default_avatar.png",
+      "doc": "A URL which points to a picture which user wants to set as a profile photo"
+    },
+    {
+      "Searchable": {
+        "boostScore": 10.0,
+        "fieldType": "WORD_GRAM",
+        "queryByDefault": true
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "displayName",
+      "default": null,
+      "doc": "DataHub-native display name"
+    },
+    {
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "title",
+      "default": null,
+      "doc": "DataHub-native Title, e.g. 'Software Engineer'"
+    },
+    {
+      "Relationship": {
+        "/*": {
+          "entityTypes": [
+            "dataPlatform"
+          ],
+          "name": "IsUserOf"
+        }
+      },
+      "type": [
+        "null",
+        {
+          "type": "array",
+          "items": "string"
+        }
+      ],
+      "name": "platforms",
+      "default": null,
+      "doc": "The platforms that the user commonly works with",
+      "Urn": "Urn",
+      "urn_is_array": true
+    },
+    {
+      "Relationship": {
+        "entityTypes": [
+          "dataHubPersona"
+        ],
+        "name": "IsPersona"
+      },
+      "java": {
+        "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "persona",
+      "default": null,
+      "doc": "The user's persona type, based on their role",
+      "Urn": "Urn",
+      "entityTypes": [
+        "dataHubPersona"
+      ]
+    },
+    {
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "slack",
+      "default": null,
+      "doc": "Slack handle for the user"
+    },
+    {
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "phone",
+      "default": null,
+      "doc": "Phone number to contact the user"
+    },
+    {
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "email",
+      "default": null,
+      "doc": "Email address to contact the user"
+    },
+    {
+      "type": [
+        "null",
+        {
+          "type": "array",
+          "items": "string"
+        }
+      ],
+      "name": "informationSources",
+      "default": null,
+      "doc": "Information sources that have been used to populate this CorpUserEditableInfo.\nThese include platform resources, such as Slack members or Looker users.\nThey can also refer to other semantic urns in the future.",
+      "Urn": "Urn",
+      "urn_is_array": true
+    }
+  ],
+  "doc": "Linkedin corp user information that can be edited from UI"
+}