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

acryl_datahub_cloud/metadata/schemas/DataHubConnectionDetails.avsc

@@ -0,0 +1,62 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubConnectionDetails"
+  },
+  "name": "DataHubConnectionDetails",
+  "namespace": "com.linkedin.pegasus2avro.connection",
+  "fields": [
+    {
+      "Searchable": {},
+      "type": {
+        "type": "enum",
+        "symbolDocs": {
+          "JSON": "A json-encoded set of connection details"
+        },
+        "name": "DataHubConnectionDetailsType",
+        "namespace": "com.linkedin.pegasus2avro.connection",
+        "symbols": [
+          "JSON"
+        ]
+      },
+      "name": "type",
+      "doc": "The type of the connection. This defines the schema / encoding of the connection details."
+    },
+    {
+      "Searchable": {
+        "boostScore": 10.0,
+        "enableAutocomplete": true,
+        "fieldType": "TEXT_PARTIAL"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "name",
+      "default": null,
+      "doc": "Display name of the connection"
+    },
+    {
+      "type": [
+        "null",
+        {
+          "type": "record",
+          "name": "DataHubJsonConnection",
+          "namespace": "com.linkedin.pegasus2avro.connection",
+          "fields": [
+            {
+              "type": "string",
+              "name": "encryptedBlob",
+              "doc": "The encrypted JSON connection details."
+            }
+          ],
+          "doc": "A set of connection details consisting of an encrypted JSON blob."
+        }
+      ],
+      "name": "json",
+      "default": null,
+      "doc": "An JSON payload containing raw connection details.\nThis will be present if the type is JSON."
+    }
+  ],
+  "doc": "Information about a connection to an external platform."
+}

acryl_datahub_cloud/metadata/schemas/DataHubConnectionKey.avsc

@@ -0,0 +1,23 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubConnectionKey",
+    "keyForEntity": "dataHubConnection",
+    "entityCategory": "internal",
+    "entityAspects": [
+      "dataHubConnectionDetails",
+      "dataPlatformInstance"
+    ]
+  },
+  "name": "DataHubConnectionKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "Searchable": {},
+      "type": "string",
+      "name": "id",
+      "doc": "A unique identifier for the connection."
+    }
+  ],
+  "doc": "Key for a Connection"
+}

acryl_datahub_cloud/metadata/schemas/DataHubIngestionSourceInfo.avsc

@@ -0,0 +1,157 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubIngestionSourceInfo"
+  },
+  "name": "DataHubIngestionSourceInfo",
+  "namespace": "com.linkedin.pegasus2avro.ingestion",
+  "fields": [
+    {
+      "Searchable": {
+        "fieldType": "TEXT_PARTIAL"
+      },
+      "type": "string",
+      "name": "name",
+      "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."
+    },
+    {
+      "java": {
+        "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "platform",
+      "default": null,
+      "doc": "Data Platform URN associated with the source",
+      "Urn": "Urn"
+    },
+    {
+      "type": [
+        "null",
+        {
+          "type": "record",
+          "name": "DataHubIngestionSourceSchedule",
+          "namespace": "com.linkedin.pegasus2avro.ingestion",
+          "fields": [
+            {
+              "type": "string",
+              "name": "interval",
+              "doc": "A cron-formatted execution interval, as a cron string, e.g. * * * * *"
+            },
+            {
+              "type": "string",
+              "name": "timezone",
+              "doc": "Timezone in which the cron interval applies, e.g. America/Los Angeles"
+            }
+          ],
+          "doc": "The schedule associated with an ingestion source."
+        }
+      ],
+      "name": "schedule",
+      "default": null,
+      "doc": "The schedule on which the ingestion source is executed"
+    },
+    {
+      "type": {
+        "type": "record",
+        "name": "DataHubIngestionSourceConfig",
+        "namespace": "com.linkedin.pegasus2avro.ingestion",
+        "fields": [
+          {
+            "type": "string",
+            "name": "recipe",
+            "doc": "The JSON recipe to use for ingestion"
+          },
+          {
+            "type": [
+              "null",
+              "string"
+            ],
+            "name": "version",
+            "default": null,
+            "doc": "The PyPI version of the datahub CLI to use when executing a recipe"
+          },
+          {
+            "Searchable": {
+              "fieldName": "sourceExecutorId"
+            },
+            "type": [
+              "null",
+              "string"
+            ],
+            "name": "executorId",
+            "default": null,
+            "doc": "The id of the executor to use to execute the ingestion run"
+          },
+          {
+            "type": [
+              "null",
+              "boolean"
+            ],
+            "name": "debugMode",
+            "default": null,
+            "doc": "Whether or not to run this ingestion source in debug mode"
+          },
+          {
+            "type": [
+              "null",
+              {
+                "type": "map",
+                "values": "string"
+              }
+            ],
+            "name": "extraArgs",
+            "default": null,
+            "doc": "Extra arguments for the ingestion run."
+          }
+        ]
+      },
+      "name": "config",
+      "doc": "Parameters associated with the Ingestion Source"
+    },
+    {
+      "type": [
+        "null",
+        {
+          "type": "record",
+          "name": "DataHubIngestionSourceSource",
+          "namespace": "com.linkedin.pegasus2avro.ingestion",
+          "fields": [
+            {
+              "Searchable": {
+                "fieldName": "sourceType"
+              },
+              "type": {
+                "type": "enum",
+                "symbolDocs": {
+                  "SYSTEM": "A system internal source, e.g. for running search indexing operations, feature computation, etc."
+                },
+                "name": "DataHubIngestionSourceSourceType",
+                "namespace": "com.linkedin.pegasus2avro.ingestion",
+                "symbols": [
+                  "SYSTEM"
+                ]
+              },
+              "name": "type",
+              "doc": "The source type of the ingestion source"
+            }
+          ]
+        }
+      ],
+      "name": "source",
+      "default": null,
+      "doc": "The source or origin of the Ingestion Source\n\nCurrently CLI and UI do not provide an explicit source."
+    }
+  ],
+  "doc": "Info about a DataHub ingestion source"
+}

