Lineage.GetNextPageAsync Method

Definition

Overloads

Name Description
GetNextPageAsync(String, LineageDirection, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Return immediate next page lineage info about entity with pagination.

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

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

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

Source:
Lineage.cs

Return immediate next page lineage info about entity with pagination.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasLineageInfo>> GetNextPageAsync(string guid, Azure.Analytics.Purview.DataMap.LineageDirection direction, int? offset = default, int? limit = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetNextPageAsync : string * Azure.Analytics.Purview.DataMap.LineageDirection * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasLineageInfo>>
override this.GetNextPageAsync : string * Azure.Analytics.Purview.DataMap.LineageDirection * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Purview.DataMap.AtlasLineageInfo>>
Public Overridable Function GetNextPageAsync (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 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.

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

Exceptions

guid is null.

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

Examples

This sample shows how to call GetNextPageAsync.

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

Response<AtlasLineageInfo> response = await client.GetNextPageAsync("a6894eb3-81f3-829b-2adc-52f3e603411a", LineageDirection.Input);

Applies to

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

Source:
Lineage.cs

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

public virtual System.Threading.Tasks.Task<Azure.Response> GetNextPageAsync(string guid, string direction, int? offset = default, int? limit = default, Azure.RequestContext context = default);
abstract member GetNextPageAsync : string * string * Nullable<int> * Nullable<int> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetNextPageAsync : string * string * Nullable<int> * Nullable<int> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
Public Overridable Function GetNextPageAsync (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 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".

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

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 GetNextPageAsync and parse the result.

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

Response response = await client.GetNextPageAsync("a6894eb3-81f3-829b-2adc-52f3e603411a", "INPUT");

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

Applies to