PurviewEntities Class

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

The PurviewEntities service client.

public class PurviewEntities

type PurviewEntities = class

Public Class PurviewEntities

Inheritance

Object

PurviewEntities

Constructors

PurviewEntities()

Initializes a new instance of PurviewEntities for mocking.

Properties

Pipeline

The HTTP pipeline for sending and receiving REST requests and responses.

Methods

AddClassification(RequestContent, RequestContext)	Associate a classification to multiple entities in bulk.
AddClassificationAsync(RequestContent, RequestContext)	Associate a classification to multiple entities in bulk.
AddClassifications(String, RequestContent, RequestContext)	Add classifications to an existing entity represented by a GUID.
AddClassificationsAsync(String, RequestContent, RequestContext)	Add classifications to an existing entity represented by a GUID.
AddClassificationsByUniqueAttribute(String, RequestContent, String, RequestContext)	Add classification to the entity identified by its type and unique attributes.
AddClassificationsByUniqueAttributeAsync(String, RequestContent, String, RequestContext)	Add classification to the entity identified by its type and unique attributes.
AddLabel(String, RequestContent, RequestContext)	add given labels to a given entity.
AddLabelAsync(String, RequestContent, RequestContext)	add given labels to a given entity.
AddLabelsByUniqueAttribute(String, RequestContent, String, RequestContext)	Add given labels to a given entity identified by its type and unique attributes, if labels is null/empty, no labels will be added. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
AddLabelsByUniqueAttributeAsync(String, RequestContent, String, RequestContext)	Add given labels to a given entity identified by its type and unique attributes, if labels is null/empty, no labels will be added. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
AddOrUpdateBusinessMetadata(String, RequestContent, Nullable<Boolean>, RequestContext)	Add business metadata to an entity.
AddOrUpdateBusinessMetadataAsync(String, RequestContent, Nullable<Boolean>, RequestContext)	Add business metadata to an entity.
AddOrUpdateBusinessMetadataAttributes(String, String, RequestContent, RequestContext)	Add or update business metadata attributes.
AddOrUpdateBusinessMetadataAttributesAsync(String, String, RequestContent, RequestContext)	Add or update business metadata attributes.
CreateOrUpdate(RequestContent, RequestContext)	Create or update an entity in Atlas. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. Map and array of collections are not well supported. E.g., array<array<int>>, array<map<string, int>>.
CreateOrUpdateAsync(RequestContent, RequestContext)	Create or update an entity in Atlas. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. Map and array of collections are not well supported. E.g., array<array<int>>, array<map<string, int>>.
CreateOrUpdateEntities(RequestContent, RequestContext)	Create or update entities in Atlas in bulk. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. Map and array of collections are not well supported. E.g., array<array<int>>, array<map<string, int>>.
CreateOrUpdateEntitiesAsync(RequestContent, RequestContext)	Create or update entities in Atlas in bulk. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. Map and array of collections are not well supported. E.g., array<array<int>>, array<map<string, int>>.
DeleteBusinessMetadata(String, RequestContent, RequestContext)	Remove business metadata from an entity.
DeleteBusinessMetadataAsync(String, RequestContent, RequestContext)	Remove business metadata from an entity.
DeleteBusinessMetadataAttributes(String, String, RequestContent, RequestContext)	Delete business metadata attributes from an entity.
DeleteBusinessMetadataAttributesAsync(String, String, RequestContent, RequestContext)	Delete business metadata attributes from an entity.
DeleteByGuid(String, RequestContext)	Delete an entity identified by its GUID.
DeleteByGuidAsync(String, RequestContext)	Delete an entity identified by its GUID.
DeleteByGuids(IEnumerable<String>, RequestContext)	Delete a list of entities in bulk identified by their GUIDs or unique attributes.
DeleteByGuidsAsync(IEnumerable<String>, RequestContext)	Delete a list of entities in bulk identified by their GUIDs or unique attributes.
DeleteByUniqueAttribute(String, String, RequestContext)	Delete an entity identified by its type and unique attributes. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:&lt;attrName>=&lt;attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
DeleteByUniqueAttributeAsync(String, String, RequestContext)	Delete an entity identified by its type and unique attributes. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:&lt;attrName>=&lt;attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
DeleteClassification(String, String, RequestContext)	Delete a given classification from an existing entity represented by a GUID.
DeleteClassificationAsync(String, String, RequestContext)	Delete a given classification from an existing entity represented by a GUID.
DeleteClassificationByUniqueAttribute(String, String, String, RequestContext)	Delete a given classification from an entity identified by its type and unique attributes.
DeleteClassificationByUniqueAttributeAsync(String, String, String, RequestContext)	Delete a given classification from an entity identified by its type and unique attributes.
DeleteLabels(String, RequestContent, RequestContext)	delete given labels to a given entity.
DeleteLabelsAsync(String, RequestContent, RequestContext)	delete given labels to a given entity.
DeleteLabelsByUniqueAttribute(String, RequestContent, String, RequestContext)	Delete given labels to a given entity identified by its type and unique attributes, if labels is null/empty, no labels will be removed. If any labels in labels set are non-existing labels, they will be ignored, only existing labels will be removed. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
DeleteLabelsByUniqueAttributeAsync(String, RequestContent, String, RequestContext)	Delete given labels to a given entity identified by its type and unique attributes, if labels is null/empty, no labels will be removed. If any labels in labels set are non-existing labels, they will be ignored, only existing labels will be removed. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
GetByGuid(String, Nullable<Boolean>, Nullable<Boolean>, RequestContext)	Get complete definition of an entity given its GUID.
GetByGuidAsync(String, Nullable<Boolean>, Nullable<Boolean>, RequestContext)	Get complete definition of an entity given its GUID.
GetByGuids(IEnumerable<String>, Nullable<Boolean>, Nullable<Boolean>, IEnumerable<String>, RequestContext)	List entities in bulk identified by its GUIDs.
GetByGuidsAsync(IEnumerable<String>, Nullable<Boolean>, Nullable<Boolean>, IEnumerable<String>, RequestContext)	List entities in bulk identified by its GUIDs.
GetByUniqueAttributes(String, Nullable<Boolean>, Nullable<Boolean>, String, RequestContext)	Get complete definition of an entity given its type and unique attribute. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:&lt;attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: GET /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
GetByUniqueAttributesAsync(String, Nullable<Boolean>, Nullable<Boolean>, String, RequestContext)	Get complete definition of an entity given its type and unique attribute. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:&lt;attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: GET /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
GetClassification(String, String, RequestContext)	List classifications for a given entity represented by a GUID.
GetClassificationAsync(String, String, RequestContext)	List classifications for a given entity represented by a GUID.
GetClassifications(String, RequestContext)	List classifications for a given entity represented by a GUID.
GetClassificationsAsync(String, RequestContext)	List classifications for a given entity represented by a GUID.
GetEntitiesByUniqueAttributes(String, Nullable<Boolean>, Nullable<Boolean>, String, RequestContext)	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=&lt;typeName>&attr_1:&lt;attrName>=&lt;attrValue>&attr_2:&lt;attrName>=&lt;attrValue>&attr_3:&lt;attrName>=&lt;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
GetEntitiesByUniqueAttributesAsync(String, Nullable<Boolean>, Nullable<Boolean>, String, RequestContext)	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=&lt;typeName>&attr_1:&lt;attrName>=&lt;attrValue>&attr_2:&lt;attrName>=&lt;attrValue>&attr_3:&lt;attrName>=&lt;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
GetHeader(String, RequestContext)	Get entity header given its GUID.
GetHeaderAsync(String, RequestContext)	Get entity header given its GUID.
GetSampleBusinessMetadataTemplate(RequestContext)	Get the sample Template for uploading/creating bulk BusinessMetaData.
GetSampleBusinessMetadataTemplateAsync(RequestContext)	Get the sample Template for uploading/creating bulk BusinessMetaData.
ImportBusinessMetadata(RequestContent, RequestContext)	Upload the file for creating Business Metadata in BULK.
ImportBusinessMetadataAsync(RequestContent, RequestContext)	Upload the file for creating Business Metadata in BULK.
PartialUpdateEntityAttributeByGuid(String, String, RequestContent, RequestContext)	Update entity partially - create or update entity attribute identified by its GUID. Supports only primitive attribute type and entity references. It does not support updating complex types like arrays, and maps. Null updates are not possible.
PartialUpdateEntityAttributeByGuidAsync(String, String, RequestContent, RequestContext)	Update entity partially - create or update entity attribute identified by its GUID. Supports only primitive attribute type and entity references. It does not support updating complex types like arrays, and maps. Null updates are not possible.
PartialUpdateEntityByUniqueAttributes(String, RequestContent, String, RequestContext)	Update entity partially - Allow a subset of attributes to be updated on an entity which is identified by its type and unique attribute eg: Referenceable.qualifiedName. Null updates are not possible. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
PartialUpdateEntityByUniqueAttributesAsync(String, RequestContent, String, RequestContext)	Update entity partially - Allow a subset of attributes to be updated on an entity which is identified by its type and unique attribute eg: Referenceable.qualifiedName. Null updates are not possible. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
SetClassifications(RequestContent, RequestContext)	Set classifications on entities in bulk.
SetClassificationsAsync(RequestContent, RequestContext)	Set classifications on entities in bulk.
SetLabels(String, RequestContent, RequestContext)	Set labels to a given entity.
SetLabelsAsync(String, RequestContent, RequestContext)	Set labels to a given entity.
SetLabelsByUniqueAttribute(String, RequestContent, String, RequestContext)	Set labels to a given entity identified by its type and unique attributes, if labels is null/empty, existing labels will all be removed. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: POST /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
SetLabelsByUniqueAttributeAsync(String, RequestContent, String, RequestContext)	Set labels to a given entity identified by its type and unique attributes, if labels is null/empty, existing labels will all be removed. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: POST /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
UpdateClassifications(String, RequestContent, RequestContext)	Update classifications to an existing entity represented by a guid.
UpdateClassificationsAsync(String, RequestContent, RequestContext)	Update classifications to an existing entity represented by a guid.
UpdateClassificationsByUniqueAttribute(String, RequestContent, String, RequestContext)	Update classification on an entity identified by its type and unique attributes.
UpdateClassificationsByUniqueAttributeAsync(String, RequestContent, String, RequestContext)	Update classification on an entity identified by its type and unique attributes.