Package com.azure.analytics.purview.datamap

Class LineageClient

java.lang.Object

com.azure.analytics.purview.datamap.LineageClient

public final class LineageClient
extends Object

Initializes a new instance of the synchronous DataMapClient type.

Method Summary

Modifier and Type	Method	Description
AtlasLineageInfo	get(String guid, LineageDirection direction)	Get lineage info of the entity specified by GUID.
AtlasLineageInfo	get(String guid, LineageDirection direction, Integer depth)	Get lineage info of the entity specified by GUID.
AtlasLineageInfo	getByUniqueAttribute(String typeName, LineageDirection direction)	Return lineage info about entity.
AtlasLineageInfo	getByUniqueAttribute(String typeName, LineageDirection direction, Integer depth, String attribute)	Return lineage info about entity.
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	getByUniqueAttributeWithResponse(String typeName, String direction, com.azure.core.http.rest.RequestOptions requestOptions)	Return lineage info about entity.
AtlasLineageInfo	getNextPage(String guid, LineageDirection direction)	Return immediate next page lineage info about entity with pagination.
AtlasLineageInfo	getNextPage(String guid, LineageDirection direction, Integer offset, Integer limit)	Return immediate next page lineage info about entity with pagination.
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	getNextPageWithResponse(String guid, String direction, com.azure.core.http.rest.RequestOptions requestOptions)	Return immediate next page lineage info about entity with pagination.
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	getWithResponse(String guid, String direction, com.azure.core.http.rest.RequestOptions requestOptions)	Get lineage info of the entity specified by GUID.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getWithResponse(String guid,
 String direction,
 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	Integer	No	The number of hops for lineage.

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Response Body Schema

 
 {
     baseEntityGuid: String (Optional)
     guidEntityMap (Optional): {
         String (Required): {
             attributes (Optional): {
                 String: BinaryData (Required)
             }
             typeName: String (Optional)
             lastModifiedTS: String (Optional)
             classificationNames (Optional): [
                 String (Optional)
             ]
             classifications (Optional): [
                  (Optional){
                     attributes (Optional): {
                         String: BinaryData (Required)
                     }
                     typeName: String (Optional)
                     lastModifiedTS: String (Optional)
                     entityGuid: String (Optional)
                     entityStatus: String(ACTIVE/DELETED) (Optional)
                     removePropagationsOnEntityDelete: Boolean (Optional)
                     validityPeriods (Optional): [
                          (Optional){
                             endTime: String (Optional)
                             startTime: String (Optional)
                             timeZone: String (Optional)
                         }
                     ]
                 }
             ]
             displayText: String (Optional)
             guid: String (Optional)
             isIncomplete: Boolean (Optional)
             labels (Optional): [
                 String (Optional)
             ]
             meaningNames (Optional): [
                 String (Optional)
             ]
             meanings (Optional): [
                  (Optional){
                     confidence: Integer (Optional)
                     createdBy: String (Optional)
                     description: String (Optional)
                     displayText: String (Optional)
                     expression: String (Optional)
                     relationGuid: String (Optional)
                     status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) (Optional)
                     steward: String (Optional)
                     termGuid: String (Optional)
                 }
             ]
             status: String(ACTIVE/DELETED) (Optional)
         }
     }
     widthCounts (Optional): {
         String (Required): {
             String: BinaryData (Required)
         }
     }
     lineageDepth: Integer (Optional)
     lineageWidth: Integer (Optional)
     childrenCount: Integer (Optional)
     lineageDirection: String(INPUT/OUTPUT/BOTH) (Optional)
     parentRelations (Optional): [
          (Optional){
             childEntityId: String (Optional)
             relationshipId: String (Optional)
             parentEntityId: String (Optional)
         }
     ]
     relations (Optional): [
          (Optional){
             fromEntityId: String (Optional)
             relationshipId: String (Optional)
             toEntityId: String (Optional)
         }
     ]
 }
 
 

Parameters:

guid - The globally unique identifier of the entity.

