Entity Class

Definition

The Entity sub-client.

public class Entity
type Entity = class
Public Class Entity
Inheritance
Entity

Constructors

Entity()

Initializes a new instance of Entity for mocking.

Properties

Pipeline

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

Methods

AddClassification(ClassificationAssociateConfig, CancellationToken)

Associate a classification to multiple entities in bulk.

AddClassification(RequestContent, RequestContext)

[Protocol Method] Associate a classification to multiple entities in bulk.

AddClassificationAsync(ClassificationAssociateConfig, CancellationToken)

Associate a classification to multiple entities in bulk.

AddClassificationAsync(RequestContent, RequestContext)

[Protocol Method] Associate a classification to multiple entities in bulk.

AddClassifications(String, IEnumerable<AtlasClassification>, CancellationToken)

Add classifications to an existing entity represented by a GUID.

AddClassifications(String, RequestContent, RequestContext)

[Protocol Method] Add classifications to an existing entity represented by a GUID.

AddClassificationsAsync(String, IEnumerable<AtlasClassification>, CancellationToken)

Add classifications to an existing entity represented by a GUID.

AddClassificationsAsync(String, RequestContent, RequestContext)

[Protocol Method] Add classifications to an existing entity represented by a GUID.

AddClassificationsByUniqueAttribute(String, IEnumerable<AtlasClassification>, String, CancellationToken)

Add classification to the entity identified by its type and unique attributes.

AddClassificationsByUniqueAttribute(String, RequestContent, String, RequestContext)

[Protocol Method] Add classification to the entity identified by its type and unique attributes.

AddClassificationsByUniqueAttributeAsync(String, IEnumerable<AtlasClassification>, String, CancellationToken)

Add classification to the entity identified by its type and unique attributes.

AddClassificationsByUniqueAttributeAsync(String, RequestContent, String, RequestContext)

[Protocol Method] Add classification to the entity identified by its type and unique attributes.

AddLabel(String, IEnumerable<String>, CancellationToken)

Add given labels to a given entity.

AddLabel(String, RequestContent, RequestContext)

[Protocol Method] Add given labels to a given entity.

AddLabelAsync(String, IEnumerable<String>, CancellationToken)

Add given labels to a given entity.

AddLabelAsync(String, RequestContent, RequestContext)

[Protocol Method] Add given labels to a given entity.

AddLabelsByUniqueAttribute(String, IEnumerable<String>, String, CancellationToken)

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.

AddLabelsByUniqueAttribute(String, RequestContent, String, RequestContext)

[Protocol Method] 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, IEnumerable<String>, String, CancellationToken)

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)

[Protocol Method] 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, IDictionary<String,IDictionary<String,BinaryData>>, Nullable<Boolean>, CancellationToken)

Add business metadata to an entity.

AddOrUpdateBusinessMetadata(String, RequestContent, Nullable<Boolean>, RequestContext)

[Protocol Method] Add business metadata to an entity.

AddOrUpdateBusinessMetadataAsync(String, IDictionary<String,IDictionary<String,BinaryData>>, Nullable<Boolean>, CancellationToken)

Add business metadata to an entity.

AddOrUpdateBusinessMetadataAsync(String, RequestContent, Nullable<Boolean>, RequestContext)

[Protocol Method] Add business metadata to an entity.

AddOrUpdateBusinessMetadataAttributes(String, String, IDictionary<String,BinaryData>, CancellationToken)

Add or update business metadata attributes.

AddOrUpdateBusinessMetadataAttributes(String, String, RequestContent, RequestContext)

[Protocol Method] Add or update business metadata attributes.

AddOrUpdateBusinessMetadataAttributesAsync(String, String, IDictionary<String,BinaryData>, CancellationToken)

Add or update business metadata attributes.

AddOrUpdateBusinessMetadataAttributesAsync(String, String, RequestContent, RequestContext)

[Protocol Method] Add or update business metadata attributes.

BatchCreateOrUpdate(AtlasEntitiesWithExtInfo, String, Nullable<BusinessAttributeUpdateBehavior>, CancellationToken)

Create or update entities 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>>. For each contact type, the maximum number of contacts is 20.

BatchCreateOrUpdate(RequestContent, String, String, RequestContext)

[Protocol Method] Create or update entities 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>>. For each contact type, the maximum number of contacts is 20.

BatchCreateOrUpdateAsync(AtlasEntitiesWithExtInfo, String, Nullable<BusinessAttributeUpdateBehavior>, CancellationToken)

Create or update entities 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>>. For each contact type, the maximum number of contacts is 20.

