azure.purview.catalog.rest package¶

azure.purview.catalog.rest.build_get_lineage_graph_request(guid: str, *, direction: Union[str, _models.Direction], depth: Optional[int] = 3, width: Optional[int] = 10, include_parent: Optional[bool] = None, get_derived_lineage: Optional[bool] = None, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Get lineage info of the entity specified by GUID.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

guid (str) – The globally unique identifier of the entity.

Keyword Arguments

direction (str or Direction) – The direction of the lineage, which could be INPUT, OUTPUT or BOTH.
depth (int) – The number of hops for lineage.
width (int) – The number of max expanding width in lineage.
include_parent (bool) – True to include the parent chain in the response.
get_derived_lineage (bool) – True to include derived lineage in the response.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# response body for status code(s): 200
response_body == {
    "baseEntityGuid": "str (optional)",
    "childrenCount": "int (optional)",
    "guidEntityMap": {
        "str": {
            "classificationNames": [
                "str (optional)"
            ],
            "classifications": [
                {
                    "entityGuid": "str (optional)",
                    "entityStatus": "str (optional)",
                    "removePropagationsOnEntityDelete": "bool (optional)",
                    "source": "str (optional)",
                    "sourceDetails": {
                        "str": "object (optional)"
                    },
                    "validityPeriods": [
                        {
                            "endTime": "str (optional)",
                            "startTime": "str (optional)",
                            "timeZone": "str (optional)"
                        }
                    ]
                }
            ],
            "displayText": "str (optional)",
            "guid": "str (optional)",
            "meaningNames": [
                "str (optional)"
            ],
            "meanings": [
                {
                    "confidence": "int (optional)",
                    "createdBy": "str (optional)",
                    "description": "str (optional)",
                    "displayText": "str (optional)",
                    "expression": "str (optional)",
                    "relationGuid": "str (optional)",
                    "source": "str (optional)",
                    "status": "str (optional)",
                    "steward": "str (optional)",
                    "termGuid": "str (optional)"
                }
            ],
            "status": "str (optional)"
        }
    },
    "includeParent": "bool (optional)",
    "lineageDepth": "int (optional)",
    "lineageDirection": "str (optional)",
    "lineageWidth": "int (optional)",
    "parentRelations": [
        {
            "childEntityId": "str (optional)",
            "parentEntityId": "str (optional)",
            "relationshipId": "str (optional)"
        }
    ],
    "relations": [
        {
            "fromEntityId": "str (optional)",
            "relationshipId": "str (optional)",
            "toEntityId": "str (optional)"
        }
    ],
    "widthCounts": {
        "str": {
            "str": "object (optional)"
        }
    }
}

azure.purview.catalog.rest.build_next_page_lineage_request(guid: str, *, direction: Union[str, _models.Direction], get_derived_lineage: Optional[bool] = None, offset: Optional[int] = None, limit: Optional[int] = None, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶

Return immediate next page lineage info about entity with pagination.