acryl-datahub-cloud 0.3.8rc4__py3-none-any.whl → 0.3.8rc6__py3-none-any.whl

acryl_datahub_cloud/metadata/schemas/IncidentInfo.avsc

@@ -1,376 +0,0 @@
-{
-  "type": "record",
-  "Aspect": {
-    "name": "incidentInfo"
-  },
-  "name": "IncidentInfo",
-  "namespace": "com.linkedin.pegasus2avro.incident",
-  "fields": [
-    {
-      "Searchable": {
-        "addToFilters": true,
-        "filterNameOverride": "Type"
-      },
-      "type": {
-        "type": "enum",
-        "symbolDocs": {
-          "CUSTOM": "A custom type of incident",
-          "DATASET_COLUMN": "An assertion on a particular column(s) of a Dataset has triggered the incident.\nRaised on Datasets where assertions are configured to generate incidents.\nDeprecated! Use FIELD instead. Will be removed.",
-          "DATASET_ROWS": "An assertion on the row count of a Dataset has triggered the incident.\nRaised on datasets where assertions are configured to generate incidents.\nDeprecated! Use VOLUME instead. Will be removed.",
-          "DATA_SCHEMA": "A Data Schema assertion has failed, triggering the incident.\nRaised on entities where assertions are configured to generate incidents.",
-          "FIELD": "A Field Assertion has failed, triggering the incident.\nRaised on entities where assertions are configured to generate incidents.",
-          "FRESHNESS": "An Freshness Assertion has failed, triggering the incident.\nRaised on entities where assertions are configured to generate incidents.",
-          "OPERATIONAL": "A misc. operational incident, e.g. failure to materialize a dataset.",
-          "SQL": "A raw SQL-statement based assertion has failed, triggering the incident.\nRaised on entities where assertions are configured to generate incidents.",
-          "VOLUME": "An Volume Assertion has failed, triggering the incident.\nRaised on entities where assertions are configured to generate incidents."
-        },
-        "deprecatedSymbols": {
-          "DATASET_COLUMN": true,
-          "DATASET_ROWS": true
-        },
-        "name": "IncidentType",
-        "namespace": "com.linkedin.pegasus2avro.incident",
-        "symbols": [
-          "FRESHNESS",
-          "VOLUME",
-          "FIELD",
-          "SQL",
-          "DATA_SCHEMA",
-          "OPERATIONAL",
-          "CUSTOM",
-          "DATASET_COLUMN",
-          "DATASET_ROWS"
-        ],
-        "doc": "A type of asset incident"
-      },
-      "name": "type",
-      "doc": "The type of incident"
-    },
-    {
-      "Searchable": {
-        "addToFilters": true,
-        "filterNameOverride": "Other Type"
-      },
-      "type": [
-        "null",
-        "string"
-      ],
-      "name": "customType",
-      "default": null,
-      "doc": "An optional custom incident type. Present only if type is 'CUSTOM'."
-    },
-    {
-      "Searchable": {
-        "boostScore": 10.0,
-        "fieldType": "WORD_GRAM"
-      },
-      "type": [
-        "null",
-        "string"
-      ],
-      "name": "title",
-      "default": null,
-      "doc": "Optional title associated with the incident"
-    },
-    {
-      "Searchable": {
-        "fieldType": "TEXT"
-      },
-      "type": [
-        "null",
-        "string"
-      ],
-      "name": "description",
-      "default": null,
-      "doc": "Optional description associated with the incident"
-    },
-    {
-      "Relationship": {
-        "/*": {
-          "entityTypes": [
-            "dataset",
-            "chart",
-            "dashboard",
-            "dataFlow",
-            "dataJob",
-            "schemaField",
-            "mlModel",
-            "mlFeature"
-          ],
-          "name": "IncidentOn"
-        }
-      },
-      "Searchable": {
-        "/*": {
-          "fieldType": "URN"
-        }
-      },
-      "type": {
-        "type": "array",
-        "items": "string"
-      },
-      "name": "entities",
-      "doc": "A reference to the entity associated with the incident.",
-      "Urn": "Urn",
-      "urn_is_array": true
-    },
-    {
-      "Searchable": {
-        "addToFilters": true,
-        "filterNameOverride": "Priority"
-      },
-      "type": [
-        "int",
-        "null"
-      ],
-      "name": "priority",
-      "default": 0,
-      "doc": "A numeric severity or priority for the incident. On the UI we will translate this into something easy to understand.\nCurrently supported: 0 - CRITICAL, 1 - HIGH, 2 - MED, 3 - LOW\n(We probably should have modeled as an enum)"
-    },
-    {
-      "type": [
-        "null",
-        {
-          "type": "array",
-          "items": {
-            "type": "record",
-            "name": "IncidentAssignee",
-            "namespace": "com.linkedin.pegasus2avro.incident",
-            "fields": [
-              {
-                "Searchable": {
-                  "addToFilters": true,
-                  "fieldName": "assignees",
-                  "filterNameOverride": "Assignee"
-                },
-                "java": {
-                  "class": "com.linkedin.pegasus2avro.common.urn.Urn"
-                },
-                "type": "string",
-                "name": "actor",
-                "doc": "The user or group assigned to the incident.",
-                "Urn": "Urn"
-              },
-              {
-                "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": "assignedAt",
-                "doc": "The time & actor responsible for assiging the assignee."
-              }
-            ],
-            "doc": "The incident assignee type.\nThis is in a record so that we can add additional fields if we need to later (e.g.\nthe type of the assignee."
-          }
-        }
-      ],
-      "name": "assignees",
-      "default": null,
-      "doc": "The parties assigned with resolving the incident"
-    },
-    {
-      "type": {
-        "type": "record",
-        "name": "IncidentStatus",
-        "namespace": "com.linkedin.pegasus2avro.incident",
-        "fields": [
-          {
-            "Searchable": {
-              "addToFilters": true,
-              "filterNameOverride": "Status"
-            },
-            "type": {
-              "type": "enum",
-              "symbolDocs": {
-                "ACTIVE": "The incident is ongoing, or active.",
-                "RESOLVED": "The incident is resolved."
-              },
-              "name": "IncidentState",
-              "namespace": "com.linkedin.pegasus2avro.incident",
-              "symbols": [
-                "ACTIVE",
-                "RESOLVED"
-              ]
-            },
-            "name": "state",
-            "doc": "The top-level state of the incident, whether it's active or resolved."
-          },
-          {
-            "Searchable": {
-              "addToFilters": true,
-              "filterNameOverride": "Stage"
-            },
-            "type": [
-              "null",
-              {
-                "type": "enum",
-                "symbolDocs": {
-                  "FIXED": "The incident is in the resolved as completed stage.",
-                  "INVESTIGATION": "The incident root cause is being investigated.",
-                  "NO_ACTION_REQUIRED": "The incident is in the resolved with no action required state, e.g. the\nincident was a false positive, or was expected.",
-                  "TRIAGE": "The impact and priority of the incident is being actively assessed.",
-                  "WORK_IN_PROGRESS": "The incident is in the remediation stage."
-                },
-                "name": "IncidentStage",
-                "namespace": "com.linkedin.pegasus2avro.incident",
-                "symbols": [
-                  "TRIAGE",
-                  "INVESTIGATION",
-                  "WORK_IN_PROGRESS",
-                  "FIXED",
-                  "NO_ACTION_REQUIRED"
-                ]
-              }
-            ],
-            "name": "stage",
-            "default": null,
-            "doc": "The lifecycle stage for the incident - Null means no stage was assigned yet.\nIn the future, we may add CUSTOM here with a customStage string field for user-defined stages."
-          },
-          {
-            "type": [
-              "null",
-              "string"
-            ],
-            "name": "message",
-            "default": null,
-            "doc": "Optional message associated with the incident"
-          },
-          {
-            "Searchable": {
-              "/time": {
-                "fieldName": "lastUpdated",
-                "fieldType": "COUNT"
-              }
-            },
-            "type": "com.linkedin.pegasus2avro.common.AuditStamp",
-            "name": "lastUpdated",
-            "doc": "The time at which the request was initially created"
-          }
-        ],
-        "doc": "Information about an incident raised on an asset"
-      },
-      "name": "status",
-      "doc": "The current status of an incident, i.e. active or inactive."
-    },
-    {
-      "type": [
-        "null",
-        {
-          "type": "record",
-          "Aspect": {
-            "name": "incidentSource"
-          },
-          "name": "IncidentSource",
-          "namespace": "com.linkedin.pegasus2avro.incident",
-          "fields": [
-            {
-              "Searchable": {
-                "addToFilters": true,
-                "filterNameOverride": "Source"
-              },
-              "type": {
-                "type": "enum",
-                "symbolDocs": {
-                  "ASSERTION_FAILURE": "An assertion has failed, triggering the incident.",
-                  "MANUAL": "Manually created incident, via UI or API."
-                },
-                "name": "IncidentSourceType",
-                "namespace": "com.linkedin.pegasus2avro.incident",
-                "symbols": [
-                  "MANUAL",
-                  "ASSERTION_FAILURE"
-                ]
-              },
-              "name": "type",
-              "doc": "Message associated with the incident"
-            },
-            {
-              "Searchable": {
-                "fieldType": "URN"
-              },
-              "java": {
-                "class": "com.linkedin.pegasus2avro.common.urn.Urn"
-              },
-              "type": [
-                "null",
-                "string"
-              ],
-              "name": "sourceUrn",
-              "default": null,
-              "doc": "Reference to an URN related to the source of an incident. Currently populated when the type of the incident\nis ASSERTION_FAILURE.\n\nIf this incident was raised due to an assertion failure, then this will contain the urn of the source Assertion.",
-              "Urn": "Urn"
-            }
-          ],
-          "doc": "Information about the source of an incident raised on an asset."
-        }
-      ],
-      "name": "source",
-      "default": null,
-      "doc": "The source of an incident, i.e. how it was generated."
-    },
-    {
-      "Searchable": {
-        "fieldType": "COUNT"
-      },
-      "type": [
-        "null",
-        "long"
-      ],
-      "name": "startedAt",
-      "default": null,
-      "doc": "The time at which the incident actually started (may be before the date it was raised)."
-    },
-    {
-      "Searchable": {
-        "/time": {
-          "fieldName": "created",
-          "fieldType": "COUNT"
-        }
-      },
-      "type": "com.linkedin.pegasus2avro.common.AuditStamp",
-      "name": "created",
-      "doc": "The time at which the request was initially created"
-    }
-  ],
-  "doc": "Information about an incident raised on an asset.\n\nNOTE: When this file is changed, update IncidentActivityEvent.pdl to remove searchable and relationship annotations."
-}

