Lineage.GetNextPage Method

Definition

Namespace:

Azure.Analytics.Purview.DataMap

Assembly:

Azure.Analytics.Purview.DataMap.dll

Package:

Azure.Analytics.Purview.DataMap v1.0.0-beta.1

Overloads

GetNextPage(String, LineageDirection, Nullable<Int32>, Nullable<Int32>, CancellationToken)	Return immediate next page lineage info about entity with pagination.
GetNextPage(String, String, Nullable<Int32>, Nullable<Int32>, RequestContext)	[Protocol Method] Return immediate next page lineage info about entity with pagination This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetNextPage(String, LineageDirection, Nullable<Int32>, Nullable<Int32>, CancellationToken) convenience overload with strongly typed models first.

GetNextPage(String, LineageDirection, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Source:

Lineage.cs

Return immediate next page lineage info about entity with pagination.

public virtual Azure.Response<Azure.Analytics.Purview.DataMap.AtlasLineageInfo> GetNextPage (string guid, Azure.Analytics.Purview.DataMap.LineageDirection direction, int? offset = default, int? limit = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetNextPage : string * Azure.Analytics.Purview.DataMap.LineageDirection * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.AtlasLineageInfo>
override this.GetNextPage : string * Azure.Analytics.Purview.DataMap.LineageDirection * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.Purview.DataMap.AtlasLineageInfo>

Public Overridable Function GetNextPage (guid As String, direction As LineageDirection, Optional offset As Nullable(Of Integer) = Nothing, Optional limit As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As 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.

offset

Nullable<Int32>

The offset for pagination purpose.

limit

Nullable<Int32>

The page size - by default there is no paging.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<AtlasLineageInfo>

Exceptions

ArgumentNullException

guid is null.

ArgumentException

guid is an empty string, and was expected to be non-empty.

Examples

This sample shows how to call GetNextPage.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
Lineage client = new DataMapClient(endpoint, credential).GetLineageClient(apiVersion: "2023-09-01");

Response<AtlasLineageInfo> response = client.GetNextPage("<guid>", LineageDirection.Input);

This sample shows how to call GetNextPage with all parameters.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
Lineage client = new DataMapClient(endpoint, credential).GetLineageClient(apiVersion: "2023-09-01");

Response<AtlasLineageInfo> response = client.GetNextPage("<guid>", LineageDirection.Input, offset: 1234, limit: 1234);

GetNextPage(String, String, Nullable<Int32>, Nullable<Int32>, RequestContext)

Source:

Lineage.cs

[Protocol Method] Return immediate next page lineage info about entity with pagination

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
• Please try the simpler GetNextPage(String, LineageDirection, Nullable<Int32>, Nullable<Int32>, CancellationToken) convenience overload with strongly typed models first.

public virtual Azure.Response GetNextPage (string guid, string direction, int? offset = default, int? limit = default, Azure.RequestContext context = default);

abstract member GetNextPage : string * string * Nullable<int> * Nullable<int> * Azure.RequestContext -> Azure.Response
override this.GetNextPage : string * string * Nullable<int> * Nullable<int> * Azure.RequestContext -> Azure.Response

Public Overridable Function GetNextPage (guid As String, direction As String, Optional offset As Nullable(Of Integer) = Nothing, Optional limit As Nullable(Of Integer) = Nothing, Optional context As RequestContext = Nothing) As 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".

offset

Nullable<Int32>

The offset for pagination purpose.

limit

Nullable<Int32>

The page size - by default there is no paging.

context

RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

guid or direction is null.

ArgumentException

guid is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call GetNextPage and parse the result.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
Lineage client = new DataMapClient(endpoint, credential).GetLineageClient(apiVersion: "2023-09-01");

Response response = client.GetNextPage("<guid>", "INPUT");

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.ToString());

This sample shows how to call GetNextPage with all parameters and parse the result.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
Lineage client = new DataMapClient(endpoint, credential).GetLineageClient(apiVersion: "2023-09-01");

Response response = client.GetNextPage("<guid>", "INPUT", offset: 1234, limit: 1234);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("baseEntityGuid").ToString());
Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("<key>").GetProperty("attributes").GetProperty("<key>").ToString());
Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("<key>").GetProperty("typeName").ToString());
Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("<key>").GetProperty("lastModifiedTS").ToString());
Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("<key>").GetProperty("classificationNames")[0].ToString());
Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("<key>").GetProperty("classifications")[0].GetProperty("attributes").GetProperty("<key>").ToString());
Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("<key>").GetProperty("classifications")[0].GetProperty("typeName").ToString());
Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("<key>").GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString());
Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("<key>").GetProperty("classifications")[0].GetProperty("entityGuid").ToString());
Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("<key>").GetProperty("classifications")[0].GetProperty("entityStatus").ToString());
Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("<key>").GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString());
Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("<key>").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString());
Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("<key>").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString());
Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("<key>").GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString());
Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("<key>").GetProperty("displayText").ToString());
Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("<key>").GetProperty("guid").ToString());
Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("<key>").GetProperty("isIncomplete").ToString());
Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("<key>").GetProperty("labels")[0].ToString());
Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("<key>").GetProperty("meaningNames")[0].ToString());
Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("<key>").GetProperty("meanings")[0].GetProperty("confidence").ToString());
Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("<key>").GetProperty("meanings")[0].GetProperty("createdBy").ToString());
Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("<key>").GetProperty("meanings")[0].GetProperty("description").ToString());
Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("<key>").GetProperty("meanings")[0].GetProperty("displayText").ToString());
Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("<key>").GetProperty("meanings")[0].GetProperty("expression").ToString());
Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("<key>").GetProperty("meanings")[0].GetProperty("relationGuid").ToString());
Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("<key>").GetProperty("meanings")[0].GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("<key>").GetProperty("meanings")[0].GetProperty("steward").ToString());
Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("<key>").GetProperty("meanings")[0].GetProperty("termGuid").ToString());
Console.WriteLine(result.GetProperty("guidEntityMap").GetProperty("<key>").GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("widthCounts").GetProperty("<key>").GetProperty("<key>").ToString());
Console.WriteLine(result.GetProperty("lineageDepth").ToString());
Console.WriteLine(result.GetProperty("lineageWidth").ToString());
Console.WriteLine(result.GetProperty("childrenCount").ToString());
Console.WriteLine(result.GetProperty("lineageDirection").ToString());
Console.WriteLine(result.GetProperty("parentRelations")[0].GetProperty("childEntityId").ToString());
Console.WriteLine(result.GetProperty("parentRelations")[0].GetProperty("relationshipId").ToString());
Console.WriteLine(result.GetProperty("parentRelations")[0].GetProperty("parentEntityId").ToString());
Console.WriteLine(result.GetProperty("relations")[0].GetProperty("fromEntityId").ToString());
Console.WriteLine(result.GetProperty("relations")[0].GetProperty("relationshipId").ToString());
Console.WriteLine(result.GetProperty("relations")[0].GetProperty("toEntityId").ToString());