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

acryl_datahub_cloud/metadata/schemas/DataHubRetentionConfig.avsc

@@ -0,0 +1,59 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubRetentionConfig"
+  },
+  "name": "DataHubRetentionConfig",
+  "namespace": "com.linkedin.pegasus2avro.retention",
+  "fields": [
+    {
+      "type": {
+        "type": "record",
+        "name": "Retention",
+        "namespace": "com.linkedin.pegasus2avro.retention",
+        "fields": [
+          {
+            "type": [
+              "null",
+              {
+                "type": "record",
+                "name": "VersionBasedRetention",
+                "namespace": "com.linkedin.pegasus2avro.retention",
+                "fields": [
+                  {
+                    "type": "int",
+                    "name": "maxVersions"
+                  }
+                ],
+                "doc": "Keep max N latest records"
+              }
+            ],
+            "name": "version",
+            "default": null
+          },
+          {
+            "type": [
+              "null",
+              {
+                "type": "record",
+                "name": "TimeBasedRetention",
+                "namespace": "com.linkedin.pegasus2avro.retention",
+                "fields": [
+                  {
+                    "type": "int",
+                    "name": "maxAgeInSeconds"
+                  }
+                ],
+                "doc": "Keep records that are less than X seconds old"
+              }
+            ],
+            "name": "time",
+            "default": null
+          }
+        ],
+        "doc": "Base class that encapsulates different retention policies.\nOnly one of the fields should be set"
+      },
+      "name": "retention"
+    }
+  ]
+}

acryl_datahub_cloud/metadata/schemas/DataHubRetentionKey.avsc

@@ -0,0 +1,26 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubRetentionKey",
+    "keyForEntity": "dataHubRetention",
+    "entityCategory": "internal",
+    "entityAspects": [
+      "dataHubRetentionConfig"
+    ]
+  },
+  "name": "DataHubRetentionKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "type": "string",
+      "name": "entityName",
+      "doc": "Entity name to apply retention to. * (or empty) for applying defaults."
+    },
+    {
+      "type": "string",
+      "name": "aspectName",
+      "doc": "Aspect name to apply retention to. * (or empty) for applying defaults."
+    }
+  ],
+  "doc": "Key for a DataHub Retention"
+}

acryl_datahub_cloud/metadata/schemas/DataHubRoleInfo.avsc

@@ -0,0 +1,33 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubRoleInfo"
+  },
+  "name": "DataHubRoleInfo",
+  "namespace": "com.linkedin.pegasus2avro.policy",
+  "fields": [
+    {
+      "Searchable": {
+        "fieldType": "TEXT_PARTIAL"
+      },
+      "type": "string",
+      "name": "name",
+      "doc": "Name of the Role"
+    },
+    {
+      "Searchable": {
+        "fieldType": "TEXT"
+      },
+      "type": "string",
+      "name": "description",
+      "doc": "Description of the Role"
+    },
+    {
+      "type": "boolean",
+      "name": "editable",
+      "default": false,
+      "doc": "Whether the role should be editable via the UI"
+    }
+  ],
+  "doc": "Information about a DataHub Role."
+}

acryl_datahub_cloud/metadata/schemas/DataHubRoleKey.avsc

@@ -0,0 +1,21 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubRoleKey",
+    "keyForEntity": "dataHubRole",
+    "entityCategory": "core",
+    "entityAspects": [
+      "dataHubRoleInfo"
+    ]
+  },
+  "name": "DataHubRoleKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "type": "string",
+      "name": "id",
+      "doc": "A unique id for the DataHub role record. Generated on the server side at role creation time."
+    }
+  ],
+  "doc": "Key for a DataHub Role"
+}

acryl_datahub_cloud/metadata/schemas/DataHubSecretKey.avsc

@@ -0,0 +1,21 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubSecretKey",
+    "keyForEntity": "dataHubSecret",
+    "entityCategory": "internal",
+    "entityAspects": [
+      "dataHubSecretValue"
+    ]
+  },
+  "name": "DataHubSecretKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "type": "string",
+      "name": "id",
+      "doc": "A unique id for the Secret"
+    }
+  ],
+  "doc": "Key for a DataHub Secret"
+}

acryl_datahub_cloud/metadata/schemas/DataHubSecretValue.avsc