acryl_datahub_cloud/metadata/schemas/IncidentKey.avsc

@@ -1,25 +0,0 @@
-{
-  "type": "record",
-  "Aspect": {
-    "name": "incidentKey",
-    "keyForEntity": "incident",
-    "entityCategory": "core",
-    "entityAspects": [
-      "incidentInfo",
-      "globalTags",
-      "incidentNotificationDetails",
-      "incidentActivityEvent"
-    ],
-    "entityDoc": "An incident for an asset."
-  },
-  "name": "IncidentKey",
-  "namespace": "com.linkedin.pegasus2avro.metadata.key",
-  "fields": [
-    {
-      "type": "string",
-      "name": "id",
-      "doc": "A unique id for the incident. Generated on the server side at incident creation time."
-    }
-  ],
-  "doc": "Key for an asset Incident"
-}

acryl_datahub_cloud/metadata/schemas/IncidentNotificationDetails.avsc

@@ -1,62 +0,0 @@
-{
-  "type": "record",
-  "Aspect": {
-    "name": "incidentNotificationDetails"
-  },
-  "name": "IncidentNotificationDetails",
-  "namespace": "com.linkedin.pegasus2avro.incident",
-  "fields": [
-    {
-      "type": [
-        "null",
-        {
-          "type": "record",
-          "name": "SlackIncidentDetails",
-          "namespace": "com.linkedin.pegasus2avro.incident",
-          "fields": [
-            {
-              "type": {
-                "type": "array",
-                "items": {
-                  "type": "record",
-                  "name": "SlackMessageDetails",
-                  "namespace": "com.linkedin.pegasus2avro.incident",
-                  "fields": [
-                    {
-                      "type": "string",
-                      "name": "channelId",
-                      "doc": "The original Slack channel id or user id associated with the incident message."
-                    },
-                    {
-                      "type": [
-                        "null",
-                        "string"
-                      ],
-                      "name": "channelName",
-                      "default": null,
-                      "doc": "The human-readable channel name associated with the incident message.\nThis is attempted to be resolved by the integrations service.\n\nIf it cannot be found, it will be left empty."
-                    },
-                    {
-                      "type": "string",
-                      "name": "messageId",
-                      "doc": "The Slack message id associated with the incident."
-                    }
-                  ],
-                  "doc": "Slack-specific message that contains the incident information.\nNote that we will NOT capture slack message details\nfor DMs.\nThis object will be created by the integrations service once a\nnotification message about an incident is posted to a specific channel."
-                }
-              },
-              "name": "messages",
-              "default": [],
-              "doc": "The Slack messages that contain the incident information"
-            }
-          ],
-          "doc": "Slack-specific details about incident notifications"
-        }
-      ],
-      "name": "slack",
-      "default": null,
-      "doc": "Details related to Slack."
-    }
-  ],
-  "doc": "Information about the notification context for an incident (where we notified)"
-}

