azure.purview.catalog.rest.relationship package¶
-
azure.purview.catalog.rest.relationship.
build_create_request
(*, json: Any = None, content: Any = None, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶ Create a new relationship between entities.
See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.
- Keyword Arguments
json (Any) – The AtlasRelationship object containing the information for the relationship to be created.
content (Any) – The AtlasRelationship object containing the information for the relationship to be created.
- 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
Example
# JSON input template you can fill out and use as your `json` input. json = { "createTime": "float (optional)", "createdBy": "str (optional)", "end1": { "guid": "str (optional)", "typeName": "str (optional)", "uniqueAttributes": { "str": "object (optional)" } }, "end2": { "guid": "str (optional)", "typeName": "str (optional)", "uniqueAttributes": { "str": "object (optional)" } }, "guid": "str (optional)", "homeId": "str (optional)", "label": "str (optional)", "provenanceType": "float (optional)", "status": "str (optional)", "updateTime": "float (optional)", "updatedBy": "str (optional)", "version": "float (optional)" } # response body for status code(s): 200 response_body == { "createTime": "float (optional)", "createdBy": "str (optional)", "end1": { "guid": "str (optional)", "typeName": "str (optional)", "uniqueAttributes": { "str": "object (optional)" } }, "end2": { "guid": "str (optional)", "typeName": "str (optional)", "uniqueAttributes": { "str": "object (optional)" } }, "guid": "str (optional)", "homeId": "str (optional)", "label": "str (optional)", "provenanceType": "float (optional)", "status": "str (optional)", "updateTime": "float (optional)", "updatedBy": "str (optional)", "version": "float (optional)" }
-
azure.purview.catalog.rest.relationship.
build_update_request
(*, json: Any = None, content: Any = None, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶ Update an existing relationship between entities.
See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.
- Keyword Arguments
json (Any) – The AtlasRelationship object containing the information for the relationship to be created.
content (Any) – The AtlasRelationship object containing the information for the relationship to be created.
- 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
Example
# JSON input template you can fill out and use as your `json` input. json = { "createTime": "float (optional)", "createdBy": "str (optional)", "end1": { "guid": "str (optional)", "typeName": "str (optional)", "uniqueAttributes": { "str": "object (optional)" } }, "end2": { "guid": "str (optional)", "typeName": "str (optional)", "uniqueAttributes": { "str": "object (optional)" } }, "guid": "str (optional)", "homeId": "str (optional)", "label": "str (optional)", "provenanceType": "float (optional)", "status": "str (optional)", "updateTime": "float (optional)", "updatedBy": "str (optional)", "version": "float (optional)" } # response body for status code(s): 200 response_body == { "createTime": "float (optional)", "createdBy": "str (optional)", "end1": { "guid": "str (optional)", "typeName": "str (optional)", "uniqueAttributes": { "str": "object (optional)" } }, "end2": { "guid": "str (optional)", "typeName": "str (optional)", "uniqueAttributes": { "str": "object (optional)" } }, "guid": "str (optional)", "homeId": "str (optional)", "label": "str (optional)", "provenanceType": "float (optional)", "status": "str (optional)", "updateTime": "float (optional)", "updatedBy": "str (optional)", "version": "float (optional)" }
-
azure.purview.catalog.rest.relationship.
build_get_request
(guid: str, *, extended_info: Optional[bool] = None, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶ Get relationship information between entities by its 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 relationship.
- Keyword Arguments
extended_info (bool) – Limits whether includes extended information.
- 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
Example
# response body for status code(s): 200 response_body == { "referredEntities": { "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)" } }, "relationship": { "createTime": "float (optional)", "createdBy": "str (optional)", "end1": { "guid": "str (optional)", "typeName": "str (optional)", "uniqueAttributes": { "str": "object (optional)" } }, "end2": { "guid": "str (optional)", "typeName": "str (optional)", "uniqueAttributes": { "str": "object (optional)" } }, "guid": "str (optional)", "homeId": "str (optional)", "label": "str (optional)", "provenanceType": "float (optional)", "status": "str (optional)", "updateTime": "float (optional)", "updatedBy": "str (optional)", "version": "float (optional)" } }
-
azure.purview.catalog.rest.relationship.
build_delete_request
(guid: str, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]¶ Delete a relationship between entities by its 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 relationship.
- 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