BatchCreateOrUpdateAsync(RequestContent, String, String, RequestContext)

[Protocol Method] Create or update entities 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>>. For each contact type, the maximum number of contacts is 20.

BatchDelete(IEnumerable<String>, CancellationToken)

Delete a list of entities in bulk identified by their GUIDs or unique attributes.

BatchDelete(IEnumerable<String>, RequestContext)

[Protocol Method] Delete a list of entities in bulk identified by their GUIDs or unique attributes.

BatchDeleteAsync(IEnumerable<String>, CancellationToken)

Delete a list of entities in bulk identified by their GUIDs or unique attributes.

BatchDeleteAsync(IEnumerable<String>, RequestContext)

[Protocol Method] Delete a list of entities in bulk identified by their GUIDs or unique attributes.

BatchGetByUniqueAttributes(String, Nullable<Boolean>, Nullable<Boolean>, String, CancellationToken)

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_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1

Note: at least one unique attribute must be provided.

BatchGetByUniqueAttributes(String, Nullable<Boolean>, Nullable<Boolean>, String, RequestContext)

[Protocol Method] 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_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1

Note: at least one unique attribute must be provided.

BatchGetByUniqueAttributesAsync(String, Nullable<Boolean>, Nullable<Boolean>, String, CancellationToken)

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_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1

Note: at least one unique attribute must be provided.

BatchGetByUniqueAttributesAsync(String, Nullable<Boolean>, Nullable<Boolean>, String, RequestContext)

[Protocol Method] 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_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1

Note: at least one unique attribute must be provided.

BatchSetClassifications(AtlasEntityHeaders, CancellationToken)

Set classifications on entities in bulk.

BatchSetClassifications(RequestContent, RequestContext)

[Protocol Method] Set classifications on entities in bulk.

BatchSetClassificationsAsync(AtlasEntityHeaders, CancellationToken)

Set classifications on entities in bulk.

BatchSetClassificationsAsync(RequestContent, RequestContext)

[Protocol Method] Set classifications on entities in bulk.

CreateOrUpdate(AtlasEntityWithExtInfo, Nullable<BusinessAttributeUpdateBehavior>, String, CancellationToken)

Create or update an entity. 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>>. For each contact type, the maximum number of contacts is 20.

CreateOrUpdate(RequestContent, String, String, RequestContext)

[Protocol Method] Create or update an entity. 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>>. For each contact type, the maximum number of contacts is 20.

CreateOrUpdateAsync(AtlasEntityWithExtInfo, Nullable<BusinessAttributeUpdateBehavior>, String, CancellationToken)

Create or update an entity. 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>>. For each contact type, the maximum number of contacts is 20.

CreateOrUpdateAsync(RequestContent, String, String, RequestContext)

[Protocol Method] Create or update an entity. 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>>. For each contact type, the maximum number of contacts is 20.

Delete(String, CancellationToken)

Delete an entity identified by its GUID.

Delete(String, RequestContext)

[Protocol Method] Delete an entity identified by its GUID.

DeleteAsync(String, CancellationToken)

Delete an entity identified by its GUID.

DeleteAsync(String, RequestContext)

[Protocol Method] Delete an entity identified by its GUID.

DeleteByUniqueAttribute(String, String, CancellationToken)

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.

DeleteByUniqueAttribute(String, String, RequestContext)

[Protocol Method] 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, CancellationToken)

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)

[Protocol Method] 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.

GetBusinessMetadataTemplate(CancellationToken)

Get the sample Template for uploading/creating bulk BusinessMetaData.

GetBusinessMetadataTemplate(RequestContext)

[Protocol Method] Get the sample Template for uploading/creating bulk BusinessMetaData

GetBusinessMetadataTemplateAsync(CancellationToken)

Get the sample Template for uploading/creating bulk BusinessMetaData.

GetBusinessMetadataTemplateAsync(RequestContext)

[Protocol Method] Get the sample Template for uploading/creating bulk BusinessMetaData

GetByIds(IEnumerable<String>, Nullable<Boolean>, Nullable<Boolean>, CancellationToken)

List entities in bulk identified by its GUIDs.

GetByIds(IEnumerable<String>, Nullable<Boolean>, Nullable<Boolean>, RequestContext)

[Protocol Method] List entities in bulk identified by its GUIDs.

GetByIdsAsync(IEnumerable<String>, Nullable<Boolean>, Nullable<Boolean>, CancellationToken)

List entities in bulk identified by its GUIDs.

GetByIdsAsync(IEnumerable<String>, Nullable<Boolean>, Nullable<Boolean>, RequestContext)

[Protocol Method] List entities in bulk identified by its GUIDs.

