PurviewEntities.GetEntitiesByUniqueAttributesAsync 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:: PurviewEntities.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.

Bulk API to retrieve list of entities identified by its unique attributes.

In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format

typeName=<typeName>&attr_1:<attrName>=<attrValue>&attr_2:<attrName>=<attrValue>&attr_3:<attrName>=<attrValue>

NOTE: The attrName should be an unique attribute for the given entity-type

The REST request would look something like this

GET /v2/entity/bulk/uniqueAttribute/type/hive_db?attr_0:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1

public virtual System.Threading.Tasks.Task<Azure.Response> GetEntitiesByUniqueAttributesAsync (string typeName, bool? minExtInfo = default, bool? ignoreRelationships = default, string attrNQualifiedName = default, Azure.RequestContext context = default);

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

Public Overridable Function GetEntitiesByUniqueAttributesAsync (typeName As String, Optional minExtInfo As Nullable(Of Boolean) = Nothing, Optional ignoreRelationships As Nullable(Of Boolean) = Nothing, Optional attrNQualifiedName As String = Nothing, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

typeName: String

The name of the type.

minExtInfo: Nullable<Boolean>

Whether to return minimal information for referred entities.

ignoreRelationships: Nullable<Boolean>

Whether to ignore relationship attributes.

attrNQualifiedName: String

Qualified name of an entity. E.g. to find 2 entities you can set attrs_0:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1.

context: RequestContext

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

Returns

Task<Response>

Exceptions

ArgumentNullException

typeName is null.

ArgumentException

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

Remarks

Schema for Response Body:

{
              referredEntities: Dictionary<string, AtlasEntity>,
              entities: [
                {
                  attributes: Dictionary<string, AnyObject>,
                  typeName: string,
                  lastModifiedTS: string,
                  businessAttributes: Dictionary<string, AnyObject>,
                  classifications: [
                    {
                      attributes: Dictionary<string, AnyObject>,
                      typeName: string,
                      lastModifiedTS: string,
                      entityGuid: string,
                      entityStatus: "ACTIVE" | "DELETED",
                      removePropagationsOnEntityDelete: boolean,
                      validityPeriods: [
                        {
                          endTime: string,
                          startTime: string,
                          timeZone: string
                        }
                      ],
                      source: string,
                      sourceDetails: Dictionary<string, AnyObject>
                    }
                  ],
                  createTime: number,
                  createdBy: string,
                  customAttributes: Dictionary<string, string>,
                  guid: string,
                  homeId: string,
                  isIncomplete: boolean,
                  labels: [string],
                  meanings: [
                    {
                      confidence: number,
                      createdBy: string,
                      description: string,
                      displayText: string,
                      expression: string,
                      relationGuid: string,
                      source: string,
                      status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER",
                      steward: string,
                      termGuid: string
                    }
                  ],
                  provenanceType: number,
                  proxy: boolean,
                  relationshipAttributes: Dictionary<string, AnyObject>,
                  status: "ACTIVE" | "DELETED",
                  updateTime: number,
                  updatedBy: string,
                  version: number,
                  source: string,
                  sourceDetails: Dictionary<string, AnyObject>,
                  contacts: Dictionary<string, ContactBasic[]>
                }
              ]
            }

Schema for Response Error:

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

Applies to

Condividi tramite