direction - The direction of the lineage, which could be INPUT, OUTPUT or BOTH. Allowed values: "INPUT", "OUTPUT", "BOTH".

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.

getNextPageWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getNextPageWithResponse(String guid,
 String direction,
 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
offset	Integer	No	The offset for pagination purpose.
limit	Integer	No	The page size - by default there is no paging.

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Response Body Schema

 
 {
     baseEntityGuid: String (Optional)
     guidEntityMap (Optional): {
         String (Required): {
             attributes (Optional): {
                 String: BinaryData (Required)
             }
             typeName: String (Optional)
             lastModifiedTS: String (Optional)
             classificationNames (Optional): [
                 String (Optional)
             ]
             classifications (Optional): [
                  (Optional){
                     attributes (Optional): {
                         String: BinaryData (Required)
                     }
                     typeName: String (Optional)
                     lastModifiedTS: String (Optional)
                     entityGuid: String (Optional)
                     entityStatus: String(ACTIVE/DELETED) (Optional)
                     removePropagationsOnEntityDelete: Boolean (Optional)
                     validityPeriods (Optional): [
                          (Optional){
                             endTime: String (Optional)
                             startTime: String (Optional)
                             timeZone: String (Optional)
                         }
                     ]
                 }
             ]
             displayText: String (Optional)
             guid: String (Optional)
             isIncomplete: Boolean (Optional)
             labels (Optional): [
                 String (Optional)
             ]
             meaningNames (Optional): [
                 String (Optional)
             ]
             meanings (Optional): [
                  (Optional){
                     confidence: Integer (Optional)
                     createdBy: String (Optional)
                     description: String (Optional)
                     displayText: String (Optional)
                     expression: String (Optional)
                     relationGuid: String (Optional)
                     status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) (Optional)
                     steward: String (Optional)
                     termGuid: String (Optional)
                 }
             ]
             status: String(ACTIVE/DELETED) (Optional)
         }
     }
     widthCounts (Optional): {
         String (Required): {
             String: BinaryData (Required)
         }
     }
     lineageDepth: Integer (Optional)
     lineageWidth: Integer (Optional)
     childrenCount: Integer (Optional)
     lineageDirection: String(INPUT/OUTPUT/BOTH) (Optional)
     parentRelations (Optional): [
          (Optional){
             childEntityId: String (Optional)
             relationshipId: String (Optional)
             parentEntityId: String (Optional)
         }
     ]
     relations (Optional): [
          (Optional){
             fromEntityId: String (Optional)
             relationshipId: String (Optional)
             toEntityId: String (Optional)
         }
     ]
 }
 
 

Parameters:

guid - The globally unique identifier of the entity.

direction - The direction of the lineage, which could be INPUT, OUTPUT or BOTH. Allowed values: "INPUT", "OUTPUT", "BOTH".

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the lineage information 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.

getByUniqueAttributeWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getByUniqueAttributeWithResponse(String typeName,
 String direction,
 com.azure.core.http.rest.RequestOptions requestOptions)

Return lineage info about entity. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format attr:[attrName]=[attrValue] NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: GET /v2/lineage/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.

Query Parameters

Query Parameters