acryl_datahub_cloud/metadata/schemas/DataHubIngestionSourceKey.avsc

@@ -0,0 +1,21 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubIngestionSourceKey",
+    "keyForEntity": "dataHubIngestionSource",
+    "entityCategory": "internal",
+    "entityAspects": [
+      "dataHubIngestionSourceInfo"
+    ]
+  },
+  "name": "DataHubIngestionSourceKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "type": "string",
+      "name": "id",
+      "doc": "A unique id for the Ingestion Source, either generated or provided"
+    }
+  ],
+  "doc": "Key for a DataHub ingestion source"
+}

acryl_datahub_cloud/metadata/schemas/DataHubPersonaInfo.avsc

@@ -0,0 +1,24 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubPersonaInfo"
+  },
+  "name": "DataHubPersonaInfo",
+  "namespace": "com.linkedin.pegasus2avro.persona",
+  "fields": [
+    {
+      "java": {
+        "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "view",
+      "default": null,
+      "doc": "The urn of the search view associated with the persona.",
+      "Urn": "Urn"
+    }
+  ],
+  "doc": "Placeholder aspect for persona type info"
+}

acryl_datahub_cloud/metadata/schemas/DataHubPersonaKey.avsc

@@ -0,0 +1,21 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubPersonaKey",
+    "keyForEntity": "dataHubPersona",
+    "entityCategory": "internal",
+    "entityAspects": [
+      "dataHubPersonaInfo"
+    ]
+  },
+  "name": "DataHubPersonaKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "type": "string",
+      "name": "id",
+      "doc": "A unique id for the persona type"
+    }
+  ],
+  "doc": "Key for a persona type"
+}

acryl_datahub_cloud/metadata/schemas/DataHubPolicyInfo.avsc

