Lineage.GetLineageAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| Name | Description |
|---|---|
| GetLineageAsync(String, LineageDirection, Nullable<Int32>, CancellationToken) |
Get lineage info of the entity specified by GUID. |
| GetLineageAsync(String, String, Nullable<Int32>, RequestContext) |
[Protocol Method] Get lineage info of the entity specified by GUID.
|
GetLineageAsync(String, LineageDirection, Nullable<Int32>, CancellationToken)
- Source:
- Lineage.cs
Get lineage info of the entity specified by GUID.
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasLineageInfo>> GetLineageAsync(string guid, Azure.Analytics.Purview.DataMap.LineageDirection direction, int? depth = default, System.Threading.CancellationToken cancellationToken = default);abstract member GetLineageAsync : string * Azure.Analytics.Purview.DataMap.LineageDirection * Nullable<int> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasLineageInfo>>
override this.GetLineageAsync : string * Azure.Analytics.Purview.DataMap.LineageDirection * Nullable<int> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasLineageInfo>>Public Overridable Function GetLineageAsync (guid As String, direction As LineageDirection, Optional depth As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of AtlasLineageInfo))Parameters
- guid
- String
The globally unique identifier of the entity.
- direction
- LineageDirection
The direction of the lineage, which could be INPUT, OUTPUT or BOTH.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Exceptions
guid is null.
guid is an empty string, and was expected to be non-empty.
Examples
This sample shows how to call GetLineageAsync.
Uri endpoint = new Uri("<endpoint>");
TokenCredential credential = new DefaultAzureCredential();
Lineage client = new DataMapClient(endpoint, credential).GetLineageClient();
Response<AtlasLineageInfo> response = await client.GetLineageAsync("a6894eb3-81f3-829b-2adc-52f3e603411a", LineageDirection.Input);
Applies to
GetLineageAsync(String, String, Nullable<Int32>, RequestContext)
- Source:
- Lineage.cs
[Protocol Method] Get lineage info of the entity specified by GUID.
- This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
- Please try the simpler GetLineageAsync(String, LineageDirection, Nullable<Int32>, CancellationToken) convenience overload with strongly typed models first.
public virtual System.Threading.Tasks.Task<Azure.Response> GetLineageAsync(string guid, string direction, int? depth = default, Azure.RequestContext context = default);abstract member GetLineageAsync : string * string * Nullable<int> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetLineageAsync : string * string * Nullable<int> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function GetLineageAsync (guid As String, direction As String, Optional depth As Nullable(Of Integer) = Nothing, Optional context As RequestContext = Nothing) As Task(Of Response)Parameters
- guid
- String
The globally unique identifier of the entity.
- direction
- String
The direction of the lineage, which could be INPUT, OUTPUT or BOTH. Allowed values: "INPUT" | "OUTPUT" | "BOTH".
- context
- RequestContext
The request context, which can override default behaviors of the client pipeline on a per-call basis.
Returns
The response returned from the service.
Exceptions
guid or direction is null.
guid is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
Examples
This sample shows how to call GetLineageAsync and parse the result.
Uri endpoint = new Uri("<endpoint>");
TokenCredential credential = new DefaultAzureCredential();
Lineage client = new DataMapClient(endpoint, credential).GetLineageClient();
Response response = await client.GetLineageAsync("a6894eb3-81f3-829b-2adc-52f3e603411a", "INPUT");
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.ToString());
