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

acryl_datahub_cloud/metadata/schemas/DataFlowInfo.avsc

@@ -0,0 +1,188 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataFlowInfo"
+  },
+  "name": "DataFlowInfo",
+  "namespace": "com.linkedin.pegasus2avro.datajob",
+  "fields": [
+    {
+      "Searchable": {
+        "/*": {
+          "fieldType": "TEXT",
+          "queryByDefault": true
+        }
+      },
+      "type": {
+        "type": "map",
+        "values": "string"
+      },
+      "name": "customProperties",
+      "default": {},
+      "doc": "Custom property bag."
+    },
+    {
+      "Searchable": {
+        "fieldType": "KEYWORD"
+      },
+      "java": {
+        "class": "com.linkedin.pegasus2avro.common.url.Url",
+        "coercerClass": "com.linkedin.pegasus2avro.common.url.UrlCoercer"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "externalUrl",
+      "default": null,
+      "doc": "URL where the reference exist"
+    },
+    {
+      "Searchable": {
+        "boostScore": 10.0,
+        "enableAutocomplete": true,
+        "fieldNameAliases": [
+          "_entityName"
+        ],
+        "fieldType": "WORD_GRAM"
+      },
+      "type": "string",
+      "name": "name",
+      "doc": "Flow name"
+    },
+    {
+      "Searchable": {
+        "fieldType": "TEXT",
+        "hasValuesFieldName": "hasDescription"
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "description",
+      "default": null,
+      "doc": "Flow description"
+    },
+    {
+      "Searchable": {
+        "fieldType": "TEXT_PARTIAL",
+        "queryByDefault": false
+      },
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "project",
+      "default": null,
+      "doc": "Optional project/namespace associated with the flow"
+    },
+    {
+      "Searchable": {
+        "/time": {
+          "fieldName": "createdAt",
+          "fieldType": "DATETIME"
+        }
+      },
+      "type": [
+        "null",
+        {
+          "type": "record",
+          "name": "TimeStamp",
+          "namespace": "com.linkedin.pegasus2avro.common",
+          "fields": [
+            {
+              "type": "long",
+              "name": "time",
+              "doc": "When did the event occur"
+            },
+            {
+              "java": {
+                "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+              },
+              "type": [
+                "null",
+                "string"
+              ],
+              "name": "actor",
+              "default": null,
+              "doc": "Optional: The actor urn involved in the event.",
+              "Urn": "Urn"
+            }
+          ],
+          "doc": "A standard event timestamp"
+        }
+      ],
+      "name": "created",
+      "default": null,
+      "doc": "A timestamp documenting when the asset was created in the source Data Platform (not on DataHub)"
+    },
+    {
+      "Searchable": {
+        "/time": {
+          "fieldName": "lastModifiedAt",
+          "fieldType": "DATETIME"
+        }
+      },
+      "type": [
+        "null",
+        "com.linkedin.pegasus2avro.common.TimeStamp"
+      ],
+      "name": "lastModified",
+      "default": null,
+      "doc": "A timestamp documenting when the asset was last modified in the source Data Platform (not on DataHub)"
+    },
+    {
+      "Searchable": {
+        "addToFilters": true,
+        "fieldType": "KEYWORD",
+        "filterNameOverride": "Environment",
+        "queryByDefault": false
+      },
+      "type": [
+        "null",
+        {
+          "type": "enum",
+          "symbolDocs": {
+            "CORP": "Designates corporation fabrics",
+            "DEV": "Designates development fabrics",
+            "EI": "Designates early-integration fabrics",
+            "NON_PROD": "Designates non-production fabrics",
+            "PRD": "Alternative Prod spelling",
+            "PRE": "Designates pre-production fabrics",
+            "PROD": "Designates production fabrics",
+            "QA": "Designates quality assurance fabrics",
+            "RVW": "Designates review fabrics",
+            "SANDBOX": "Designates sandbox fabrics",
+            "STG": "Designates staging fabrics",
+            "TEST": "Designates testing fabrics",
+            "TST": "Alternative Test spelling",
+            "UAT": "Designates user acceptance testing fabrics"
+          },
+          "name": "FabricType",
+          "namespace": "com.linkedin.pegasus2avro.common",
+          "symbols": [
+            "DEV",
+            "TEST",
+            "QA",
+            "UAT",
+            "EI",
+            "PRE",
+            "STG",
+            "NON_PROD",
+            "PROD",
+            "CORP",
+            "RVW",
+            "PRD",
+            "TST",
+            "SANDBOX"
+          ],
+          "doc": "Fabric group type"
+        }
+      ],
+      "name": "env",
+      "default": null,
+      "doc": "Environment for this flow"
+    }
+  ],
+  "doc": "Information about a Data processing flow"
+}

acryl_datahub_cloud/metadata/schemas/DataFlowKey.avsc

@@ -0,0 +1,64 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataFlowKey",
+    "keyForEntity": "dataFlow",
+    "entityCategory": "core",
+    "entityAspects": [
+      "domains",
+      "deprecation",
+      "versionInfo",
+      "proposals",
+      "dataFlowInfo",
+      "editableDataFlowProperties",
+      "ownership",
+      "status",
+      "globalTags",
+      "browsePaths",
+      "glossaryTerms",
+      "institutionalMemory",
+      "dataPlatformInstance",
+      "container",
+      "browsePathsV2",
+      "structuredProperties",
+      "incidentsSummary",
+      "forms",
+      "subTypes",
+      "testResults",
+      "share",
+      "origin",
+      "lineageFeatures",
+      "documentation"
+    ]
+  },
+  "name": "DataFlowKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "Searchable": {
+        "fieldType": "TEXT_PARTIAL"
+      },
+      "type": "string",
+      "name": "orchestrator",
+      "doc": "Workflow manager like azkaban, airflow which orchestrates the flow"
+    },
+    {
+      "Searchable": {
+        "enableAutocomplete": true,
+        "fieldType": "WORD_GRAM"
+      },
+      "type": "string",
+      "name": "flowId",
+      "doc": "Unique Identifier of the data flow"
+    },
+    {
+      "Searchable": {
+        "fieldType": "TEXT_PARTIAL"
+      },
+      "type": "string",
+      "name": "cluster",
+      "doc": "Cluster where the flow is executed"
+    }
+  ],
+  "doc": "Key for a Data Flow"
+}