@@ -0,0 +1,302 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubPolicyInfo"
+  },
+  "name": "DataHubPolicyInfo",
+  "namespace": "com.linkedin.pegasus2avro.policy",
+  "fields": [
+    {
+      "Searchable": {
+        "fieldType": "TEXT_PARTIAL"
+      },
+      "type": "string",
+      "name": "displayName",
+      "doc": "Display name of the Policy"
+    },
+    {
+      "Searchable": {
+        "fieldType": "TEXT"
+      },
+      "type": "string",
+      "name": "description",
+      "doc": "Description of the Policy"
+    },
+    {
+      "Searchable": {
+        "fieldType": "KEYWORD"
+      },
+      "type": "string",
+      "name": "type",
+      "doc": "The type of policy"
+    },
+    {
+      "Searchable": {
+        "fieldType": "KEYWORD"
+      },
+      "type": "string",
+      "name": "state",
+      "doc": "The state of policy, ACTIVE or INACTIVE"
+    },
+    {
+      "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."
+    },
+    {
+      "Searchable": {
+        "/*": {
+          "addToFilters": true,
+          "fieldType": "KEYWORD"
+        }
+      },
+      "type": {
+        "type": "array",
+        "items": "string"
+      },
+      "name": "privileges",
+      "doc": "The privileges that the policy grants."
+    },
+    {
+      "type": {
+        "type": "record",
+        "name": "DataHubActorFilter",
+        "namespace": "com.linkedin.pegasus2avro.policy",
+        "fields": [
+          {
+            "Searchable": {
+              "/*": {
+                "fieldType": "URN"
+              }
+            },
+            "type": [
+              "null",
+              {
+                "type": "array",
+                "items": "string"
+              }
+            ],
+            "name": "users",
+            "default": null,
+            "doc": "A specific set of users to apply the policy to (disjunctive)",
+            "Urn": "Urn",
+            "urn_is_array": true
+          },
+          {
+            "Searchable": {
+              "/*": {
+                "fieldType": "URN"
+              }
+            },
+            "type": [
+              "null",
+              {
+                "type": "array",
+                "items": "string"
+              }
+            ],
+            "name": "groups",
+            "default": null,
+            "doc": "A specific set of groups to apply the policy to (disjunctive)",
+            "Urn": "Urn",
+            "urn_is_array": true
+          },
+          {
+            "type": "boolean",
+            "name": "resourceOwners",
+            "default": false,
+            "doc": "Whether the filter should return true for owners of a particular resource.\nOnly applies to policies of type 'Metadata', which have a resource associated with them."
+          },
+          {
+            "type": [
+              "null",
+              {
+                "type": "array",
+                "items": "string"
+              }
+            ],
+            "name": "resourceOwnersTypes",
+            "default": null,
+            "doc": "Define type of ownership for the policy",
+            "Urn": "Urn",
+            "urn_is_array": true
+          },
+          {
+            "Searchable": {
+              "fieldType": "BOOLEAN"
+            },
+            "type": "boolean",
+            "name": "allUsers",
+            "default": false,
+            "doc": "Whether the filter should apply to all users."
+          },
+          {
+            "Searchable": {
+              "fieldType": "BOOLEAN"
+            },
+            "type": "boolean",
+            "name": "allGroups",
+            "default": false,
+            "doc": "Whether the filter should apply to all groups."
+          },
+          {
+            "Relationship": {
+              "/*": {
+                "entityTypes": [
+                  "dataHubRole"
+                ],
+                "name": "IsAssociatedWithRole"
+              }
+            },
+            "Searchable": {
+              "/*": {
+                "fieldType": "URN"
+              }
+            },
+            "type": [
+              "null",
+              {
+                "type": "array",
+                "items": "string"
+              }
+            ],
+            "name": "roles",
+            "default": null,
+            "doc": "A specific set of roles to apply the policy to (disjunctive).",
+            "Urn": "Urn",
+            "urn_is_array": true
+          }
+        ],
+        "doc": "Information used to filter DataHub actors."
+      },
+      "name": "actors",
+      "doc": "The actors that the policy applies to."
+    },
+    {
+      "Searchable": {
+        "fieldType": "BOOLEAN"
+      },
+      "type": "boolean",
+      "name": "editable",
+      "default": true,
+      "doc": "Whether the policy should be editable via the UI"
+    },
+    {
+      "Searchable": {
+        "fieldType": "DATETIME"
+      },
+      "type": [
+        "null",
+        "long"
+      ],
+      "name": "lastUpdatedTimestamp",
+      "default": null,
+      "doc": "Timestamp when the policy was last updated"
+    }
+  ],
+  "doc": "Information about a DataHub (UI) access policy."
+}

acryl_datahub_cloud/metadata/schemas/DataHubPolicyKey.avsc

@@ -0,0 +1,22 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubPolicyKey",
+    "keyForEntity": "dataHubPolicy",
+    "entityCategory": "internal",
+    "entityAspects": [
+      "dataHubPolicyInfo"
+    ],
+    "entityDoc": "DataHub Policies represent access policies granted to users or groups on metadata operations like edit, view etc."
+  },
+  "name": "DataHubPolicyKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "type": "string",
+      "name": "id",
+      "doc": "A unique id for the DataHub access policy record. Generated on the server side at policy creation time."
+    }
+  ],
+  "doc": "Key for a DataHub Policy"
+}