PurviewRelationships.GetPurviewRelationshipAsync Method

Reference

Definition

Namespace:: Azure.Analytics.Purview.Catalog

Assembly:: Azure.Analytics.Purview.Catalog.dll

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

Source:: PurviewRelatonships.cs

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.

Get relationship information between entities by its GUID.

public virtual System.Threading.Tasks.Task<Azure.Response> GetPurviewRelationshipAsync (string guid, bool? extendedInfo = default, Azure.RequestContext context = default);

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

Public Overridable Function GetPurviewRelationshipAsync (guid As String, Optional extendedInfo As Nullable(Of Boolean) = Nothing, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

guid: String

The globally unique identifier of the relationship.

extendedInfo: Nullable<Boolean>

Limits whether includes extended information.

context: RequestContext

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

Returns

Task<Response>

Exceptions

ArgumentNullException

guid is null.

ArgumentException

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

Remarks

Schema for Response Body:

{
              referredEntities: Dictionary<string, AtlasEntityHeader>,
              relationship: {
                attributes: Dictionary<string, AnyObject>,
                typeName: string,
                lastModifiedTS: string,
                createTime: number,
                createdBy: string,
                end1: {
                  guid: string,
                  typeName: string,
                  uniqueAttributes: Dictionary<string, AnyObject>
                },
                end2: AtlasObjectId,
                guid: string,
                homeId: string,
                label: string,
                provenanceType: number,
                status: "ACTIVE" | "DELETED",
                updateTime: number,
                updatedBy: string,
                version: number
              }
            }

Schema for Response Error:

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

Applies to

Dela via