GetByUniqueAttribute(String, Nullable<Boolean>, Nullable<Boolean>, String, CancellationToken)

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.

GetByUniqueAttribute(String, Nullable<Boolean>, Nullable<Boolean>, String, RequestContext)

[Protocol Method] 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.

GetByUniqueAttributeAsync(String, Nullable<Boolean>, Nullable<Boolean>, String, CancellationToken)

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.

GetByUniqueAttributeAsync(String, Nullable<Boolean>, Nullable<Boolean>, String, RequestContext)

[Protocol Method] 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, CancellationToken)

Get classification for a given entity represented by a GUID.

GetClassification(String, String, RequestContext)

[Protocol Method] Get classification for a given entity represented by a GUID.

GetClassificationAsync(String, String, CancellationToken)

Get classification for a given entity represented by a GUID.

GetClassificationAsync(String, String, RequestContext)

[Protocol Method] Get classification for a given entity represented by a GUID.

GetClassifications(String, CancellationToken)

List classifications for a given entity represented by a GUID.

GetClassifications(String, RequestContext)

[Protocol Method] List classifications for a given entity represented by a GUID.

GetClassificationsAsync(String, CancellationToken)

List classifications for a given entity represented by a GUID.

GetClassificationsAsync(String, RequestContext)

[Protocol Method] List classifications for a given entity represented by a GUID.

GetEntity(String, Nullable<Boolean>, Nullable<Boolean>, CancellationToken)

Get complete definition of an entity given its GUID.

GetEntity(String, Nullable<Boolean>, Nullable<Boolean>, RequestContext)

[Protocol Method] Get complete definition of an entity given its GUID.

GetEntityAsync(String, Nullable<Boolean>, Nullable<Boolean>, CancellationToken)

Get complete definition of an entity given its GUID.

GetEntityAsync(String, Nullable<Boolean>, Nullable<Boolean>, RequestContext)

[Protocol Method] Get complete definition of an entity given its GUID.

GetHeader(String, CancellationToken)

Get entity header given its GUID.

GetHeader(String, RequestContext)

[Protocol Method] Get entity header given its GUID.

GetHeaderAsync(String, CancellationToken)

Get entity header given its GUID.

GetHeaderAsync(String, RequestContext)

[Protocol Method] Get entity header given its GUID.

ImportBusinessMetadata(BinaryData, CancellationToken)

Upload the file for creating Business Metadata in BULK.

ImportBusinessMetadata(BusinessMetadataOptions, CancellationToken)

Upload the file for creating Business Metadata in BULK.

ImportBusinessMetadata(RequestContent, RequestContext)

[Protocol Method] Upload the file for creating Business Metadata in BULK

ImportBusinessMetadataAsync(BusinessMetadataOptions, CancellationToken)

Upload the file for creating Business Metadata in BULK.

ImportBusinessMetadataAsync(RequestContent, RequestContext)

[Protocol Method] Upload the file for creating Business Metadata in BULK

MoveEntitiesToCollection(String, MoveEntitiesConfig, CancellationToken)

Move existing entities to the target collection.

MoveEntitiesToCollection(String, RequestContent, RequestContext)

[Protocol Method] Move existing entities to the target collection.

MoveEntitiesToCollectionAsync(String, MoveEntitiesConfig, CancellationToken)

Move existing entities to the target collection.

MoveEntitiesToCollectionAsync(String, RequestContent, RequestContext)

[Protocol Method] Move existing entities to the target collection.

RemoveBusinessMetadata(String, IDictionary<String,IDictionary<String,BinaryData>>, CancellationToken)

Remove business metadata from an entity.

RemoveBusinessMetadata(String, RequestContent, RequestContext)

[Protocol Method] Remove business metadata from an entity.

RemoveBusinessMetadataAsync(String, IDictionary<String,IDictionary<String,BinaryData>>, CancellationToken)

Remove business metadata from an entity.

RemoveBusinessMetadataAsync(String, RequestContent, RequestContext)

[Protocol Method] Remove business metadata from an entity.

RemoveBusinessMetadataAttributes(String, String, IDictionary<String,BinaryData>, CancellationToken)

Delete business metadata attributes from an entity.

RemoveBusinessMetadataAttributes(String, String, RequestContent, RequestContext)

[Protocol Method] Delete business metadata attributes from an entity.

RemoveBusinessMetadataAttributesAsync(String, String, IDictionary<String,BinaryData>, CancellationToken)

Delete business metadata attributes from an entity.

RemoveBusinessMetadataAttributesAsync(String, String, RequestContent, RequestContext)