acryl_datahub_cloud/metadata/schemas/DataHubAccessTokenInfo.avsc

@@ -0,0 +1,74 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubAccessTokenInfo"
+  },
+  "name": "DataHubAccessTokenInfo",
+  "namespace": "com.linkedin.pegasus2avro.access.token",
+  "fields": [
+    {
+      "Searchable": {
+        "fieldType": "TEXT_PARTIAL"
+      },
+      "type": "string",
+      "name": "name",
+      "doc": "User defined name for the access token if defined."
+    },
+    {
+      "Searchable": {
+        "fieldType": "URN"
+      },
+      "java": {
+        "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+      },
+      "type": "string",
+      "name": "actorUrn",
+      "doc": "Urn of the actor to which this access token belongs to.",
+      "Urn": "Urn"
+    },
+    {
+      "Searchable": {
+        "fieldType": "URN"
+      },
+      "java": {
+        "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+      },
+      "type": "string",
+      "name": "ownerUrn",
+      "doc": "Urn of the actor which created this access token.",
+      "Urn": "Urn"
+    },
+    {
+      "Searchable": {
+        "fieldType": "COUNT",
+        "queryByDefault": false
+      },
+      "type": "long",
+      "name": "createdAt",
+      "doc": "When the token was created."
+    },
+    {
+      "Searchable": {
+        "fieldType": "COUNT",
+        "queryByDefault": false
+      },
+      "type": [
+        "null",
+        "long"
+      ],
+      "name": "expiresAt",
+      "default": null,
+      "doc": "When the token expires."
+    },
+    {
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "description",
+      "default": null,
+      "doc": "Description of the token if defined."
+    }
+  ],
+  "doc": "Information about a DataHub Access Token"
+}

acryl_datahub_cloud/metadata/schemas/DataHubAccessTokenKey.avsc

@@ -0,0 +1,21 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubAccessTokenKey",
+    "keyForEntity": "dataHubAccessToken",
+    "entityCategory": "internal",
+    "entityAspects": [
+      "dataHubAccessTokenInfo"
+    ]
+  },
+  "name": "DataHubAccessTokenKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "type": "string",
+      "name": "id",
+      "doc": "Access token's SHA-256 hashed JWT signature"
+    }
+  ],
+  "doc": "Key for a DataHub Access Token"
+}