acryl_datahub_cloud/metadata/schemas/IncidentSource.avsc

@@ -1,48 +0,0 @@
-{
-  "type": "record",
-  "Aspect": {
-    "name": "incidentSource"
-  },
-  "name": "IncidentSource",
-  "namespace": "com.linkedin.pegasus2avro.incident",
-  "fields": [
-    {
-      "Searchable": {
-        "addToFilters": true,
-        "filterNameOverride": "Source"
-      },
-      "type": {
-        "type": "enum",
-        "symbolDocs": {
-          "ASSERTION_FAILURE": "An assertion has failed, triggering the incident.",
-          "MANUAL": "Manually created incident, via UI or API."
-        },
-        "name": "IncidentSourceType",
-        "namespace": "com.linkedin.pegasus2avro.incident",
-        "symbols": [
-          "MANUAL",
-          "ASSERTION_FAILURE"
-        ]
-      },
-      "name": "type",
-      "doc": "Message associated with the incident"
-    },
-    {
-      "Searchable": {
-        "fieldType": "URN"
-      },
-      "java": {
-        "class": "com.linkedin.pegasus2avro.common.urn.Urn"
-      },
-      "type": [
-        "null",
-        "string"
-      ],
-      "name": "sourceUrn",
-      "default": null,
-      "doc": "Reference to an URN related to the source of an incident. Currently populated when the type of the incident\nis ASSERTION_FAILURE.\n\nIf this incident was raised due to an assertion failure, then this will contain the urn of the source Assertion.",
-      "Urn": "Urn"
-    }
-  ],
-  "doc": "Information about the source of an incident raised on an asset."
-}

