Class LineageClient
- java.lang.Object
-
- com.azure.analytics.purview.catalog.LineageClient
-
public final class LineageClient extends Object
Initializes a new instance of the synchronous PurviewCatalogClient type.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>
getLineageGraphWithResponse(String guid, com.azure.core.http.rest.RequestOptions requestOptions)
Get lineage info of the entity specified by GUID.com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>
nextPageLineageWithResponse(String guid, com.azure.core.http.rest.RequestOptions requestOptions)
Return immediate next page lineage info about entity with pagination.
-
-
-
Method Detail
-
getLineageGraphWithResponse
public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getLineageGraphWithResponse(String guid, com.azure.core.http.rest.RequestOptions requestOptions)
Get lineage info of the entity specified by GUID.Query Parameters
Query Parameters Name Type Required Description depth String No The number of hops for lineage. width String No The number of max expanding width in lineage. direction String Yes The direction of the lineage, which could be INPUT, OUTPUT or BOTH. includeParent String No True to include the parent chain in the response. getDerivedLineage String No True to include derived lineage in the response Response Body Schema
{ baseEntityGuid: String guidEntityMap: { String: { attributes: { String: Object } typeName: String lastModifiedTS: String classificationNames: [ String ] classifications: [ { attributes: { String: Object } typeName: String lastModifiedTS: String entityGuid: String entityStatus: String(ACTIVE/DELETED) removePropagationsOnEntityDelete: Boolean validityPeriods: [ { endTime: String startTime: String timeZone: String } ] source: String sourceDetails: { String: Object } } ] displayText: String guid: String meaningNames: [ String ] meanings: [ { confidence: Integer createdBy: String description: String displayText: String expression: String relationGuid: String source: String status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) steward: String termGuid: String } ] status: String(ACTIVE/DELETED) } } widthCounts: { String: { String: Object } } lineageDepth: Integer lineageWidth: Integer includeParent: Boolean childrenCount: Integer lineageDirection: String(INPUT/OUTPUT/BOTH) parentRelations: [ { childEntityId: String relationshipId: String parentEntityId: String } ] relations: [ { fromEntityId: String relationshipId: String toEntityId: String } ] }
- Parameters:
guid
- The globally unique identifier of the entity.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- lineage info of the entity specified by GUID along with
Response
. - Throws:
com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.com.azure.core.exception.ClientAuthenticationException
- thrown if the request is rejected by server on status code 401.com.azure.core.exception.ResourceNotFoundException
- thrown if the request is rejected by server on status code 404.com.azure.core.exception.ResourceModifiedException
- thrown if the request is rejected by server on status code 409.
-
nextPageLineageWithResponse
public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> nextPageLineageWithResponse(String guid, com.azure.core.http.rest.RequestOptions requestOptions)
Return immediate next page lineage info about entity with pagination.Query Parameters
Query Parameters Name Type Required Description direction String Yes The direction of the lineage, which could be INPUT, OUTPUT or BOTH. getDerivedLineage String No True to include derived lineage in the response offset String No The offset for pagination purpose. limit String No The page size - by default there is no paging. api-version String Yes Api Version Response Body Schema
{ baseEntityGuid: String guidEntityMap: { String: { attributes: { String: Object } typeName: String lastModifiedTS: String classificationNames: [ String ] classifications: [ { attributes: { String: Object } typeName: String lastModifiedTS: String entityGuid: String entityStatus: String(ACTIVE/DELETED) removePropagationsOnEntityDelete: Boolean validityPeriods: [ { endTime: String startTime: String timeZone: String } ] source: String sourceDetails: { String: Object } } ] displayText: String guid: String meaningNames: [ String ] meanings: [ { confidence: Integer createdBy: String description: String displayText: String expression: String relationGuid: String source: String status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) steward: String termGuid: String } ] status: String(ACTIVE/DELETED) } } widthCounts: { String: { String: Object } } lineageDepth: Integer lineageWidth: Integer includeParent: Boolean childrenCount: Integer lineageDirection: String(INPUT/OUTPUT/BOTH) parentRelations: [ { childEntityId: String relationshipId: String parentEntityId: String } ] relations: [ { fromEntityId: String relationshipId: String toEntityId: String } ] }
- Parameters:
guid
- The globally unique identifier of the entity.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- atlasLineageInfo along with
Response
. - Throws:
com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.com.azure.core.exception.ClientAuthenticationException
- thrown if the request is rejected by server on status code 401.com.azure.core.exception.ResourceNotFoundException
- thrown if the request is rejected by server on status code 404.com.azure.core.exception.ResourceModifiedException
- thrown if the request is rejected by server on status code 409.
-
-