Name	Type	Required	Description
depth	Integer	No	The number of hops for lineage.
attr:qualifiedName	String	No	The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Response Body Schema

 
 {
     baseEntityGuid: String (Optional)
     guidEntityMap (Optional): {
         String (Required): {
             attributes (Optional): {
                 String: BinaryData (Required)
             }
             typeName: String (Optional)
             lastModifiedTS: String (Optional)
             classificationNames (Optional): [
                 String (Optional)
             ]
             classifications (Optional): [
                  (Optional){
                     attributes (Optional): {
                         String: BinaryData (Required)
                     }
                     typeName: String (Optional)
                     lastModifiedTS: String (Optional)
                     entityGuid: String (Optional)
                     entityStatus: String(ACTIVE/DELETED) (Optional)
                     removePropagationsOnEntityDelete: Boolean (Optional)
                     validityPeriods (Optional): [
                          (Optional){
                             endTime: String (Optional)
                             startTime: String (Optional)
                             timeZone: String (Optional)
                         }
                     ]
                 }
             ]
             displayText: String (Optional)
             guid: String (Optional)
             isIncomplete: Boolean (Optional)
             labels (Optional): [
                 String (Optional)
             ]
             meaningNames (Optional): [
                 String (Optional)
             ]
             meanings (Optional): [
                  (Optional){
                     confidence: Integer (Optional)
                     createdBy: String (Optional)
                     description: String (Optional)
                     displayText: String (Optional)
                     expression: String (Optional)
                     relationGuid: String (Optional)
                     status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) (Optional)
                     steward: String (Optional)
                     termGuid: String (Optional)
                 }
             ]
             status: String(ACTIVE/DELETED) (Optional)
         }
     }
     widthCounts (Optional): {
         String (Required): {
             String: BinaryData (Required)
         }
     }
     lineageDepth: Integer (Optional)
     lineageWidth: Integer (Optional)
     childrenCount: Integer (Optional)
     lineageDirection: String(INPUT/OUTPUT/BOTH) (Optional)
     parentRelations (Optional): [
          (Optional){
             childEntityId: String (Optional)
             relationshipId: String (Optional)
             parentEntityId: String (Optional)
         }
     ]
     relations (Optional): [
          (Optional){
             fromEntityId: String (Optional)
             relationshipId: String (Optional)
             toEntityId: String (Optional)
         }
     ]
 }
 
 

Parameters:

typeName - The name of the type.

direction - The direction of the lineage, which could be INPUT, OUTPUT or BOTH. Allowed values: "INPUT", "OUTPUT", "BOTH".

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the lineage information 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.

get

public AtlasLineageInfo get(String guid,
 LineageDirection direction,
 Integer depth)

Get lineage info of the entity specified by GUID.

Parameters:

guid - The globally unique identifier of the entity.

direction - The direction of the lineage, which could be INPUT, OUTPUT or BOTH.

depth - The number of hops for lineage.

Returns:

lineage info of the entity specified by GUID.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

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.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

get

public AtlasLineageInfo get(String guid,
 LineageDirection direction)

Get lineage info of the entity specified by GUID.

Parameters:

guid - The globally unique identifier of the entity.

direction - The direction of the lineage, which could be INPUT, OUTPUT or BOTH.

Returns:

lineage info of the entity specified by GUID.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

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.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getNextPage

public AtlasLineageInfo getNextPage(String guid,
 LineageDirection direction,
 Integer offset,
 Integer limit)

Return immediate next page lineage info about entity with pagination.

Parameters:

guid - The globally unique identifier of the entity.

direction - The direction of the lineage, which could be INPUT, OUTPUT or BOTH.

offset - The offset for pagination purpose.

limit - The page size - by default there is no paging.

Returns:

the lineage information.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

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.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getNextPage

public AtlasLineageInfo getNextPage(String guid,
 LineageDirection direction)

Return immediate next page lineage info about entity with pagination.

Parameters:

guid - The globally unique identifier of the entity.

direction - The direction of the lineage, which could be INPUT, OUTPUT or BOTH.

Returns:

the lineage information.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

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.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByUniqueAttribute

public AtlasLineageInfo getByUniqueAttribute(String typeName,
 LineageDirection direction,
 Integer depth,
 String attribute)

Return lineage info about entity. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format attr:[attrName]=[attrValue] NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: GET /v2/lineage/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.

Parameters:

typeName - The name of the type.

direction - The direction of the lineage, which could be INPUT, OUTPUT or BOTH.

depth - The number of hops for lineage.

attribute - The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes).

Returns:

the lineage information.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

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.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByUniqueAttribute

public AtlasLineageInfo getByUniqueAttribute(String typeName,
 LineageDirection direction)

Return lineage info about entity. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format attr:[attrName]=[attrValue] NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: GET /v2/lineage/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.

Parameters:

typeName - The name of the type.

direction - The direction of the lineage, which could be INPUT, OUTPUT or BOTH.

Returns:

the lineage information.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

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.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.