acryl_datahub_cloud/metadata/schemas/DataHubActionInfo.avsc

@@ -0,0 +1,121 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubActionInfo"
+  },
+  "name": "DataHubActionInfo",
+  "namespace": "com.linkedin.pegasus2avro.action",
+  "fields": [
+    {
+      "Searchable": {
+        "fieldType": "TEXT_PARTIAL"
+      },
+      "type": "string",
+      "name": "name",
+      "doc": "The display name of the action"
+    },
+    {
+      "type": "string",
+      "name": "type",
+      "doc": "The type of the action itself, e.g. tag_propagation. Should match the recipe."
+    },
+    {
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "category",
+      "default": null,
+      "doc": "The category of the action"
+    },
+    {
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "description",
+      "default": null,
+      "doc": "The description of the action"
+    },
+    {
+      "type": {
+        "type": "record",
+        "name": "DataHubActionConfig",
+        "namespace": "com.linkedin.pegasus2avro.action",
+        "fields": [
+          {
+            "type": "string",
+            "name": "recipe",
+            "doc": "The JSON recipe to use for the automation"
+          },
+          {
+            "type": [
+              "null",
+              "string"
+            ],
+            "name": "executorId",
+            "default": null,
+            "doc": "The id of the executor to use to execute the automation. Defaults to 'default' (runs locally)"
+          }
+        ]
+      },
+      "name": "config",
+      "doc": "Parameters associated with the Action"
+    },
+    {
+      "type": [
+        {
+          "type": "enum",
+          "symbolDocs": {
+            "ACTIVE": "The action is supposed to be active",
+            "INACTIVE": "The action should be inactive"
+          },
+          "name": "DataHubActionState",
+          "namespace": "com.linkedin.pegasus2avro.action",
+          "symbols": [
+            "ACTIVE",
+            "INACTIVE"
+          ]
+        },
+        "null"
+      ],
+      "name": "state",
+      "default": "ACTIVE",
+      "doc": "The intended state of the action"
+    },
+    {
+      "type": [
+        "null",
+        {
+          "type": "record",
+          "name": "DataHubActionSource",
+          "namespace": "com.linkedin.pegasus2avro.action",
+          "fields": [
+            {
+              "Searchable": {
+                "fieldName": "sourceType"
+              },
+              "type": {
+                "type": "enum",
+                "symbolDocs": {
+                  "SYSTEM": "A system internal source, e.g. for running search indexing operations, feature computation, etc."
+                },
+                "name": "DataHubActionRequestSource",
+                "namespace": "com.linkedin.pegasus2avro.action",
+                "symbols": [
+                  "SYSTEM"
+                ]
+              },
+              "name": "type",
+              "doc": "The source type of the ingestion source"
+            }
+          ]
+        }
+      ],
+      "name": "source",
+      "default": null,
+      "doc": "The source or origin of the Action\n\nCurrently CLI and UI do not provide an explicit source."
+    }
+  ],
+  "doc": "Info about a DataHub Action Pipeline"
+}

acryl_datahub_cloud/metadata/schemas/DataHubActionKey.avsc

@@ -0,0 +1,22 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubActionKey",
+    "keyForEntity": "dataHubAction",
+    "entityCategory": "internal",
+    "entityAspects": [
+      "dataHubActionInfo",
+      "dataHubActionStatus"
+    ]
+  },
+  "name": "DataHubActionKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "type": "string",
+      "name": "id",
+      "doc": "A unique id for the Action, either generated or provided"
+    }
+  ],
+  "doc": "Key for a DataHub Action Pipeline"
+}