acryl_datahub_cloud/metadata/schemas/IncidentsSummary.avsc

@@ -1,160 +0,0 @@
-{
-  "type": "record",
-  "Aspect": {
-    "name": "incidentsSummary"
-  },
-  "name": "IncidentsSummary",
-  "namespace": "com.linkedin.pegasus2avro.common",
-  "fields": [
-    {
-      "deprecated": true,
-      "type": {
-        "type": "array",
-        "items": "string"
-      },
-      "name": "resolvedIncidents",
-      "default": [],
-      "doc": "Resolved incidents for an asset\nDeprecated! Use the richer resolvedIncidentsDetails instead.",
-      "Urn": "Urn",
-      "urn_is_array": true
-    },
-    {
-      "deprecated": true,
-      "type": {
-        "type": "array",
-        "items": "string"
-      },
-      "name": "activeIncidents",
-      "default": [],
-      "doc": "Active incidents for an asset\nDeprecated! Use the richer activeIncidentsDetails instead.",
-      "Urn": "Urn",
-      "urn_is_array": true
-    },
-    {
-      "Relationship": {
-        "/*/urn": {
-          "entityTypes": [
-            "incident"
-          ],
-          "name": "ResolvedIncidents"
-        }
-      },
-      "Searchable": {
-        "/*/createdAt": {
-          "fieldName": "resolvedIncidentCreatedTimes",
-          "fieldType": "DATETIME"
-        },
-        "/*/priority": {
-          "fieldName": "resolvedIncidentPriorities",
-          "fieldType": "COUNT"
-        },
-        "/*/resolvedAt": {
-          "fieldName": "resolvedIncidentResolvedTimes",
-          "fieldType": "DATETIME"
-        },
-        "/*/type": {
-          "fieldName": "resolvedIncidentTypes",
-          "fieldType": "KEYWORD"
-        },
-        "/*/urn": {
-          "fieldName": "resolvedIncidents",
-          "fieldType": "URN",
-          "hasValuesFieldName": "hasResolvedIncidents",
-          "numValuesFieldName": "numResolvedIncidents",
-          "queryByDefault": false
-        }
-      },
-      "type": {
-        "type": "array",
-        "items": {
-          "type": "record",
-          "name": "IncidentSummaryDetails",
-          "namespace": "com.linkedin.pegasus2avro.common",
-          "fields": [
-            {
-              "java": {
-                "class": "com.linkedin.pegasus2avro.common.urn.Urn"
-              },
-              "type": "string",
-              "name": "urn",
-              "doc": "The urn of the incident",
-              "Urn": "Urn"
-            },
-            {
-              "type": "string",
-              "name": "type",
-              "doc": "The type of an incident"
-            },
-            {
-              "type": "long",
-              "name": "createdAt",
-              "doc": "The time at which the incident was raised in milliseconds since epoch."
-            },
-            {
-              "type": [
-                "null",
-                "long"
-              ],
-              "name": "resolvedAt",
-              "default": null,
-              "doc": "The time at which the incident was marked as resolved in milliseconds since epoch. Null if the incident is still active."
-            },
-            {
-              "type": [
-                "null",
-                "int"
-              ],
-              "name": "priority",
-              "default": null,
-              "doc": "The priority of the incident"
-            }
-          ],
-          "doc": "Summary statistics about incidents on an entity."
-        }
-      },
-      "name": "resolvedIncidentDetails",
-      "default": [],
-      "doc": "Summary details about the set of resolved incidents"
-    },
-    {
-      "Relationship": {
-        "/*/urn": {
-          "entityTypes": [
-            "incident"
-          ],
-          "name": "ActiveIncidents"
-        }
-      },
-      "Searchable": {
-        "/*/createdAt": {
-          "fieldName": "activeIncidentCreatedTimes",
-          "fieldType": "DATETIME"
-        },
-        "/*/priority": {
-          "fieldName": "activeIncidentPriorities",
-          "fieldType": "COUNT"
-        },
-        "/*/type": {
-          "fieldName": "activeIncidentTypes",
-          "fieldType": "KEYWORD"
-        },
-        "/*/urn": {
-          "addHasValuesToFilters": true,
-          "fieldName": "activeIncidents",
-          "fieldType": "URN",
-          "hasValuesFieldName": "hasActiveIncidents",
-          "numValuesFieldName": "numActiveIncidents",
-          "queryByDefault": false
-        }
-      },
-      "type": {
-        "type": "array",
-        "items": "com.linkedin.pegasus2avro.common.IncidentSummaryDetails"
-      },
-      "name": "activeIncidentDetails",
-      "default": [],
-      "doc": "Summary details about the set of active incidents"
-    }
-  ],
-  "doc": "Summary related incidents on an entity."
-}