Class LineageAsyncClient

java.lang.Object
com.azure.analytics.purview.catalog.LineageAsyncClient

public final class LineageAsyncClient extends Object
Initializes a new instance of the asynchronous PurviewCatalogClient type.
  • Method Details

    • getLineageGraphWithResponse

      public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getLineageGraphWithResponse(String guid, String direction, com.azure.core.http.rest.RequestOptions requestOptions)
      Get lineage info of the entity specified by GUID.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      depthIntegerNoThe number of hops for lineage.
      widthIntegerNoThe number of max expanding width in lineage.
      includeParentBooleanNoTrue to include the parent chain in the response.
      getDerivedLineageBooleanNoTrue 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
                   isIncomplete: Boolean
                   labels: [
                       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.
      direction - The direction of the lineage, which could be INPUT, OUTPUT or BOTH. Allowed values: BOTH, INPUT, OUTPUT.
      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 on successful completion of Mono.
      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 Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> nextPageLineageWithResponse(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
      NameTypeRequiredDescription
      getDerivedLineageBooleanNoTrue to include derived lineage in the response
      offsetIntegerNoThe offset for pagination purpose.
      limitIntegerNoThe page size - by default there is no paging.

      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
                   isIncomplete: Boolean
                   labels: [
                       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.
      direction - The direction of the lineage, which could be INPUT, OUTPUT or BOTH. Allowed values: BOTH, INPUT, OUTPUT.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      atlasLineageInfo along with Response on successful completion of Mono.
      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.
    • getLineageByUniqueAttributeWithResponse

      public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getLineageByUniqueAttributeWithResponse(String typeName, String direction, com.azure.core.http.rest.RequestOptions requestOptions)
      Returns 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.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      depthIntegerNoThe number of hops for lineage.
      widthIntegerNoThe number of max expanding width in lineage.
      includeParentBooleanNoTrue to include the parent chain in the response.
      getDerivedLineageBooleanNoTrue 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
                   isIncomplete: Boolean
                   labels: [
                       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:
      typeName - The name of the type.
      direction - The direction of the lineage, which could be INPUT, OUTPUT or BOTH. Allowed values: BOTH, INPUT, OUTPUT.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      atlasLineageInfo along with Response on successful completion of Mono.
      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.