[Protocol Method] Delete business metadata attributes from an entity.

RemoveClassification(String, String, RequestContext)

[Protocol Method] Delete a given classification from an existing entity represented by a GUID.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
RemoveClassificationAsync(String, String, RequestContext)

[Protocol Method] Delete a given classification from an existing entity represented by a GUID.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
RemoveClassificationByUniqueAttribute(String, String, String, RequestContext)

[Protocol Method] Delete a given classification from an entity identified by its type and unique attributes.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
RemoveClassificationByUniqueAttributeAsync(String, String, String, RequestContext)

[Protocol Method] Delete a given classification from an entity identified by its type and unique attributes.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
RemoveLabels(String, IEnumerable<String>, CancellationToken)

Delete given labels to a given entity.

RemoveLabels(String, RequestContent, RequestContext)

[Protocol Method] Delete given labels to a given entity.

RemoveLabelsAsync(String, IEnumerable<String>, CancellationToken)

Delete given labels to a given entity.

RemoveLabelsAsync(String, RequestContent, RequestContext)

[Protocol Method] Delete given labels to a given entity.

RemoveLabelsByUniqueAttribute(String, IEnumerable<String>, String, CancellationToken)

Delete given labels to a given entity identified by its type and unique attribute.

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.

RemoveLabelsByUniqueAttribute(String, RequestContent, String, RequestContext)

[Protocol Method] Delete given labels to a given entity identified by its type and unique attribute.

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.

RemoveLabelsByUniqueAttributeAsync(String, IEnumerable<String>, String, CancellationToken)

Delete given labels to a given entity identified by its type and unique attribute.

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.

RemoveLabelsByUniqueAttributeAsync(String, RequestContent, String, RequestContext)

[Protocol Method] Delete given labels to a given entity identified by its type and unique attribute.

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.

SetLabels(String, IEnumerable<String>, CancellationToken)

Set labels to a given entity.

SetLabels(String, RequestContent, RequestContext)

[Protocol Method] Set labels to a given entity.

SetLabelsAsync(String, IEnumerable<String>, CancellationToken)

Set labels to a given entity.

SetLabelsAsync(String, RequestContent, RequestContext)

[Protocol Method] Set labels to a given entity.

SetLabelsByUniqueAttribute(String, IEnumerable<String>, String, CancellationToken)

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.

SetLabelsByUniqueAttribute(String, RequestContent, String, RequestContext)

[Protocol Method] 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, IEnumerable<String>, String, CancellationToken)

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)

[Protocol Method] 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.

UpdateAttributeById(String, String, BinaryData, CancellationToken)

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.

UpdateAttributeById(String, String, RequestContent, RequestContext)

[Protocol Method] 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.

UpdateAttributeByIdAsync(String, String, BinaryData, CancellationToken)

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.

UpdateAttributeByIdAsync(String, String, RequestContent, RequestContext)

[Protocol Method] 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.

UpdateByUniqueAttribute(String, AtlasEntityWithExtInfo, String, CancellationToken)

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.

UpdateByUniqueAttribute(String, RequestContent, String, RequestContext)

[Protocol Method] 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.

UpdateByUniqueAttributeAsync(String, AtlasEntityWithExtInfo, String, CancellationToken)

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.

UpdateByUniqueAttributeAsync(String, RequestContent, String, RequestContext)

[Protocol Method] 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.

UpdateClassifications(String, IEnumerable<AtlasClassification>, CancellationToken)

Update classifications to an existing entity represented by a guid.

UpdateClassifications(String, RequestContent, RequestContext)

[Protocol Method] Update classifications to an existing entity represented by a guid.

UpdateClassificationsAsync(String, IEnumerable<AtlasClassification>, CancellationToken)

Update classifications to an existing entity represented by a guid.

UpdateClassificationsAsync(String, RequestContent, RequestContext)

[Protocol Method] Update classifications to an existing entity represented by a guid.

UpdateClassificationsUniqueByAttribute(String, IEnumerable<AtlasClassification>, String, CancellationToken)

Update classification on an entity identified by its type and unique attributes.

UpdateClassificationsUniqueByAttribute(String, RequestContent, String, RequestContext)

[Protocol Method] Update classification on an entity identified by its type and unique attributes.

UpdateClassificationsUniqueByAttributeAsync(String, IEnumerable<AtlasClassification>, String, CancellationToken)

Update classification on an entity identified by its type and unique attributes.

UpdateClassificationsUniqueByAttributeAsync(String, RequestContent, String, RequestContext)

[Protocol Method] Update classification on an entity identified by its type and unique attributes.

Applies to