acryl_datahub_cloud/metadata/schemas/DataHubActionStatus.avsc

@@ -0,0 +1,181 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubActionStatus"
+  },
+  "name": "DataHubActionStatus",
+  "namespace": "com.linkedin.pegasus2avro.action",
+  "fields": [
+    {
+      "type": [
+        "null",
+        {
+          "type": "record",
+          "name": "DataHubActionStageStatus",
+          "namespace": "com.linkedin.pegasus2avro.action",
+          "fields": [
+            {
+              "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": "reportedTime",
+              "doc": "The time and source of the last update to the status"
+            },
+            {
+              "type": {
+                "type": "enum",
+                "name": "DataHubActionStageStatusCode",
+                "namespace": "com.linkedin.pegasus2avro.action",
+                "symbols": [
+                  "RUNNING",
+                  "SUCCESS",
+                  "FAILED",
+                  "STOPPED",
+                  "CANCELLED"
+                ],
+                "doc": "Captures the various status codes for different stages of a DataHub Action Pipeline"
+              },
+              "name": "statusCode",
+              "doc": "The status of the stage"
+            },
+            {
+              "type": "long",
+              "name": "startTime",
+              "doc": "The time the most recent invocation of the stage was started"
+            },
+            {
+              "type": [
+                "null",
+                "long"
+              ],
+              "name": "endTime",
+              "default": null,
+              "doc": "The time the most recent invocation of the stage completed (either\nsuccessfully or unsuccessfully)\nIn the case of a running stage, this field should be null"
+            },
+            {
+              "type": [
+                "null",
+                "long"
+              ],
+              "name": "lastSuccess",
+              "default": null,
+              "doc": "The time the most recent invocation of the stage was successful"
+            },
+            {
+              "type": [
+                "null",
+                "string"
+              ],
+              "name": "report",
+              "default": null,
+              "doc": "Logs from the action stage."
+            },
+            {
+              "type": [
+                "null",
+                {
+                  "type": "record",
+                  "name": "StructuredExecutionReport",
+                  "namespace": "com.linkedin.pegasus2avro.execution",
+                  "fields": [
+                    {
+                      "type": "string",
+                      "name": "type",
+                      "doc": "The type of the structured report. (e.g. INGESTION_REPORT, TEST_CONNECTION_REPORT, etc.)"
+                    },
+                    {
+                      "type": "string",
+                      "name": "serializedValue",
+                      "doc": "The serialized value of the structured report"
+                    },
+                    {
+                      "type": "string",
+                      "name": "contentType",
+                      "doc": "The content-type of the serialized value (e.g. application/json, application/json;gzip etc.)"
+                    }
+                  ],
+                  "doc": "A flexible carrier for structured results of an execution request.\nThe goal is to allow for free flow of structured responses from execution tasks to the orchestrator or observer.\nThe full spectrum of different execution report types is not intended to be modeled by this object."
+                }
+              ],
+              "name": "structuredReport",
+              "default": null,
+              "doc": "A structured report."
+            },
+            {
+              "type": {
+                "type": "map",
+                "values": "string"
+              },
+              "name": "customProperties",
+              "default": {},
+              "doc": "Additional properties for the pipeline status"
+            }
+          ]
+        }
+      ],
+      "name": "bootstrap",
+      "default": null,
+      "doc": "Status of the bootstrap pipeline if applicable"
+    },
+    {
+      "type": [
+        "null",
+        "com.linkedin.pegasus2avro.action.DataHubActionStageStatus"
+      ],
+      "name": "live",
+      "default": null,
+      "doc": "Status of the live pipeline"
+    },
+    {
+      "type": [
+        "null",
+        "com.linkedin.pegasus2avro.action.DataHubActionStageStatus"
+      ],
+      "name": "rollback",
+      "default": null,
+      "doc": "Status of the rollback pipeline if applicable"
+    }
+  ],
+  "doc": "Status about a DataHub Action Pipeline\nThis combines status from all the three stages of the pipeline - bootstrap, live and rollback"
+}