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

acryl_datahub_cloud/metadata/schemas/CorpUserInfo.avsc

@@ -0,0 +1,171 @@
+{
+  "type": "record",
+  "Aspect": {
+    "EntityUrns": [
+      "com.linkedin.pegasus2avro.common.CorpuserUrn"
+    ],
+    "name": "corpUserInfo"
+  },
+  "name": "CorpUserInfo",
+  "namespace": "com.linkedin.pegasus2avro.identity",
+  "fields": [
+    {
+      "Searchable": {
+        "/*": {
+          "fieldType": "TEXT",
+          "queryByDefault": true
+        }
+      },
+      "type": {
+        "type": "map",
+        "values": "string"
+      },
+      "name": "customProperties",
+      "default": {},
+      "doc": "Custom property bag."
+    },
+    {
+      "Searchable": {
+        "fieldType": "BOOLEAN",
+        "weightsPerFieldValue": {
+          "true": 2.0
+        }
+      },
+      "type": "boolean",
+      "name": "active",
+      "doc": "Deprecated! Use CorpUserStatus instead. Whether the corpUser is active, ref: https://iwww.corp.linkedin.com/wiki/cf/display/GTSD/Accessing+Active+Directory+via+LDAP+tools"
+    },
+    {
+      "Searchable": {
+        "boostScore": 10.0,
+        "enableAutocomplete": true,
+        "fieldNameAliases": [
+          "_entityName"
+        ],
+        "fieldType": "WORD_GRAM",
+        "queryByDefault": true
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "displayName",
+      "default": null,
+      "doc": "displayName of this user ,  e.g.  Hang Zhang(DataHQ)"
+    },
+    {
+      "Searchable": {
+        "fieldType": "KEYWORD",
+        "queryByDefault": true
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "email",
+      "default": null,
+      "doc": "email address of this user"
+    },
+    {
+      "Searchable": {
+        "fieldType": "KEYWORD",
+        "queryByDefault": true
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "title",
+      "default": null,
+      "doc": "title of this user"
+    },
+    {
+      "Relationship": {
+        "entityTypes": [
+          "corpuser"
+        ],
+        "name": "ReportsTo"
+      },
+      "Searchable": {
+        "fieldName": "managerLdap",
+        "fieldType": "URN",
+        "queryByDefault": false
+      },
+      "java": {
+        "class": "com.linkedin.pegasus2avro.common.urn.CorpuserUrn"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "managerUrn",
+      "default": null,
+      "doc": "direct manager of this user",
+      "Urn": "CorpuserUrn",
+      "entityTypes": [
+        "corpuser"
+      ]
+    },
+    {
+      "type": [
+        "null",
+        "long"
+      ],
+      "name": "departmentId",
+      "default": null,
+      "doc": "department id this user belong to"
+    },
+    {
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "departmentName",
+      "default": null,
+      "doc": "department name this user belong to"
+    },
+    {
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "firstName",
+      "default": null,
+      "doc": "first name of this user"
+    },
+    {
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "lastName",
+      "default": null,
+      "doc": "last name of this user"
+    },
+    {
+      "Searchable": {
+        "boostScore": 10.0,
+        "enableAutocomplete": true,
+        "fieldType": "WORD_GRAM",
+        "queryByDefault": true
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "fullName",
+      "default": null,
+      "doc": "Common name of this user, format is firstName + lastName (split by a whitespace)"
+    },
+    {
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "countryCode",
+      "default": null,
+      "doc": "two uppercase letters country code. e.g.  US"
+    }
+  ],
+  "doc": "Linkedin corp user information"
+}

acryl_datahub_cloud/metadata/schemas/CorpUserKey.avsc

@@ -0,0 +1,43 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "corpUserKey",
+    "keyForEntity": "corpuser",
+    "entityCategory": "_unset_",
+    "entityAspects": [
+      "corpUserInfo",
+      "corpUserEditableInfo",
+      "corpUserStatus",
+      "groupMembership",
+      "globalTags",
+      "status",
+      "corpUserCredentials",
+      "nativeGroupMembership",
+      "corpUserSettings",
+      "origin",
+      "roleMembership",
+      "structuredProperties",
+      "forms",
+      "testResults",
+      "share",
+      "slackUserInfo"
+    ],
+    "entityDoc": "CorpUser represents an identity of a person (or an account) in the enterprise."
+  },
+  "name": "CorpUserKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "Searchable": {
+        "boostScore": 2.0,
+        "enableAutocomplete": true,
+        "fieldName": "ldap",
+        "fieldType": "WORD_GRAM"
+      },
+      "type": "string",
+      "name": "username",
+      "doc": "The name of the AD/LDAP user."
+    }
+  ],
+  "doc": "Key for a CorpUser"
+}

acryl_datahub_cloud/metadata/schemas/CorpUserSettings.avsc