@@ -0,0 +1,91 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubSecretValue"
+  },
+  "name": "DataHubSecretValue",
+  "namespace": "com.linkedin.pegasus2avro.secret",
+  "fields": [
+    {
+      "Searchable": {
+        "fieldType": "TEXT_PARTIAL"
+      },
+      "type": "string",
+      "name": "name",
+      "doc": "The display name for the secret"
+    },
+    {
+      "type": "string",
+      "name": "value",
+      "doc": "The AES-encrypted value of the DataHub secret."
+    },
+    {
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "description",
+      "default": null,
+      "doc": "Description of the secret"
+    },
+    {
+      "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": "The value of a DataHub Secret"
+}

acryl_datahub_cloud/metadata/schemas/DataHubStepStateKey.avsc

@@ -0,0 +1,21 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubStepStateKey",
+    "keyForEntity": "dataHubStepState",
+    "entityCategory": "internal",
+    "entityAspects": [
+      "dataHubStepStateProperties"
+    ]
+  },
+  "name": "DataHubStepStateKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "type": "string",
+      "name": "id",
+      "doc": "A unique id for the state"
+    }
+  ],
+  "doc": "Key for a DataHub Step State"
+}

acryl_datahub_cloud/metadata/schemas/DataHubStepStateProperties.avsc

@@ -0,0 +1,68 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubStepStateProperties"
+  },
+  "name": "DataHubStepStateProperties",
+  "namespace": "com.linkedin.pegasus2avro.step",
+  "fields": [
+    {
+      "type": {
+        "type": "map",
+        "values": "string"
+      },
+      "name": "properties",
+      "default": {},
+      "doc": "Description of the secret"
+    },
+    {
+      "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 describing the last person to update it."
+    }
+  ],
+  "doc": "The properties associated with a DataHub step state"
+}

acryl_datahub_cloud/metadata/schemas/DataHubUpgradeKey.avsc

@@ -0,0 +1,21 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubUpgradeKey",
+    "keyForEntity": "dataHubUpgrade",
+    "entityCategory": "internal",
+    "entityAspects": [
+      "dataHubUpgradeRequest",
+      "dataHubUpgradeResult"
+    ]
+  },
+  "name": "DataHubUpgradeKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "type": "string",
+      "name": "id"
+    }
+  ],
+  "doc": "Key for a DataHubUpgrade"
+}

acryl_datahub_cloud/metadata/schemas/DataHubUpgradeRequest.avsc

@@ -0,0 +1,21 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubUpgradeRequest"
+  },
+  "name": "DataHubUpgradeRequest",
+  "namespace": "com.linkedin.pegasus2avro.upgrade",
+  "fields": [
+    {
+      "type": "long",
+      "name": "timestampMs",
+      "doc": "Timestamp when we started this DataHubUpgrade"
+    },
+    {
+      "type": "string",
+      "name": "version",
+      "doc": "Version of this upgrade"
+    }
+  ],
+  "doc": "Information collected when kicking off a DataHubUpgrade"
+}

acryl_datahub_cloud/metadata/schemas/DataHubUpgradeResult.avsc

@@ -0,0 +1,53 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubUpgradeResult"
+  },
+  "name": "DataHubUpgradeResult",
+  "namespace": "com.linkedin.pegasus2avro.upgrade",
+  "fields": [
+    {
+      "type": [
+        {
+          "type": "enum",
+          "symbolDocs": {
+            "ABORTED": "Upgrade with an error state and should not be re-run.",
+            "FAILED": "Upgrade with an error state, however the upgrade should be re-run.",
+            "IN_PROGRESS": "Upgrade in progress.",
+            "SUCCEEDED": "Upgrade was successful."
+          },
+          "name": "DataHubUpgradeState",
+          "namespace": "com.linkedin.pegasus2avro.upgrade",
+          "symbols": [
+            "IN_PROGRESS",
+            "SUCCEEDED",
+            "FAILED",
+            "ABORTED"
+          ]
+        },
+        "null"
+      ],
+      "name": "state",
+      "default": "SUCCEEDED",
+      "doc": "Upgrade state  UpgradeResult.Result"
+    },
+    {
+      "type": "long",
+      "name": "timestampMs",
+      "doc": "Timestamp when we started this DataHubUpgrade"
+    },
+    {
+      "type": [
+        "null",
+        {
+          "type": "map",
+          "values": "string"
+        }
+      ],
+      "name": "result",
+      "default": null,
+      "doc": "Result map to place helpful information about this upgrade job"
+    }
+  ],
+  "doc": "Information collected when a DataHubUpgrade successfully finishes"
+}