PurviewLineages.NextPageLineageAsync Method

Definition

Namespace:

Azure.Analytics.Purview.Catalog

Assembly:

Azure.Analytics.Purview.Catalog.dll

Package:

Azure.Analytics.Purview.Catalog v1.0.0-beta.4

Source:

PurviewLineages.cs

Return immediate next page lineage info about entity with pagination.

public virtual System.Threading.Tasks.Task<Azure.Response> NextPageLineageAsync (string guid, string direction, bool? getDerivedLineage = default, int? offset = default, int? limit = default, Azure.RequestContext context = default);

abstract member NextPageLineageAsync : string * string * Nullable<bool> * Nullable<int> * Nullable<int> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.NextPageLineageAsync : string * string * Nullable<bool> * Nullable<int> * Nullable<int> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function NextPageLineageAsync (guid As String, direction As String, Optional getDerivedLineage As Nullable(Of Boolean) = Nothing, 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: "BOTH" | "INPUT" | "OUTPUT".

getDerivedLineage

Nullable<Boolean>

True to include derived lineage in the response.

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 on the request on a per-call basis.

Returns

Task<Response>

Exceptions

ArgumentNullException

guid or direction is null.

ArgumentException

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

Remarks

Schema for Response Body:

{
              baseEntityGuid: string,
              guidEntityMap: Dictionary<string, AtlasEntityHeader>,
              widthCounts: Dictionary<string, Dictionary<string, AnyObject>>,
              lineageDepth: number,
              lineageWidth: number,
              includeParent: boolean,
              childrenCount: number,
              lineageDirection: "INPUT" | "OUTPUT" | "BOTH",
              parentRelations: [
                {
                  childEntityId: string,
                  relationshipId: string,
                  parentEntityId: string
                }
              ],
              relations: [
                {
                  fromEntityId: string,
                  relationshipId: string,
                  toEntityId: string
                }
              ]
            }

Schema for Response Error:

{
              requestId: string,
              errorCode: string,
              errorMessage: string
            }