@@ -0,0 +1,165 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "corpUserSettings"
+  },
+  "name": "CorpUserSettings",
+  "namespace": "com.linkedin.pegasus2avro.identity",
+  "fields": [
+    {
+      "type": {
+        "type": "record",
+        "name": "CorpUserAppearanceSettings",
+        "namespace": "com.linkedin.pegasus2avro.identity",
+        "fields": [
+          {
+            "type": [
+              "null",
+              "boolean"
+            ],
+            "name": "showSimplifiedHomepage",
+            "default": null,
+            "doc": "Flag whether the user should see a homepage with only datasets, charts and dashboards. Intended for users\nwho have less operational use cases for the datahub tool."
+          },
+          {
+            "type": [
+              "null",
+              "boolean"
+            ],
+            "name": "showThemeV2",
+            "default": null,
+            "doc": "Flag controlling whether the V2 UI for DataHub is shown."
+          }
+        ],
+        "doc": "Settings for a user around the appearance of their DataHub UI"
+      },
+      "name": "appearance",
+      "doc": "Settings for a user around the appearance of their DataHub UI"
+    },
+    {
+      "type": [
+        "null",
+        {
+          "type": "record",
+          "name": "CorpUserViewsSettings",
+          "namespace": "com.linkedin.pegasus2avro.identity",
+          "fields": [
+            {
+              "java": {
+                "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+              },
+              "type": [
+                "null",
+                "string"
+              ],
+              "name": "defaultView",
+              "default": null,
+              "doc": "The default View which is selected for the user.\nIf none is chosen, then this value will be left blank.",
+              "Urn": "Urn"
+            }
+          ],
+          "doc": "Settings related to the 'Views' feature."
+        }
+      ],
+      "name": "views",
+      "default": null,
+      "doc": "User preferences for the Views feature."
+    },
+    {
+      "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 user"
+    }
+  ],
+  "doc": "Settings that a user can customize through the DataHub UI"
+}

acryl_datahub_cloud/metadata/schemas/CorpUserStatus.avsc

@@ -0,0 +1,73 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "corpUserStatus"
+  },
+  "name": "CorpUserStatus",
+  "namespace": "com.linkedin.pegasus2avro.identity",
+  "fields": [
+    {
+      "Searchable": {
+        "fieldType": "KEYWORD"
+      },
+      "type": "string",
+      "name": "status",
+      "doc": "Status of the user, e.g. PROVISIONED / ACTIVE / SUSPENDED"
+    },
+    {
+      "Searchable": {
+        "/time": {
+          "fieldName": "statusLastModifiedAt",
+          "fieldType": "COUNT"
+        }
+      },
+      "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": "lastModified",
+      "doc": "Audit stamp containing who last modified the status and when."
+    }
+  ],
+  "doc": "The status of the user, e.g. provisioned, active, suspended, etc."
+}

acryl_datahub_cloud/metadata/schemas/Cost.avsc

@@ -0,0 +1,64 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "cost"
+  },
+  "name": "Cost",
+  "namespace": "com.linkedin.pegasus2avro.common",
+  "fields": [
+    {
+      "type": {
+        "type": "enum",
+        "symbolDocs": {
+          "ORG_COST_TYPE": "Org Cost Type to which the Cost of this entity should be attributed to"
+        },
+        "name": "CostType",
+        "namespace": "com.linkedin.pegasus2avro.common",
+        "symbols": [
+          "ORG_COST_TYPE"
+        ],
+        "doc": "Type of Cost Code"
+      },
+      "name": "costType"
+    },
+    {
+      "type": {
+        "type": "record",
+        "name": "CostCost",
+        "namespace": "com.linkedin.pegasus2avro.common",
+        "fields": [
+          {
+            "type": [
+              "null",
+              "double"
+            ],
+            "name": "costId",
+            "default": null
+          },
+          {
+            "type": [
+              "null",
+              "string"
+            ],
+            "name": "costCode",
+            "default": null
+          },
+          {
+            "type": {
+              "type": "enum",
+              "name": "CostCostDiscriminator",
+              "namespace": "com.linkedin.pegasus2avro.common",
+              "symbols": [
+                "costId",
+                "costCode"
+              ]
+            },
+            "name": "fieldDiscriminator",
+            "doc": "Contains the name of the field that has its value set."
+          }
+        ]
+      },
+      "name": "cost"
+    }
+  ]
+}

acryl_datahub_cloud/metadata/schemas/CostFeatures.avsc

@@ -0,0 +1,36 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "costFeatures"
+  },
+  "name": "CostFeatures",
+  "namespace": "com.linkedin.pegasus2avro.metadata.search.features",
+  "fields": [
+    {
+      "type": [
+        "null",
+        "float"
+      ],
+      "name": "costLast30Days",
+      "default": null,
+      "doc": "Cost over last 30 days. The currency type is set with costCurrencyCode."
+    },
+    {
+      "type": [
+        "null",
+        {
+          "type": "enum",
+          "name": "CostCurrencyCode",
+          "namespace": "com.linkedin.pegasus2avro.metadata.search.features",
+          "symbols": [
+            "USD"
+          ],
+          "doc": " Currency code for the cost "
+        }
+      ],
+      "name": "costCurrencyCode",
+      "default": null,
+      "doc": "The currency code for the given cost."
+    }
+  ]
+}