Package com.azure.analytics.purview.datamap

Class EntityAsyncClient

java.lang.Object

com.azure.analytics.purview.datamap.EntityAsyncClient

public final class EntityAsyncClient
extends Object

Initializes a new instance of the asynchronous DataMapClient type.

Method Summary

Modifier and Type	Method	Description
Mono<Void>	addClassification(ClassificationAssociateOptions body)	Associate a classification to multiple entities in bulk.
Mono<Void>	addClassifications(String guid, List<AtlasClassification> body)	Add classifications to an existing entity represented by a GUID.
Mono<Void>	addClassificationsByUniqueAttribute(String typeName, List<AtlasClassification> body)	Add classification to the entity identified by its type and unique attributes.
Mono<Void>	addClassificationsByUniqueAttribute(String typeName, List<AtlasClassification> body, String attribute)	Add classification to the entity identified by its type and unique attributes.
Mono<com.azure.core.http.rest.Response<Void>>	addClassificationsByUniqueAttributeWithResponse(String typeName, com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)	Add classification to the entity identified by its type and unique attributes.
Mono<com.azure.core.http.rest.Response<Void>>	addClassificationsWithResponse(String guid, com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)	Add classifications to an existing entity represented by a GUID.
Mono<com.azure.core.http.rest.Response<Void>>	addClassificationWithResponse(com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)	Associate a classification to multiple entities in bulk.
Mono<Void>	addLabel(String guid)	Add given labels to a given entity.
Mono<Void>	addLabel(String guid, List<String> body)	Add given labels to a given entity.
Mono<Void>	addLabelsByUniqueAttribute(String typeName)	Add given labels to a given entity identified by its type and unique attributes.
Mono<Void>	addLabelsByUniqueAttribute(String typeName, String attribute, List<String> body)	Add given labels to a given entity identified by its type and unique attributes.
Mono<com.azure.core.http.rest.Response<Void>>	addLabelsByUniqueAttributeWithResponse(String typeName, com.azure.core.http.rest.RequestOptions requestOptions)	Add given labels to a given entity identified by its type and unique attributes.
Mono<com.azure.core.http.rest.Response<Void>>	addLabelWithResponse(String guid, com.azure.core.http.rest.RequestOptions requestOptions)	Add given labels to a given entity.
Mono<Void>	addOrUpdateBusinessMetadata(String guid, Map<String,Map<String,com.azure.core.util.BinaryData>> body)	Add business metadata to an entity.
Mono<Void>	addOrUpdateBusinessMetadata(String guid, Map<String,Map<String,com.azure.core.util.BinaryData>> body, Boolean overwrite)	Add business metadata to an entity.
Mono<Void>	addOrUpdateBusinessMetadataAttributes(String businessMetadataName, String guid, Map<String,com.azure.core.util.BinaryData> body)	Add or update business metadata attributes.
Mono<com.azure.core.http.rest.Response<Void>>	addOrUpdateBusinessMetadataAttributesWithResponse(String businessMetadataName, String guid, com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)	Add or update business metadata attributes.
Mono<com.azure.core.http.rest.Response<Void>>	addOrUpdateBusinessMetadataWithResponse(String guid, com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)	Add business metadata to an entity.
Mono<EntityMutationResult>	batchCreateOrUpdate(AtlasEntitiesWithExtInfo body)	Create or update entities in bulk.
Mono<EntityMutationResult>	batchCreateOrUpdate(AtlasEntitiesWithExtInfo body, String collectionId, BusinessAttributeUpdateBehavior businessAttributeUpdateBehavior)	Create or update entities in bulk.
Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>	batchCreateOrUpdateWithResponse(com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)	Create or update entities in bulk.
Mono<EntityMutationResult>	batchDelete(List<String> guid)	Delete a list of entities in bulk identified by their GUIDs or unique attributes.
Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>	batchDeleteWithResponse(List<String> guid, com.azure.core.http.rest.RequestOptions requestOptions)	Delete a list of entities in bulk identified by their GUIDs or unique attributes.
Mono<AtlasEntitiesWithExtInfo>	batchGetByUniqueAttributes(String typeName)	Bulk API to retrieve list of entities identified by its unique attributes.
Mono<AtlasEntitiesWithExtInfo>	batchGetByUniqueAttributes(String typeName, Boolean minExtInfo, Boolean ignoreRelationships, String attrNQualifiedName)	Bulk API to retrieve list of entities identified by its unique attributes.
Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>	batchGetByUniqueAttributesWithResponse(String typeName, com.azure.core.http.rest.RequestOptions requestOptions)	Bulk API to retrieve list of entities identified by its unique attributes.
Mono<List<String>>	batchSetClassifications(AtlasEntityHeaders body)	Set classifications on entities in bulk.
Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>	batchSetClassificationsWithResponse(com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)	Set classifications on entities in bulk.
Mono<EntityMutationResult>	createOrUpdate(AtlasEntityWithExtInfo body)	Create or update an entity.
Mono<EntityMutationResult>	createOrUpdate(AtlasEntityWithExtInfo body, BusinessAttributeUpdateBehavior businessAttributeUpdateBehavior, String collectionId)	Create or update an entity.
Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>	createOrUpdateWithResponse(com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)	Create or update an entity.
Mono<EntityMutationResult>	delete(String guid)	Delete an entity identified by its GUID.
Mono<EntityMutationResult>	deleteByUniqueAttribute(String typeName)	Delete an entity identified by its type and unique attributes.
Mono<EntityMutationResult>	deleteByUniqueAttribute(String typeName, String attribute)	Delete an entity identified by its type and unique attributes.
Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>	deleteByUniqueAttributeWithResponse(String typeName, com.azure.core.http.rest.RequestOptions requestOptions)	Delete an entity identified by its type and unique attributes.
Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>	deleteWithResponse(String guid, com.azure.core.http.rest.RequestOptions requestOptions)	Delete an entity identified by its GUID.
Mono<AtlasEntityWithExtInfo>	get(String guid)	Get complete definition of an entity given its GUID.
Mono<AtlasEntityWithExtInfo>	get(String guid, Boolean minExtInfo, Boolean ignoreRelationships)	Get complete definition of an entity given its GUID.
Mono<com.azure.core.util.BinaryData>	getBusinessMetadataTemplate()	Get the sample Template for uploading/creating bulk BusinessMetaData.
Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>	getBusinessMetadataTemplateWithResponse(com.azure.core.http.rest.RequestOptions requestOptions)	Get the sample Template for uploading/creating bulk BusinessMetaData.
Mono<AtlasEntitiesWithExtInfo>	getByIds(List<String> guid)	List entities in bulk identified by its GUIDs.
Mono<AtlasEntitiesWithExtInfo>	getByIds(List<String> guid, Boolean minExtInfo, Boolean ignoreRelationships)	List entities in bulk identified by its GUIDs.
Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>	getByIdsWithResponse(List<String> guid, com.azure.core.http.rest.RequestOptions requestOptions)	List entities in bulk identified by its GUIDs.
Mono<AtlasEntityWithExtInfo>	getByUniqueAttribute(String typeName)	Get complete definition of an entity given its type and unique attribute.
Mono<AtlasEntityWithExtInfo>	getByUniqueAttribute(String typeName, Boolean minExtInfo, Boolean ignoreRelationships, String attribute)	Get complete definition of an entity given its type and unique attribute.
Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>	getByUniqueAttributeWithResponse(String typeName, com.azure.core.http.rest.RequestOptions requestOptions)	Get complete definition of an entity given its type and unique attribute.
Mono<AtlasClassification>	getClassification(String guid, String classificationName)	Get classification for a given entity represented by a GUID.
Mono<AtlasClassifications>	getClassifications(String guid)	List classifications for a given entity represented by a GUID.
Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>	getClassificationsWithResponse(String guid, com.azure.core.http.rest.RequestOptions requestOptions)	List classifications for a given entity represented by a GUID.
Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>	getClassificationWithResponse(String guid, String classificationName, com.azure.core.http.rest.RequestOptions requestOptions)	Get classification for a given entity represented by a GUID.
Mono<AtlasEntityHeader>	getHeader(String guid)	Get entity header given its GUID.
Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>	getHeaderWithResponse(String guid, com.azure.core.http.rest.RequestOptions requestOptions)	Get entity header given its GUID.
Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>	getWithResponse(String guid, com.azure.core.http.rest.RequestOptions requestOptions)	Get complete definition of an entity given its GUID.
Mono<BulkImportResult>	importBusinessMetadata(BusinessMetadataOptions body)	Upload the file for creating Business Metadata in BULK.
Mono<EntityMutationResult>	moveEntitiesToCollection(String collectionId, MoveEntitiesOptions body)	Move existing entities to the target collection.
Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>	moveEntitiesToCollectionWithResponse(String collectionId, com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)	Move existing entities to the target collection.
Mono<Void>	removeBusinessMetadata(String guid, Map<String,Map<String,com.azure.core.util.BinaryData>> body)	Remove business metadata from an entity.
Mono<Void>	removeBusinessMetadataAttributes(String businessMetadataName, String guid, Map<String,com.azure.core.util.BinaryData> body)	Delete business metadata attributes from an entity.
Mono<com.azure.core.http.rest.Response<Void>>	removeBusinessMetadataAttributesWithResponse(String businessMetadataName, String guid, com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)	Delete business metadata attributes from an entity.
Mono<com.azure.core.http.rest.Response<Void>>	removeBusinessMetadataWithResponse(String guid, com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)	Remove business metadata from an entity.
Mono<Void>	removeClassification(String guid, String classificationName)	Delete a given classification from an existing entity represented by a GUID.
Mono<Void>	removeClassificationByUniqueAttribute(String typeName, String classificationName)	Delete a given classification from an entity identified by its type and unique attributes.
Mono<Void>	removeClassificationByUniqueAttribute(String typeName, String classificationName, String attribute)	Delete a given classification from an entity identified by its type and unique attributes.
Mono<com.azure.core.http.rest.Response<Void>>	removeClassificationByUniqueAttributeWithResponse(String typeName, String classificationName, com.azure.core.http.rest.RequestOptions requestOptions)	Delete a given classification from an entity identified by its type and unique attributes.
Mono<com.azure.core.http.rest.Response<Void>>	removeClassificationWithResponse(String guid, String classificationName, com.azure.core.http.rest.RequestOptions requestOptions)	Delete a given classification from an existing entity represented by a GUID.
Mono<Void>	removeLabels(String guid)	Delete given labels to a given entity.
Mono<Void>	removeLabels(String guid, List<String> body)	Delete given labels to a given entity.
Mono<Void>	removeLabelsByUniqueAttribute(String typeName)	Delete given labels to a given entity identified by its type and unique attribute.
Mono<Void>	removeLabelsByUniqueAttribute(String typeName, String attribute, List<String> body)	Delete given labels to a given entity identified by its type and unique attribute.
Mono<com.azure.core.http.rest.Response<Void>>	removeLabelsByUniqueAttributeWithResponse(String typeName, com.azure.core.http.rest.RequestOptions requestOptions)	Delete given labels to a given entity identified by its type and unique attribute.
Mono<com.azure.core.http.rest.Response<Void>>	removeLabelsWithResponse(String guid, com.azure.core.http.rest.RequestOptions requestOptions)	Delete given labels to a given entity.
Mono<Void>	setLabels(String guid)	Set labels to a given entity.
Mono<Void>	setLabels(String guid, List<String> body)	Set labels to a given entity.
Mono<Void>	setLabelsByUniqueAttribute(String typeName)	Set labels to a given entity identified by its type and unique attributes.
Mono<Void>	setLabelsByUniqueAttribute(String typeName, String attribute, List<String> body)	Set labels to a given entity identified by its type and unique attributes.
Mono<com.azure.core.http.rest.Response<Void>>	setLabelsByUniqueAttributeWithResponse(String typeName, com.azure.core.http.rest.RequestOptions requestOptions)	Set labels to a given entity identified by its type and unique attributes.
Mono<com.azure.core.http.rest.Response<Void>>	setLabelsWithResponse(String guid, com.azure.core.http.rest.RequestOptions requestOptions)	Set labels to a given entity.
Mono<EntityMutationResult>	updateAttributeById(String guid, String name, com.azure.core.util.BinaryData body)	Update entity partially - create or update entity attribute identified by its GUID.
Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>	updateAttributeByIdWithResponse(String guid, String name, com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)	Update entity partially - create or update entity attribute identified by its GUID.
Mono<EntityMutationResult>	updateByUniqueAttribute(String typeName, AtlasEntityWithExtInfo body)	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.
Mono<EntityMutationResult>	updateByUniqueAttribute(String typeName, AtlasEntityWithExtInfo body, String attribute)	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.
Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>	updateByUniqueAttributeWithResponse(String typeName, com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)	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.
Mono<Void>	updateClassifications(String guid, List<AtlasClassification> body)	Update classifications to an existing entity represented by a guid.
Mono<Void>	updateClassificationsUniqueByAttribute(String typeName, List<AtlasClassification> body)	Update classification on an entity identified by its type and unique attributes.
Mono<Void>	updateClassificationsUniqueByAttribute(String typeName, List<AtlasClassification> body, String attribute)	Update classification on an entity identified by its type and unique attributes.
Mono<com.azure.core.http.rest.Response<Void>>	updateClassificationsUniqueByAttributeWithResponse(String typeName, com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)	Update classification on an entity identified by its type and unique attributes.
Mono<com.azure.core.http.rest.Response<Void>>	updateClassificationsWithResponse(String guid, com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)	Update classifications to an existing entity represented by a guid.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

createOrUpdateWithResponse

public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> createOrUpdateWithResponse(com.azure.core.util.BinaryData body,
 com.azure.core.http.rest.RequestOptions requestOptions)

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.

Query Parameters

Query Parameters

Name	Type	Required	Description
businessAttributeUpdateBehavior	String	No	Used to define the update behavior for business attributes when updating entities. Allowed values: "ignore", "replace", "merge".
collectionId	String	No	The collection where entities will be moved to. Only specify a value if you need to move an entity to another collection.

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Request Body Schema

 
 {
     referredEntities (Optional): {
         String (Required): {
             attributes (Optional): {
                 String: BinaryData (Required)
             }
             typeName: String (Optional)
             lastModifiedTS: String (Optional)
             businessAttributes (Optional): {
                 String: BinaryData (Required)
             }
             classifications (Optional): [
                  (Optional){
                     attributes (Optional): {
                         String: BinaryData (Required)
                     }
                     typeName: String (Optional)
                     lastModifiedTS: String (Optional)
                     entityGuid: String (Optional)
                     entityStatus: String(ACTIVE/DELETED) (Optional)
                     removePropagationsOnEntityDelete: Boolean (Optional)
                     validityPeriods (Optional): [
                          (Optional){
                             endTime: String (Optional)
                             startTime: String (Optional)
                             timeZone: String (Optional)
                         }
                     ]
                 }
             ]
             createTime: Long (Optional)
             createdBy: String (Optional)
             customAttributes (Optional): {
                 String: String (Required)
             }
             guid: String (Optional)
             homeId: String (Optional)
             collectionId: String (Optional)
             isIncomplete: Boolean (Optional)
             labels (Optional): [
                 String (Optional)
             ]
             meanings (Optional): [
                  (Optional){
                     confidence: Integer (Optional)
                     createdBy: String (Optional)
                     description: String (Optional)
                     displayText: String (Optional)
                     expression: String (Optional)
                     relationGuid: String (Optional)
                     status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) (Optional)
                     steward: String (Optional)
                     termGuid: String (Optional)
                 }
             ]
             provenanceType: Integer (Optional)
             proxy: Boolean (Optional)
             relationshipAttributes (Optional): {
                 String: BinaryData (Required)
             }
             status: String(ACTIVE/DELETED) (Optional)
             updateTime: Long (Optional)
             updatedBy: String (Optional)
             version: Long (Optional)
             contacts (Optional): {
                 String (Required): [
                      (Required){
                         id: String (Optional)
                         info: String (Optional)
                     }
                 ]
             }
         }
     }
     entity (Optional): (recursive schema, see entity above)
 }
 
 

Response Body Schema

 
 {
     guidAssignments (Optional): {
         String: String (Required)
     }
     mutatedEntities (Optional): {
         String (Required): [
              (Required){
                 attributes (Optional): {
                     String: BinaryData (Required)
                 }
                 typeName: String (Optional)
                 lastModifiedTS: String (Optional)
                 classificationNames (Optional): [
                     String (Optional)
                 ]
                 classifications (Optional): [
                      (Optional){
                         attributes (Optional): {
                             String: BinaryData (Required)
                         }
                         typeName: String (Optional)
                         lastModifiedTS: String (Optional)
                         entityGuid: String (Optional)
                         entityStatus: String(ACTIVE/DELETED) (Optional)
                         removePropagationsOnEntityDelete: Boolean (Optional)
                         validityPeriods (Optional): [
                              (Optional){
                                 endTime: String (Optional)
                                 startTime: String (Optional)
                                 timeZone: String (Optional)
                             }
                         ]
                     }
                 ]
                 displayText: String (Optional)
                 guid: String (Optional)
                 isIncomplete: Boolean (Optional)
                 labels (Optional): [
                     String (Optional)
                 ]
                 meaningNames (Optional): [
                     String (Optional)
                 ]
                 meanings (Optional): [
                      (Optional){
                         confidence: Integer (Optional)
                         createdBy: String (Optional)
                         description: String (Optional)
                         displayText: String (Optional)
                         expression: String (Optional)
                         relationGuid: String (Optional)
                         status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) (Optional)
                         steward: String (Optional)
                         termGuid: String (Optional)
                     }
                 ]
                 status: String(ACTIVE/DELETED) (Optional)
             }
         ]
     }
     partialUpdatedEntities (Optional): [
         (recursive schema, see above)
     ]
 }
 
 

Parameters:

body - Body parameter.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the mutation response result of entity along with Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getByIdsWithResponse

public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getByIdsWithResponse(List<String> guid,
 com.azure.core.http.rest.RequestOptions requestOptions)

List entities in bulk identified by its GUIDs.

Query Parameters

Query Parameters

Name	Type	Required	Description
minExtInfo	Boolean	No	Whether to return minimal information for referred entities.
ignoreRelationships	Boolean	No	Whether to ignore relationship attributes.

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Response Body Schema

 
 {
     referredEntities (Optional): {
         String (Required): {
             attributes (Optional): {
                 String: BinaryData (Required)
             }
             typeName: String (Optional)
             lastModifiedTS: String (Optional)
             businessAttributes (Optional): {
                 String: BinaryData (Required)
             }
             classifications (Optional): [
                  (Optional){
                     attributes (Optional): {
                         String: BinaryData (Required)
                     }
                     typeName: String (Optional)
                     lastModifiedTS: String (Optional)
                     entityGuid: String (Optional)
                     entityStatus: String(ACTIVE/DELETED) (Optional)
                     removePropagationsOnEntityDelete: Boolean (Optional)
                     validityPeriods (Optional): [
                          (Optional){
                             endTime: String (Optional)
                             startTime: String (Optional)
                             timeZone: String (Optional)
                         }
                     ]
                 }
             ]
             createTime: Long (Optional)
             createdBy: String (Optional)
             customAttributes (Optional): {
                 String: String (Required)
             }
             guid: String (Optional)
             homeId: String (Optional)
             collectionId: String (Optional)
             isIncomplete: Boolean (Optional)
             labels (Optional): [
                 String (Optional)
             ]
             meanings (Optional): [
                  (Optional){
                     confidence: Integer (Optional)
                     createdBy: String (Optional)
                     description: String (Optional)
                     displayText: String (Optional)
                     expression: String (Optional)
                     relationGuid: String (Optional)
                     status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) (Optional)
                     steward: String (Optional)
                     termGuid: String (Optional)
                 }
             ]
             provenanceType: Integer (Optional)
             proxy: Boolean (Optional)
             relationshipAttributes (Optional): {
                 String: BinaryData (Required)
             }
             status: String(ACTIVE/DELETED) (Optional)
             updateTime: Long (Optional)
             updatedBy: String (Optional)
             version: Long (Optional)
             contacts (Optional): {
                 String (Required): [
                      (Required){
                         id: String (Optional)
                         info: String (Optional)
                     }
                 ]
             }
         }
     }
     entities (Optional): [
         (recursive schema, see above)
     ]
 }
 
 

Parameters:

guid - An array of GUIDs of entities to list.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

an instance of an entity along with extended info - like hive_table, hive_database along with Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

batchCreateOrUpdateWithResponse

public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> batchCreateOrUpdateWithResponse(com.azure.core.util.BinaryData body,
 com.azure.core.http.rest.RequestOptions requestOptions)

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.

Query Parameters

Query Parameters

Name	Type	Required	Description
collectionId	String	No	The collection where entities will be moved to. Only specify a value if you need to move an entity to another collection.
businessAttributeUpdateBehavior	String	No	Used to define the update behavior for business attributes when updating entities. Allowed values: "ignore", "replace", "merge".

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Request Body Schema

 
 {
     referredEntities (Optional): {
         String (Required): {
             attributes (Optional): {
                 String: BinaryData (Required)
             }
             typeName: String (Optional)
             lastModifiedTS: String (Optional)
             businessAttributes (Optional): {
                 String: BinaryData (Required)
             }
             classifications (Optional): [
                  (Optional){
                     attributes (Optional): {
                         String: BinaryData (Required)
                     }
                     typeName: String (Optional)
                     lastModifiedTS: String (Optional)
                     entityGuid: String (Optional)
                     entityStatus: String(ACTIVE/DELETED) (Optional)
                     removePropagationsOnEntityDelete: Boolean (Optional)
                     validityPeriods (Optional): [
                          (Optional){
                             endTime: String (Optional)
                             startTime: String (Optional)
                             timeZone: String (Optional)
                         }
                     ]
                 }
             ]
             createTime: Long (Optional)
             createdBy: String (Optional)
             customAttributes (Optional): {
                 String: String (Required)
             }
             guid: String (Optional)
             homeId: String (Optional)
             collectionId: String (Optional)
             isIncomplete: Boolean (Optional)
             labels (Optional): [
                 String (Optional)
             ]
             meanings (Optional): [
                  (Optional){
                     confidence: Integer (Optional)
                     createdBy: String (Optional)
                     description: String (Optional)
                     displayText: String (Optional)
                     expression: String (Optional)
                     relationGuid: String (Optional)
                     status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) (Optional)
                     steward: String (Optional)
                     termGuid: String (Optional)
                 }
             ]
             provenanceType: Integer (Optional)
             proxy: Boolean (Optional)
             relationshipAttributes (Optional): {
                 String: BinaryData (Required)
             }
             status: String(ACTIVE/DELETED) (Optional)
             updateTime: Long (Optional)
             updatedBy: String (Optional)
             version: Long (Optional)
             contacts (Optional): {
                 String (Required): [
                      (Required){
                         id: String (Optional)
                         info: String (Optional)
                     }
                 ]
             }
         }
     }
     entities (Optional): [
         (recursive schema, see above)
     ]
 }
 
 

Response Body Schema

 
 {
     guidAssignments (Optional): {
         String: String (Required)
     }
     mutatedEntities (Optional): {
         String (Required): [
              (Required){
                 attributes (Optional): {
                     String: BinaryData (Required)
                 }
                 typeName: String (Optional)
                 lastModifiedTS: String (Optional)
                 classificationNames (Optional): [
                     String (Optional)
                 ]
                 classifications (Optional): [
                      (Optional){
                         attributes (Optional): {
                             String: BinaryData (Required)
                         }
                         typeName: String (Optional)
                         lastModifiedTS: String (Optional)
                         entityGuid: String (Optional)
                         entityStatus: String(ACTIVE/DELETED) (Optional)
                         removePropagationsOnEntityDelete: Boolean (Optional)
                         validityPeriods (Optional): [
                              (Optional){
                                 endTime: String (Optional)
                                 startTime: String (Optional)
                                 timeZone: String (Optional)
                             }
                         ]
                     }
                 ]
                 displayText: String (Optional)
                 guid: String (Optional)
                 isIncomplete: Boolean (Optional)
                 labels (Optional): [
                     String (Optional)
                 ]
                 meaningNames (Optional): [
                     String (Optional)
                 ]
                 meanings (Optional): [
                      (Optional){
                         confidence: Integer (Optional)
                         createdBy: String (Optional)
                         description: String (Optional)
                         displayText: String (Optional)
                         expression: String (Optional)
                         relationGuid: String (Optional)
                         status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) (Optional)
                         steward: String (Optional)
                         termGuid: String (Optional)
                     }
                 ]
                 status: String(ACTIVE/DELETED) (Optional)
             }
         ]
     }
     partialUpdatedEntities (Optional): [
         (recursive schema, see above)
     ]
 }
 
 

Parameters:

body - Body parameter.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the mutation response result of entity along with Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

batchDeleteWithResponse

public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> batchDeleteWithResponse(List<String> guid,
 com.azure.core.http.rest.RequestOptions requestOptions)

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

Response Body Schema

 
 {
     guidAssignments (Optional): {
         String: String (Required)
     }
     mutatedEntities (Optional): {
         String (Required): [
              (Required){
                 attributes (Optional): {
                     String: BinaryData (Required)
                 }
                 typeName: String (Optional)
                 lastModifiedTS: String (Optional)
                 classificationNames (Optional): [
                     String (Optional)
                 ]
                 classifications (Optional): [
                      (Optional){
                         attributes (Optional): {
                             String: BinaryData (Required)
                         }
                         typeName: String (Optional)
                         lastModifiedTS: String (Optional)
                         entityGuid: String (Optional)
                         entityStatus: String(ACTIVE/DELETED) (Optional)
                         removePropagationsOnEntityDelete: Boolean (Optional)
                         validityPeriods (Optional): [
                              (Optional){
                                 endTime: String (Optional)
                                 startTime: String (Optional)
                                 timeZone: String (Optional)
                             }
                         ]
                     }
                 ]
                 displayText: String (Optional)
                 guid: String (Optional)
                 isIncomplete: Boolean (Optional)
                 labels (Optional): [
                     String (Optional)
                 ]
                 meaningNames (Optional): [
                     String (Optional)
                 ]
                 meanings (Optional): [
                      (Optional){
                         confidence: Integer (Optional)
                         createdBy: String (Optional)
                         description: String (Optional)
                         displayText: String (Optional)
                         expression: String (Optional)
                         relationGuid: String (Optional)
                         status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) (Optional)
                         steward: String (Optional)
                         termGuid: String (Optional)
                     }
                 ]
                 status: String(ACTIVE/DELETED) (Optional)
             }
         ]
     }
     partialUpdatedEntities (Optional): [
         (recursive schema, see above)
     ]
 }
 
 

Parameters:

guid - An array of GUIDs of entities to delete.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the mutation response result of entity along with Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

addClassificationWithResponse

public Mono<com.azure.core.http.rest.Response<Void>> addClassificationWithResponse(com.azure.core.util.BinaryData body,
 com.azure.core.http.rest.RequestOptions requestOptions)

Associate a classification to multiple entities in bulk.

Request Body Schema

 
 {
     classification (Optional): {
         attributes (Optional): {
             String: BinaryData (Required)
         }
         typeName: String (Optional)
         lastModifiedTS: String (Optional)
         entityGuid: String (Optional)
         entityStatus: String(ACTIVE/DELETED) (Optional)
         removePropagationsOnEntityDelete: Boolean (Optional)
         validityPeriods (Optional): [
              (Optional){
                 endTime: String (Optional)
                 startTime: String (Optional)
                 timeZone: String (Optional)
             }
         ]
     }
     entityGuids (Optional): [
         String (Optional)
     ]
 }
 
 

Parameters:

body - Body parameter.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getWithResponse

public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getWithResponse(String guid,
 com.azure.core.http.rest.RequestOptions requestOptions)

Get complete definition of an entity given its GUID.

Query Parameters

Query Parameters

Name	Type	Required	Description
minExtInfo	Boolean	No	Whether to return minimal information for referred entities.
ignoreRelationships	Boolean	No	Whether to ignore relationship attributes.

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Response Body Schema

 
 {
     referredEntities (Optional): {
         String (Required): {
             attributes (Optional): {
                 String: BinaryData (Required)
             }
             typeName: String (Optional)
             lastModifiedTS: String (Optional)
             businessAttributes (Optional): {
                 String: BinaryData (Required)
             }
             classifications (Optional): [
                  (Optional){
                     attributes (Optional): {
                         String: BinaryData (Required)
                     }
                     typeName: String (Optional)
                     lastModifiedTS: String (Optional)
                     entityGuid: String (Optional)
                     entityStatus: String(ACTIVE/DELETED) (Optional)
                     removePropagationsOnEntityDelete: Boolean (Optional)
                     validityPeriods (Optional): [
                          (Optional){
                             endTime: String (Optional)
                             startTime: String (Optional)
                             timeZone: String (Optional)
                         }
                     ]
                 }
             ]
             createTime: Long (Optional)
             createdBy: String (Optional)
             customAttributes (Optional): {
                 String: String (Required)
             }
             guid: String (Optional)
             homeId: String (Optional)
             collectionId: String (Optional)
             isIncomplete: Boolean (Optional)
             labels (Optional): [
                 String (Optional)
             ]
             meanings (Optional): [
                  (Optional){
                     confidence: Integer (Optional)
                     createdBy: String (Optional)
                     description: String (Optional)
                     displayText: String (Optional)
                     expression: String (Optional)
                     relationGuid: String (Optional)
                     status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) (Optional)
                     steward: String (Optional)
                     termGuid: String (Optional)
                 }
             ]
             provenanceType: Integer (Optional)
             proxy: Boolean (Optional)
             relationshipAttributes (Optional): {
                 String: BinaryData (Required)
             }
             status: String(ACTIVE/DELETED) (Optional)
             updateTime: Long (Optional)
             updatedBy: String (Optional)
             version: Long (Optional)
             contacts (Optional): {
                 String (Required): [
                      (Required){
                         id: String (Optional)
                         info: String (Optional)
                     }
                 ]
             }
         }
     }
     entity (Optional): (recursive schema, see entity above)
 }
 
 

Parameters:

guid - The globally unique identifier of the entity.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

complete definition of an entity given its GUID along with Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

updateAttributeByIdWithResponse

public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> updateAttributeByIdWithResponse(String guid,
 String name,
 com.azure.core.util.BinaryData body,
 com.azure.core.http.rest.RequestOptions requestOptions)

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.

Request Body Schema

 
 BinaryData
 
 

Response Body Schema

 
 {
     guidAssignments (Optional): {
         String: String (Required)
     }
     mutatedEntities (Optional): {
         String (Required): [
              (Required){
                 attributes (Optional): {
                     String: BinaryData (Required)
                 }
                 typeName: String (Optional)
                 lastModifiedTS: String (Optional)
                 classificationNames (Optional): [
                     String (Optional)
                 ]
                 classifications (Optional): [
                      (Optional){
                         attributes (Optional): {
                             String: BinaryData (Required)
                         }
                         typeName: String (Optional)
                         lastModifiedTS: String (Optional)
                         entityGuid: String (Optional)
                         entityStatus: String(ACTIVE/DELETED) (Optional)
                         removePropagationsOnEntityDelete: Boolean (Optional)
                         validityPeriods (Optional): [
                              (Optional){
                                 endTime: String (Optional)
                                 startTime: String (Optional)
                                 timeZone: String (Optional)
                             }
                         ]
                     }
                 ]
                 displayText: String (Optional)
                 guid: String (Optional)
                 isIncomplete: Boolean (Optional)
                 labels (Optional): [
                     String (Optional)
                 ]
                 meaningNames (Optional): [
                     String (Optional)
                 ]
                 meanings (Optional): [
                      (Optional){
                         confidence: Integer (Optional)
                         createdBy: String (Optional)
                         description: String (Optional)
                         displayText: String (Optional)
                         expression: String (Optional)
                         relationGuid: String (Optional)
                         status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) (Optional)
                         steward: String (Optional)
                         termGuid: String (Optional)
                     }
                 ]
                 status: String(ACTIVE/DELETED) (Optional)
             }
         ]
     }
     partialUpdatedEntities (Optional): [
         (recursive schema, see above)
     ]
 }
 
 

Parameters:

guid - The globally unique identifier of the entity.

name - The name of the attribute.

body - The value of the attribute.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the mutation response result of entity along with Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

deleteWithResponse

public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> deleteWithResponse(String guid,
 com.azure.core.http.rest.RequestOptions requestOptions)

Delete an entity identified by its GUID.

Response Body Schema

 
 {
     guidAssignments (Optional): {
         String: String (Required)
     }
     mutatedEntities (Optional): {
         String (Required): [
              (Required){
                 attributes (Optional): {
                     String: BinaryData (Required)
                 }
                 typeName: String (Optional)
                 lastModifiedTS: String (Optional)
                 classificationNames (Optional): [
                     String (Optional)
                 ]
                 classifications (Optional): [
                      (Optional){
                         attributes (Optional): {
                             String: BinaryData (Required)
                         }
                         typeName: String (Optional)
                         lastModifiedTS: String (Optional)
                         entityGuid: String (Optional)
                         entityStatus: String(ACTIVE/DELETED) (Optional)
                         removePropagationsOnEntityDelete: Boolean (Optional)
                         validityPeriods (Optional): [
                              (Optional){
                                 endTime: String (Optional)
                                 startTime: String (Optional)
                                 timeZone: String (Optional)
                             }
                         ]
                     }
                 ]
                 displayText: String (Optional)
                 guid: String (Optional)
                 isIncomplete: Boolean (Optional)
                 labels (Optional): [
                     String (Optional)
                 ]
                 meaningNames (Optional): [
                     String (Optional)
                 ]
                 meanings (Optional): [
                      (Optional){
                         confidence: Integer (Optional)
                         createdBy: String (Optional)
                         description: String (Optional)
                         displayText: String (Optional)
                         expression: String (Optional)
                         relationGuid: String (Optional)
                         status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) (Optional)
                         steward: String (Optional)
                         termGuid: String (Optional)
                     }
                 ]
                 status: String(ACTIVE/DELETED) (Optional)
             }
         ]
     }
     partialUpdatedEntities (Optional): [
         (recursive schema, see above)
     ]
 }
 
 

Parameters:

guid - The globally unique identifier of the entity.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the mutation response result of entity along with Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getClassificationWithResponse

public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getClassificationWithResponse(String guid,
 String classificationName,
 com.azure.core.http.rest.RequestOptions requestOptions)

Get classification for a given entity represented by a GUID.

Response Body Schema

 
 {
     attributes (Optional): {
         String: BinaryData (Required)
     }
     typeName: String (Optional)
     lastModifiedTS: String (Optional)
     entityGuid: String (Optional)
     entityStatus: String(ACTIVE/DELETED) (Optional)
     removePropagationsOnEntityDelete: Boolean (Optional)
     validityPeriods (Optional): [
          (Optional){
             endTime: String (Optional)
             startTime: String (Optional)
             timeZone: String (Optional)
         }
     ]
 }
 
 

Parameters:

guid - The globally unique identifier of the entity.

classificationName - The name of the classification.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

classification for a given entity represented by a GUID along with Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

removeClassificationWithResponse

public Mono<com.azure.core.http.rest.Response<Void>> removeClassificationWithResponse(String guid,
 String classificationName,
 com.azure.core.http.rest.RequestOptions requestOptions)

Delete a given classification from an existing entity represented by a GUID.

Parameters:

guid - The globally unique identifier of the entity.

classificationName - The name of the classification.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getClassificationsWithResponse

public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getClassificationsWithResponse(String guid,
 com.azure.core.http.rest.RequestOptions requestOptions)

List classifications for a given entity represented by a GUID.

Response Body Schema

 
 {
     list (Optional): [
         BinaryData (Optional)
     ]
     pageSize: Integer (Optional)
     sortBy: String (Optional)
     sortType: String(NONE/ASC/DESC) (Optional)
     startIndex: Integer (Optional)
     totalCount: Integer (Optional)
 }
 
 

Parameters:

guid - The globally unique identifier of the entity.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

rEST serialization friendly list along with Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

addClassificationsWithResponse

public Mono<com.azure.core.http.rest.Response<Void>> addClassificationsWithResponse(String guid,
 com.azure.core.util.BinaryData body,
 com.azure.core.http.rest.RequestOptions requestOptions)

Add classifications to an existing entity represented by a GUID.

Request Body Schema

 
 [
      (Required){
         attributes (Optional): {
             String: BinaryData (Required)
         }
         typeName: String (Optional)
         lastModifiedTS: String (Optional)
         entityGuid: String (Optional)
         entityStatus: String(ACTIVE/DELETED) (Optional)
         removePropagationsOnEntityDelete: Boolean (Optional)
         validityPeriods (Optional): [
              (Optional){
                 endTime: String (Optional)
                 startTime: String (Optional)
                 timeZone: String (Optional)
             }
         ]
     }
 ]
 
 

Parameters:

guid - The globally unique identifier of the entity.

body - An array of classifications to be added.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

updateClassificationsWithResponse

public Mono<com.azure.core.http.rest.Response<Void>> updateClassificationsWithResponse(String guid,
 com.azure.core.util.BinaryData body,
 com.azure.core.http.rest.RequestOptions requestOptions)

Update classifications to an existing entity represented by a guid.

Request Body Schema

 
 [
      (Required){
         attributes (Optional): {
             String: BinaryData (Required)
         }
         typeName: String (Optional)
         lastModifiedTS: String (Optional)
         entityGuid: String (Optional)
         entityStatus: String(ACTIVE/DELETED) (Optional)
         removePropagationsOnEntityDelete: Boolean (Optional)
         validityPeriods (Optional): [
              (Optional){
                 endTime: String (Optional)
                 startTime: String (Optional)
                 timeZone: String (Optional)
             }
         ]
     }
 ]
 
 

Parameters:

guid - The globally unique identifier of the entity.

body - An array of classifications to be updated.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getByUniqueAttributeWithResponse

public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getByUniqueAttributeWithResponse(String typeName,
 com.azure.core.http.rest.RequestOptions requestOptions)

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:\<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.

Query Parameters

Query Parameters

Name	Type	Required	Description
minExtInfo	Boolean	No	Whether to return minimal information for referred entities.
ignoreRelationships	Boolean	No	Whether to ignore relationship attributes.
attr:qualifiedName	String	No	The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Response Body Schema

 
 {
     referredEntities (Optional): {
         String (Required): {
             attributes (Optional): {
                 String: BinaryData (Required)
             }
             typeName: String (Optional)
             lastModifiedTS: String (Optional)
             businessAttributes (Optional): {
                 String: BinaryData (Required)
             }
             classifications (Optional): [
                  (Optional){
                     attributes (Optional): {
                         String: BinaryData (Required)
                     }
                     typeName: String (Optional)
                     lastModifiedTS: String (Optional)
                     entityGuid: String (Optional)
                     entityStatus: String(ACTIVE/DELETED) (Optional)
                     removePropagationsOnEntityDelete: Boolean (Optional)
                     validityPeriods (Optional): [
                          (Optional){
                             endTime: String (Optional)
                             startTime: String (Optional)
                             timeZone: String (Optional)
                         }
                     ]
                 }
             ]
             createTime: Long (Optional)
             createdBy: String (Optional)
             customAttributes (Optional): {
                 String: String (Required)
             }
             guid: String (Optional)
             homeId: String (Optional)
             collectionId: String (Optional)
             isIncomplete: Boolean (Optional)
             labels (Optional): [
                 String (Optional)
             ]
             meanings (Optional): [
                  (Optional){
                     confidence: Integer (Optional)
                     createdBy: String (Optional)
                     description: String (Optional)
                     displayText: String (Optional)
                     expression: String (Optional)
                     relationGuid: String (Optional)
                     status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) (Optional)
                     steward: String (Optional)
                     termGuid: String (Optional)
                 }
             ]
             provenanceType: Integer (Optional)
             proxy: Boolean (Optional)
             relationshipAttributes (Optional): {
                 String: BinaryData (Required)
             }
             status: String(ACTIVE/DELETED) (Optional)
             updateTime: Long (Optional)
             updatedBy: String (Optional)
             version: Long (Optional)
             contacts (Optional): {
                 String (Required): [
                      (Required){
                         id: String (Optional)
                         info: String (Optional)
                     }
                 ]
             }
         }
     }
     entity (Optional): (recursive schema, see entity above)
 }
 
 

Parameters:

typeName - The name of the type.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

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:\<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 along with Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

updateByUniqueAttributeWithResponse

public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> updateByUniqueAttributeWithResponse(String typeName,
 com.azure.core.util.BinaryData body,
 com.azure.core.http.rest.RequestOptions requestOptions)

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.

Query Parameters

Query Parameters

Name	Type	Required	Description
attr:qualifiedName	String	No	The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Request Body Schema

 
 {
     referredEntities (Optional): {
         String (Required): {
             attributes (Optional): {
                 String: BinaryData (Required)
             }
             typeName: String (Optional)
             lastModifiedTS: String (Optional)
             businessAttributes (Optional): {
                 String: BinaryData (Required)
             }
             classifications (Optional): [
                  (Optional){
                     attributes (Optional): {
                         String: BinaryData (Required)
                     }
                     typeName: String (Optional)
                     lastModifiedTS: String (Optional)
                     entityGuid: String (Optional)
                     entityStatus: String(ACTIVE/DELETED) (Optional)
                     removePropagationsOnEntityDelete: Boolean (Optional)
                     validityPeriods (Optional): [
                          (Optional){
                             endTime: String (Optional)
                             startTime: String (Optional)
                             timeZone: String (Optional)
                         }
                     ]
                 }
             ]
             createTime: Long (Optional)
             createdBy: String (Optional)
             customAttributes (Optional): {
                 String: String (Required)
             }
             guid: String (Optional)
             homeId: String (Optional)
             collectionId: String (Optional)
             isIncomplete: Boolean (Optional)
             labels (Optional): [
                 String (Optional)
             ]
             meanings (Optional): [
                  (Optional){
                     confidence: Integer (Optional)
                     createdBy: String (Optional)
                     description: String (Optional)
                     displayText: String (Optional)
                     expression: String (Optional)
                     relationGuid: String (Optional)
                     status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) (Optional)
                     steward: String (Optional)
                     termGuid: String (Optional)
                 }
             ]
             provenanceType: Integer (Optional)
             proxy: Boolean (Optional)
             relationshipAttributes (Optional): {
                 String: BinaryData (Required)
             }
             status: String(ACTIVE/DELETED) (Optional)
             updateTime: Long (Optional)
             updatedBy: String (Optional)
             version: Long (Optional)
             contacts (Optional): {
                 String (Required): [
                      (Required){
                         id: String (Optional)
                         info: String (Optional)
                     }
                 ]
             }
         }
     }
     entity (Optional): (recursive schema, see entity above)
 }
 
 

Response Body Schema

 
 {
     guidAssignments (Optional): {
         String: String (Required)
     }
     mutatedEntities (Optional): {
         String (Required): [
              (Required){
                 attributes (Optional): {
                     String: BinaryData (Required)
                 }
                 typeName: String (Optional)
                 lastModifiedTS: String (Optional)
                 classificationNames (Optional): [
                     String (Optional)
                 ]
                 classifications (Optional): [
                      (Optional){
                         attributes (Optional): {
                             String: BinaryData (Required)
                         }
                         typeName: String (Optional)
                         lastModifiedTS: String (Optional)
                         entityGuid: String (Optional)
                         entityStatus: String(ACTIVE/DELETED) (Optional)
                         removePropagationsOnEntityDelete: Boolean (Optional)
                         validityPeriods (Optional): [
                              (Optional){
                                 endTime: String (Optional)
                                 startTime: String (Optional)
                                 timeZone: String (Optional)
                             }
                         ]
                     }
                 ]
                 displayText: String (Optional)
                 guid: String (Optional)
                 isIncomplete: Boolean (Optional)
                 labels (Optional): [
                     String (Optional)
                 ]
                 meaningNames (Optional): [
                     String (Optional)
                 ]
                 meanings (Optional): [
                      (Optional){
                         confidence: Integer (Optional)
                         createdBy: String (Optional)
                         description: String (Optional)
                         displayText: String (Optional)
                         expression: String (Optional)
                         relationGuid: String (Optional)
                         status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) (Optional)
                         steward: String (Optional)
                         termGuid: String (Optional)
                     }
                 ]
                 status: String(ACTIVE/DELETED) (Optional)
             }
         ]
     }
     partialUpdatedEntities (Optional): [
         (recursive schema, see above)
     ]
 }
 
 

Parameters:

typeName - The name of the type.

body - Body parameter.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the mutation response result of entity along with Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

deleteByUniqueAttributeWithResponse

public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> deleteByUniqueAttributeWithResponse(String typeName,
 com.azure.core.http.rest.RequestOptions requestOptions)

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:\<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.

Query Parameters

Query Parameters

Name	Type	Required	Description
attr:qualifiedName	String	No	The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Response Body Schema

 
 {
     guidAssignments (Optional): {
         String: String (Required)
     }
     mutatedEntities (Optional): {
         String (Required): [
              (Required){
                 attributes (Optional): {
                     String: BinaryData (Required)
                 }
                 typeName: String (Optional)
                 lastModifiedTS: String (Optional)
                 classificationNames (Optional): [
                     String (Optional)
                 ]
                 classifications (Optional): [
                      (Optional){
                         attributes (Optional): {
                             String: BinaryData (Required)
                         }
                         typeName: String (Optional)
                         lastModifiedTS: String (Optional)
                         entityGuid: String (Optional)
                         entityStatus: String(ACTIVE/DELETED) (Optional)
                         removePropagationsOnEntityDelete: Boolean (Optional)
                         validityPeriods (Optional): [
                              (Optional){
                                 endTime: String (Optional)
                                 startTime: String (Optional)
                                 timeZone: String (Optional)
                             }
                         ]
                     }
                 ]
                 displayText: String (Optional)
                 guid: String (Optional)
                 isIncomplete: Boolean (Optional)
                 labels (Optional): [
                     String (Optional)
                 ]
                 meaningNames (Optional): [
                     String (Optional)
                 ]
                 meanings (Optional): [
                      (Optional){
                         confidence: Integer (Optional)
                         createdBy: String (Optional)
                         description: String (Optional)
                         displayText: String (Optional)
                         expression: String (Optional)
                         relationGuid: String (Optional)
                         status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) (Optional)
                         steward: String (Optional)
                         termGuid: String (Optional)
                     }
                 ]
                 status: String(ACTIVE/DELETED) (Optional)
             }
         ]
     }
     partialUpdatedEntities (Optional): [
         (recursive schema, see above)
     ]
 }
 
 

Parameters:

typeName - The name of the type.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the mutation response result of entity along with Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

removeClassificationByUniqueAttributeWithResponse

public Mono<com.azure.core.http.rest.Response<Void>> removeClassificationByUniqueAttributeWithResponse(String typeName,
 String classificationName,
 com.azure.core.http.rest.RequestOptions requestOptions)

Delete a given classification from an entity identified by its type and unique attributes.

Query Parameters

Query Parameters

Name	Type	Required	Description
attr:qualifiedName	String	No	The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Parameters:

typeName - The name of the type.

classificationName - The name of the classification.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

addClassificationsByUniqueAttributeWithResponse

public Mono<com.azure.core.http.rest.Response<Void>> addClassificationsByUniqueAttributeWithResponse(String typeName,
 com.azure.core.util.BinaryData body,
 com.azure.core.http.rest.RequestOptions requestOptions)

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

Query Parameters

Query Parameters

Name	Type	Required	Description
attr:qualifiedName	String	No	The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Request Body Schema

 
 [
      (Required){
         attributes (Optional): {
             String: BinaryData (Required)
         }
         typeName: String (Optional)
         lastModifiedTS: String (Optional)
         entityGuid: String (Optional)
         entityStatus: String(ACTIVE/DELETED) (Optional)
         removePropagationsOnEntityDelete: Boolean (Optional)
         validityPeriods (Optional): [
              (Optional){
                 endTime: String (Optional)
                 startTime: String (Optional)
                 timeZone: String (Optional)
             }
         ]
     }
 ]
 
 

Parameters:

typeName - The name of the type.

body - An array of classification to be added.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

updateClassificationsUniqueByAttributeWithResponse

public Mono<com.azure.core.http.rest.Response<Void>> updateClassificationsUniqueByAttributeWithResponse(String typeName,
 com.azure.core.util.BinaryData body,
 com.azure.core.http.rest.RequestOptions requestOptions)

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

Query Parameters

Query Parameters

Name	Type	Required	Description
attr:qualifiedName	String	No	The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Request Body Schema

 
 [
      (Required){
         attributes (Optional): {
             String: BinaryData (Required)
         }
         typeName: String (Optional)
         lastModifiedTS: String (Optional)
         entityGuid: String (Optional)
         entityStatus: String(ACTIVE/DELETED) (Optional)
         removePropagationsOnEntityDelete: Boolean (Optional)
         validityPeriods (Optional): [
              (Optional){
                 endTime: String (Optional)
                 startTime: String (Optional)
                 timeZone: String (Optional)
             }
         ]
     }
 ]
 
 

Parameters:

typeName - The name of the type.

body - An array of classification to be updated.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

batchSetClassificationsWithResponse

public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> batchSetClassificationsWithResponse(com.azure.core.util.BinaryData body,
 com.azure.core.http.rest.RequestOptions requestOptions)

Set classifications on entities in bulk.

Request Body Schema

 
 {
     guidHeaderMap (Optional): {
         String (Required): {
             attributes (Optional): {
                 String: BinaryData (Required)
             }
             typeName: String (Optional)
             lastModifiedTS: String (Optional)
             classificationNames (Optional): [
                 String (Optional)
             ]
             classifications (Optional): [
                  (Optional){
                     attributes (Optional): {
                         String: BinaryData (Required)
                     }
                     typeName: String (Optional)
                     lastModifiedTS: String (Optional)
                     entityGuid: String (Optional)
                     entityStatus: String(ACTIVE/DELETED) (Optional)
                     removePropagationsOnEntityDelete: Boolean (Optional)
                     validityPeriods (Optional): [
                          (Optional){
                             endTime: String (Optional)
                             startTime: String (Optional)
                             timeZone: String (Optional)
                         }
                     ]
                 }
             ]
             displayText: String (Optional)
             guid: String (Optional)
             isIncomplete: Boolean (Optional)
             labels (Optional): [
                 String (Optional)
             ]
             meaningNames (Optional): [
                 String (Optional)
             ]
             meanings (Optional): [
                  (Optional){
                     confidence: Integer (Optional)
                     createdBy: String (Optional)
                     description: String (Optional)
                     displayText: String (Optional)
                     expression: String (Optional)
                     relationGuid: String (Optional)
                     status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) (Optional)
                     steward: String (Optional)
                     termGuid: String (Optional)
                 }
             ]
             status: String(ACTIVE/DELETED) (Optional)
         }
     }
 }
 
 

Response Body Schema

 
 [
     String (Required)
 ]
 
 

Parameters:

body - Body parameter.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the response body along with Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

batchGetByUniqueAttributesWithResponse

public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> batchGetByUniqueAttributesWithResponse(String typeName,
 com.azure.core.http.rest.RequestOptions requestOptions)

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_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1 Note: at least one unique attribute must be provided.

Query Parameters

Query Parameters

Name	Type	Required	Description
minExtInfo	Boolean	No	Whether to return minimal information for referred entities.
ignoreRelationships	Boolean	No	Whether to ignore relationship attributes.
attr_N:qualifiedName	String	No	Qualified name of an entity. E.g. to find 2 entities you can set attrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. (This is only an example. qualifiedName can be changed to other unique attributes)

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Response Body Schema

 
 {
     referredEntities (Optional): {
         String (Required): {
             attributes (Optional): {
                 String: BinaryData (Required)
             }
             typeName: String (Optional)
             lastModifiedTS: String (Optional)
             businessAttributes (Optional): {
                 String: BinaryData (Required)
             }
             classifications (Optional): [
                  (Optional){
                     attributes (Optional): {
                         String: BinaryData (Required)
                     }
                     typeName: String (Optional)
                     lastModifiedTS: String (Optional)
                     entityGuid: String (Optional)
                     entityStatus: String(ACTIVE/DELETED) (Optional)
                     removePropagationsOnEntityDelete: Boolean (Optional)
                     validityPeriods (Optional): [
                          (Optional){
                             endTime: String (Optional)
                             startTime: String (Optional)
                             timeZone: String (Optional)
                         }
                     ]
                 }
             ]
             createTime: Long (Optional)
             createdBy: String (Optional)
             customAttributes (Optional): {
                 String: String (Required)
             }
             guid: String (Optional)
             homeId: String (Optional)
             collectionId: String (Optional)
             isIncomplete: Boolean (Optional)
             labels (Optional): [
                 String (Optional)
             ]
             meanings (Optional): [
                  (Optional){
                     confidence: Integer (Optional)
                     createdBy: String (Optional)
                     description: String (Optional)
                     displayText: String (Optional)
                     expression: String (Optional)
                     relationGuid: String (Optional)
                     status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) (Optional)
                     steward: String (Optional)
                     termGuid: String (Optional)
                 }
             ]
             provenanceType: Integer (Optional)
             proxy: Boolean (Optional)
             relationshipAttributes (Optional): {
                 String: BinaryData (Required)
             }
             status: String(ACTIVE/DELETED) (Optional)
             updateTime: Long (Optional)
             updatedBy: String (Optional)
             version: Long (Optional)
             contacts (Optional): {
                 String (Required): [
                      (Required){
                         id: String (Optional)
                         info: String (Optional)
                     }
                 ]
             }
         }
     }
     entities (Optional): [
         (recursive schema, see above)
     ]
 }
 
 

Parameters:

typeName - The name of the type.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

an instance of an entity along with extended info - like hive_table, hive_database along with Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getHeaderWithResponse

public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getHeaderWithResponse(String guid,
 com.azure.core.http.rest.RequestOptions requestOptions)

Get entity header given its GUID.

Response Body Schema

 
 {
     attributes (Optional): {
         String: BinaryData (Required)
     }
     typeName: String (Optional)
     lastModifiedTS: String (Optional)
     classificationNames (Optional): [
         String (Optional)
     ]
     classifications (Optional): [
          (Optional){
             attributes (Optional): {
                 String: BinaryData (Required)
             }
             typeName: String (Optional)
             lastModifiedTS: String (Optional)
             entityGuid: String (Optional)
             entityStatus: String(ACTIVE/DELETED) (Optional)
             removePropagationsOnEntityDelete: Boolean (Optional)
             validityPeriods (Optional): [
                  (Optional){
                     endTime: String (Optional)
                     startTime: String (Optional)
                     timeZone: String (Optional)
                 }
             ]
         }
     ]
     displayText: String (Optional)
     guid: String (Optional)
     isIncomplete: Boolean (Optional)
     labels (Optional): [
         String (Optional)
     ]
     meaningNames (Optional): [
         String (Optional)
     ]
     meanings (Optional): [
          (Optional){
             confidence: Integer (Optional)
             createdBy: String (Optional)
             description: String (Optional)
             displayText: String (Optional)
             expression: String (Optional)
             relationGuid: String (Optional)
             status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) (Optional)
             steward: String (Optional)
             termGuid: String (Optional)
         }
     ]
     status: String(ACTIVE/DELETED) (Optional)
 }
 
 

Parameters:

guid - The globally unique identifier of the entity.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

entity header given its GUID along with Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

removeBusinessMetadataWithResponse

public Mono<com.azure.core.http.rest.Response<Void>> removeBusinessMetadataWithResponse(String guid,
 com.azure.core.util.BinaryData body,
 com.azure.core.http.rest.RequestOptions requestOptions)

Remove business metadata from an entity.

Request Body Schema

 
 {
     String (Required): {
         String: BinaryData (Required)
     }
 }
 
 

Parameters:

guid - The globally unique identifier of the entity.

body - Business metadata payload.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

addOrUpdateBusinessMetadataWithResponse

public Mono<com.azure.core.http.rest.Response<Void>> addOrUpdateBusinessMetadataWithResponse(String guid,
 com.azure.core.util.BinaryData body,
 com.azure.core.http.rest.RequestOptions requestOptions)

Add business metadata to an entity.

Query Parameters

Query Parameters

Name	Type	Required	Description
isOverwrite	Boolean	No	Whether to overwrite the existing business metadata on the entity or not, default is false.

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Request Body Schema

 
 {
     String (Required): {
         String: BinaryData (Required)
     }
 }
 
 

Parameters:

guid - The globally unique identifier of the entity.

body - BusinessMetadata payload.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

removeBusinessMetadataAttributesWithResponse

public Mono<com.azure.core.http.rest.Response<Void>> removeBusinessMetadataAttributesWithResponse(String businessMetadataName,
 String guid,
 com.azure.core.util.BinaryData body,
 com.azure.core.http.rest.RequestOptions requestOptions)

Delete business metadata attributes from an entity.

Request Body Schema

 
 {
     String: BinaryData (Required)
 }
 
 

Parameters:

businessMetadataName - BusinessMetadata name.

guid - The globally unique identifier of the entity.

body - Business metadata attribute payload.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

addOrUpdateBusinessMetadataAttributesWithResponse

public Mono<com.azure.core.http.rest.Response<Void>> addOrUpdateBusinessMetadataAttributesWithResponse(String businessMetadataName,
 String guid,
 com.azure.core.util.BinaryData body,
 com.azure.core.http.rest.RequestOptions requestOptions)

Add or update business metadata attributes.

Request Body Schema

 
 {
     String: BinaryData (Required)
 }
 
 

Parameters:

businessMetadataName - BusinessMetadata name.

guid - The globally unique identifier of the entity.

body - Business metadata attribute payload.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getBusinessMetadataTemplateWithResponse

public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getBusinessMetadataTemplateWithResponse(com.azure.core.http.rest.RequestOptions requestOptions)

Get the sample Template for uploading/creating bulk BusinessMetaData.

Response Body Schema

 
 BinaryData
 
 

Parameters:

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the sample Template for uploading/creating bulk BusinessMetaData along with Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

removeLabelsWithResponse

public Mono<com.azure.core.http.rest.Response<Void>> removeLabelsWithResponse(String guid,
 com.azure.core.http.rest.RequestOptions requestOptions)

Delete given labels to a given entity.

Header Parameters

Header Parameters

Name	Type	Required	Description
Content-Type	String	No	The content type. Allowed values: "application/json".

You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)

Request Body Schema

 
 [
     String (Optional)
 ]
 
 

Parameters:

guid - The globally unique identifier of the entity.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

setLabelsWithResponse

public Mono<com.azure.core.http.rest.Response<Void>> setLabelsWithResponse(String guid,
 com.azure.core.http.rest.RequestOptions requestOptions)

Set labels to a given entity.

Header Parameters

Header Parameters

Name	Type	Required	Description
Content-Type	String	No	The content type. Allowed values: "application/json".

You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)

Request Body Schema

 
 [
     String (Optional)
 ]
 
 

Parameters:

guid - The globally unique identifier of the entity.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

addLabelWithResponse

public Mono<com.azure.core.http.rest.Response<Void>> addLabelWithResponse(String guid,
 com.azure.core.http.rest.RequestOptions requestOptions)

Add given labels to a given entity.

Header Parameters

Header Parameters

Name	Type	Required	Description
Content-Type	String	No	The content type. Allowed values: "application/json".

You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)

Request Body Schema

 
 [
     String (Optional)
 ]
 
 

Parameters:

guid - The globally unique identifier of the entity.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

removeLabelsByUniqueAttributeWithResponse

public Mono<com.azure.core.http.rest.Response<Void>> removeLabelsByUniqueAttributeWithResponse(String typeName,
 com.azure.core.http.rest.RequestOptions requestOptions)

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.

Query Parameters

Query Parameters

Name	Type	Required	Description
attr:qualifiedName	String	No	The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Header Parameters

Header Parameters

Name	Type	Required	Description
Content-Type	String	No	The content type. Allowed values: "application/json".

You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)

Request Body Schema

 
 [
     String (Optional)
 ]
 
 

Parameters:

typeName - The name of the type.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

setLabelsByUniqueAttributeWithResponse

public Mono<com.azure.core.http.rest.Response<Void>> setLabelsByUniqueAttributeWithResponse(String typeName,
 com.azure.core.http.rest.RequestOptions requestOptions)

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.

Query Parameters

Query Parameters

Name	Type	Required	Description
attr:qualifiedName	String	No	The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Header Parameters

Header Parameters

Name	Type	Required	Description
Content-Type	String	No	The content type. Allowed values: "application/json".

You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)

Request Body Schema

 
 [
     String (Optional)
 ]
 
 

Parameters:

typeName - The name of the type.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

addLabelsByUniqueAttributeWithResponse

public Mono<com.azure.core.http.rest.Response<Void>> addLabelsByUniqueAttributeWithResponse(String typeName,
 com.azure.core.http.rest.RequestOptions requestOptions)

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.

Query Parameters

Query Parameters

Name	Type	Required	Description
attr:qualifiedName	String	No	The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Header Parameters

Header Parameters

Name	Type	Required	Description
Content-Type	String	No	The content type. Allowed values: "application/json".

You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)

Request Body Schema

 
 [
     String (Optional)
 ]
 
 

Parameters:

typeName - The name of the type.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

moveEntitiesToCollectionWithResponse

public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> moveEntitiesToCollectionWithResponse(String collectionId,
 com.azure.core.util.BinaryData body,
 com.azure.core.http.rest.RequestOptions requestOptions)

Move existing entities to the target collection.

Request Body Schema

 
 {
     entityGuids (Optional): [
         String (Optional)
     ]
 }
 
 

Response Body Schema

 
 {
     guidAssignments (Optional): {
         String: String (Required)
     }
     mutatedEntities (Optional): {
         String (Required): [
              (Required){
                 attributes (Optional): {
                     String: BinaryData (Required)
                 }
                 typeName: String (Optional)
                 lastModifiedTS: String (Optional)
                 classificationNames (Optional): [
                     String (Optional)
                 ]
                 classifications (Optional): [
                      (Optional){
                         attributes (Optional): {
                             String: BinaryData (Required)
                         }
                         typeName: String (Optional)
                         lastModifiedTS: String (Optional)
                         entityGuid: String (Optional)
                         entityStatus: String(ACTIVE/DELETED) (Optional)
                         removePropagationsOnEntityDelete: Boolean (Optional)
                         validityPeriods (Optional): [
                              (Optional){
                                 endTime: String (Optional)
                                 startTime: String (Optional)
                                 timeZone: String (Optional)
                             }
                         ]
                     }
                 ]
                 displayText: String (Optional)
                 guid: String (Optional)
                 isIncomplete: Boolean (Optional)
                 labels (Optional): [
                     String (Optional)
                 ]
                 meaningNames (Optional): [
                     String (Optional)
                 ]
                 meanings (Optional): [
                      (Optional){
                         confidence: Integer (Optional)
                         createdBy: String (Optional)
                         description: String (Optional)
                         displayText: String (Optional)
                         expression: String (Optional)
                         relationGuid: String (Optional)
                         status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) (Optional)
                         steward: String (Optional)
                         termGuid: String (Optional)
                     }
                 ]
                 status: String(ACTIVE/DELETED) (Optional)
             }
         ]
     }
     partialUpdatedEntities (Optional): [
         (recursive schema, see above)
     ]
 }
 
 

Parameters:

collectionId - The collection where entities will be moved to.

body - Body parameter.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the mutation response result of entity along with Response on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

createOrUpdate

public Mono<EntityMutationResult> createOrUpdate(AtlasEntityWithExtInfo body,
 BusinessAttributeUpdateBehavior businessAttributeUpdateBehavior,
 String collectionId)

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.

Parameters:

body - Body parameter.

businessAttributeUpdateBehavior - Used to define the update behavior for business attributes when updating entities.

collectionId - The collection where entities will be moved to. Only specify a value if you need to move an entity to another collection.

Returns:

the mutation response result of entity on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdate

public Mono<EntityMutationResult> createOrUpdate(AtlasEntityWithExtInfo body)

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.

Parameters:

body - Body parameter.

Returns:

the mutation response result of entity on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByIds

public Mono<AtlasEntitiesWithExtInfo> getByIds(List<String> guid,
 Boolean minExtInfo,
 Boolean ignoreRelationships)

List entities in bulk identified by its GUIDs.

Parameters:

guid - An array of GUIDs of entities to list.

minExtInfo - Whether to return minimal information for referred entities.

ignoreRelationships - Whether to ignore relationship attributes.

Returns:

an instance of an entity along with extended info - like hive_table, hive_database on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByIds

public Mono<AtlasEntitiesWithExtInfo> getByIds(List<String> guid)

List entities in bulk identified by its GUIDs.

Parameters:

guid - An array of GUIDs of entities to list.

Returns:

an instance of an entity along with extended info - like hive_table, hive_database on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

batchCreateOrUpdate

public Mono<EntityMutationResult> batchCreateOrUpdate(AtlasEntitiesWithExtInfo body,
 String collectionId,
 BusinessAttributeUpdateBehavior businessAttributeUpdateBehavior)

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.

Parameters:

body - Body parameter.

collectionId - The collection where entities will be moved to. Only specify a value if you need to move an entity to another collection.

businessAttributeUpdateBehavior - Used to define the update behavior for business attributes when updating entities.

Returns:

the mutation response result of entity on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

batchCreateOrUpdate

public Mono<EntityMutationResult> batchCreateOrUpdate(AtlasEntitiesWithExtInfo body)

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.

Parameters:

body - Body parameter.

Returns:

the mutation response result of entity on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

batchDelete

public Mono<EntityMutationResult> batchDelete(List<String> guid)

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

Parameters:

guid - An array of GUIDs of entities to delete.

Returns:

the mutation response result of entity on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

addClassification

public Mono<Void> addClassification(ClassificationAssociateOptions body)

Associate a classification to multiple entities in bulk.

Parameters:

body - Body parameter.

Returns:

A Mono that completes when a successful response is received.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

get

public Mono<AtlasEntityWithExtInfo> get(String guid,
 Boolean minExtInfo,
 Boolean ignoreRelationships)

Get complete definition of an entity given its GUID.

Parameters:

guid - The globally unique identifier of the entity.

minExtInfo - Whether to return minimal information for referred entities.

ignoreRelationships - Whether to ignore relationship attributes.

Returns:

complete definition of an entity given its GUID on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

get

public Mono<AtlasEntityWithExtInfo> get(String guid)

Get complete definition of an entity given its GUID.

Parameters:

guid - The globally unique identifier of the entity.

Returns:

complete definition of an entity given its GUID on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

updateAttributeById

public Mono<EntityMutationResult> updateAttributeById(String guid,
 String name,
 com.azure.core.util.BinaryData body)

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.

Parameters:

guid - The globally unique identifier of the entity.

name - The name of the attribute.

body - The value of the attribute.

Returns:

the mutation response result of entity on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

public Mono<EntityMutationResult> delete(String guid)

Delete an entity identified by its GUID.

Parameters:

guid - The globally unique identifier of the entity.

Returns:

the mutation response result of entity on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getClassification

public Mono<AtlasClassification> getClassification(String guid,
 String classificationName)

Get classification for a given entity represented by a GUID.

Parameters:

guid - The globally unique identifier of the entity.

classificationName - The name of the classification.

Returns:

classification for a given entity represented by a GUID on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

removeClassification

public Mono<Void> removeClassification(String guid,
 String classificationName)

Delete a given classification from an existing entity represented by a GUID.

Parameters:

guid - The globally unique identifier of the entity.

classificationName - The name of the classification.

Returns:

A Mono that completes when a successful response is received.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getClassifications

public Mono<AtlasClassifications> getClassifications(String guid)

List classifications for a given entity represented by a GUID.

Parameters:

guid - The globally unique identifier of the entity.

Returns:

rEST serialization friendly list on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

addClassifications

public Mono<Void> addClassifications(String guid,
 List<AtlasClassification> body)

Add classifications to an existing entity represented by a GUID.

Parameters:

guid - The globally unique identifier of the entity.

body - An array of classifications to be added.

Returns:

A Mono that completes when a successful response is received.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

updateClassifications

public Mono<Void> updateClassifications(String guid,
 List<AtlasClassification> body)

Update classifications to an existing entity represented by a guid.

Parameters:

guid - The globally unique identifier of the entity.

body - An array of classifications to be updated.

Returns:

A Mono that completes when a successful response is received.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByUniqueAttribute

public Mono<AtlasEntityWithExtInfo> getByUniqueAttribute(String typeName,
 Boolean minExtInfo,
 Boolean ignoreRelationships,
 String attribute)

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:\<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.

Parameters:

typeName - The name of the type.

minExtInfo - Whether to return minimal information for referred entities.

ignoreRelationships - Whether to ignore relationship attributes.

attribute - The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes).

Returns:

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:\<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 on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByUniqueAttribute

public Mono<AtlasEntityWithExtInfo> getByUniqueAttribute(String typeName)

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:\<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.

Parameters:

typeName - The name of the type.

Returns:

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:\<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 on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

updateByUniqueAttribute

public Mono<EntityMutationResult> updateByUniqueAttribute(String typeName,
 AtlasEntityWithExtInfo body,
 String attribute)

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.

Parameters:

typeName - The name of the type.

body - Body parameter.

attribute - The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes).

Returns:

the mutation response result of entity on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

updateByUniqueAttribute

public Mono<EntityMutationResult> updateByUniqueAttribute(String typeName,
 AtlasEntityWithExtInfo body)

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.

Parameters:

typeName - The name of the type.

body - Body parameter.

Returns:

the mutation response result of entity on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteByUniqueAttribute

public Mono<EntityMutationResult> deleteByUniqueAttribute(String typeName,
 String attribute)

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:\<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.

Parameters:

typeName - The name of the type.

attribute - The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes).

Returns:

the mutation response result of entity on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteByUniqueAttribute

public Mono<EntityMutationResult> deleteByUniqueAttribute(String typeName)

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:\<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.

Parameters:

typeName - The name of the type.

Returns:

the mutation response result of entity on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

removeClassificationByUniqueAttribute

public Mono<Void> removeClassificationByUniqueAttribute(String typeName,
 String classificationName,
 String attribute)

Delete a given classification from an entity identified by its type and unique attributes.

Parameters:

typeName - The name of the type.

classificationName - The name of the classification.

attribute - The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes).

Returns:

A Mono that completes when a successful response is received.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

removeClassificationByUniqueAttribute

public Mono<Void> removeClassificationByUniqueAttribute(String typeName,
 String classificationName)

Delete a given classification from an entity identified by its type and unique attributes.

Parameters:

typeName - The name of the type.

classificationName - The name of the classification.

Returns:

A Mono that completes when a successful response is received.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

addClassificationsByUniqueAttribute

public Mono<Void> addClassificationsByUniqueAttribute(String typeName,
 List<AtlasClassification> body,
 String attribute)

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

Parameters:

typeName - The name of the type.

body - An array of classification to be added.

attribute - The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes).

Returns:

A Mono that completes when a successful response is received.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

addClassificationsByUniqueAttribute

public Mono<Void> addClassificationsByUniqueAttribute(String typeName,
 List<AtlasClassification> body)

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

Parameters:

typeName - The name of the type.

body - An array of classification to be added.

Returns:

A Mono that completes when a successful response is received.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

updateClassificationsUniqueByAttribute

public Mono<Void> updateClassificationsUniqueByAttribute(String typeName,
 List<AtlasClassification> body,
 String attribute)

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

Parameters:

typeName - The name of the type.

body - An array of classification to be updated.

attribute - The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes).

Returns:

A Mono that completes when a successful response is received.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

updateClassificationsUniqueByAttribute

public Mono<Void> updateClassificationsUniqueByAttribute(String typeName,
 List<AtlasClassification> body)

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

Parameters:

typeName - The name of the type.

body - An array of classification to be updated.

Returns:

A Mono that completes when a successful response is received.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

batchSetClassifications

public Mono<List<String>> batchSetClassifications(AtlasEntityHeaders body)

Set classifications on entities in bulk.

Parameters:

body - Body parameter.

Returns:

the response body on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

batchGetByUniqueAttributes

public Mono<AtlasEntitiesWithExtInfo> batchGetByUniqueAttributes(String typeName,
 Boolean minExtInfo,
 Boolean ignoreRelationships,
 String attrNQualifiedName)

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_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1 Note: at least one unique attribute must be provided.

Parameters:

typeName - The name of the type.

minExtInfo - Whether to return minimal information for referred entities.

ignoreRelationships - Whether to ignore relationship attributes.

attrNQualifiedName - Qualified name of an entity. E.g. to find 2 entities you can set attrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. (This is only an example. qualifiedName can be changed to other unique attributes).

Returns:

an instance of an entity along with extended info - like hive_table, hive_database on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

batchGetByUniqueAttributes

public Mono<AtlasEntitiesWithExtInfo> batchGetByUniqueAttributes(String typeName)

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_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1 Note: at least one unique attribute must be provided.

Parameters:

typeName - The name of the type.

Returns:

an instance of an entity along with extended info - like hive_table, hive_database on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getHeader

public Mono<AtlasEntityHeader> getHeader(String guid)

Get entity header given its GUID.

Parameters:

guid - The globally unique identifier of the entity.

Returns:

entity header given its GUID on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

removeBusinessMetadata

public Mono<Void> removeBusinessMetadata(String guid,
 Map<String,Map<String,com.azure.core.util.BinaryData>> body)

Remove business metadata from an entity.

Parameters:

guid - The globally unique identifier of the entity.

body - Business metadata payload.

Returns:

A Mono that completes when a successful response is received.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

addOrUpdateBusinessMetadata

public Mono<Void> addOrUpdateBusinessMetadata(String guid,
 Map<String,Map<String,com.azure.core.util.BinaryData>> body,
 Boolean overwrite)

Add business metadata to an entity.

Parameters:

guid - The globally unique identifier of the entity.

body - BusinessMetadata payload.

overwrite - Whether to overwrite the existing business metadata on the entity or not, default is false.

Returns:

A Mono that completes when a successful response is received.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

addOrUpdateBusinessMetadata

public Mono<Void> addOrUpdateBusinessMetadata(String guid,
 Map<String,Map<String,com.azure.core.util.BinaryData>> body)

Add business metadata to an entity.

Parameters:

guid - The globally unique identifier of the entity.

body - BusinessMetadata payload.

Returns:

A Mono that completes when a successful response is received.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

removeBusinessMetadataAttributes

public Mono<Void> removeBusinessMetadataAttributes(String businessMetadataName,
 String guid,
 Map<String,com.azure.core.util.BinaryData> body)

Delete business metadata attributes from an entity.

Parameters:

businessMetadataName - BusinessMetadata name.

guid - The globally unique identifier of the entity.

body - Business metadata attribute payload.

Returns:

A Mono that completes when a successful response is received.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

addOrUpdateBusinessMetadataAttributes

public Mono<Void> addOrUpdateBusinessMetadataAttributes(String businessMetadataName,
 String guid,
 Map<String,com.azure.core.util.BinaryData> body)

Add or update business metadata attributes.

Parameters:

businessMetadataName - BusinessMetadata name.

guid - The globally unique identifier of the entity.

body - Business metadata attribute payload.

Returns:

A Mono that completes when a successful response is received.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getBusinessMetadataTemplate

public Mono<com.azure.core.util.BinaryData> getBusinessMetadataTemplate()

Get the sample Template for uploading/creating bulk BusinessMetaData.

Returns:

the sample Template for uploading/creating bulk BusinessMetaData on successful completion of Mono.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

importBusinessMetadata

public Mono<BulkImportResult> importBusinessMetadata(BusinessMetadataOptions body)

Upload the file for creating Business Metadata in BULK.

Parameters:

body - Body parameter.

Returns:

bulk import result on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

removeLabels

public Mono<Void> removeLabels(String guid,
 List<String> body)

Delete given labels to a given entity.

Parameters:

guid - The globally unique identifier of the entity.

body - set of labels to be deleted.

Returns:

A Mono that completes when a successful response is received.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

removeLabels

public Mono<Void> removeLabels(String guid)

Delete given labels to a given entity.

Parameters:

guid - The globally unique identifier of the entity.

Returns:

A Mono that completes when a successful response is received.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

setLabels

public Mono<Void> setLabels(String guid,
 List<String> body)

Set labels to a given entity.

Parameters:

guid - The globally unique identifier of the entity.

body - set of labels to be set to the entity.

Returns:

A Mono that completes when a successful response is received.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

setLabels

public Mono<Void> setLabels(String guid)

Set labels to a given entity.

Parameters:

guid - The globally unique identifier of the entity.

Returns:

A Mono that completes when a successful response is received.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

addLabel

public Mono<Void> addLabel(String guid,
 List<String> body)

Add given labels to a given entity.

Parameters:

guid - The globally unique identifier of the entity.

body - set of labels to be added.

Returns:

A Mono that completes when a successful response is received.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

addLabel

public Mono<Void> addLabel(String guid)

Add given labels to a given entity.

Parameters:

guid - The globally unique identifier of the entity.

Returns:

A Mono that completes when a successful response is received.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

removeLabelsByUniqueAttribute

public Mono<Void> removeLabelsByUniqueAttribute(String typeName,
 String attribute,
 List<String> body)

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.

Parameters:

typeName - The name of the type.

attribute - The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes).

body - set of labels to be deleted.

Returns:

A Mono that completes when a successful response is received.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

removeLabelsByUniqueAttribute

public Mono<Void> removeLabelsByUniqueAttribute(String typeName)

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.

Parameters:

typeName - The name of the type.

Returns:

A Mono that completes when a successful response is received.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

setLabelsByUniqueAttribute

public Mono<Void> setLabelsByUniqueAttribute(String typeName,
 String attribute,
 List<String> body)

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.

Parameters:

typeName - The name of the type.

attribute - The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes).

body - set of labels to be set.

Returns:

A Mono that completes when a successful response is received.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

setLabelsByUniqueAttribute

public Mono<Void> setLabelsByUniqueAttribute(String typeName)

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.

Parameters:

typeName - The name of the type.

Returns:

A Mono that completes when a successful response is received.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

addLabelsByUniqueAttribute

public Mono<Void> addLabelsByUniqueAttribute(String typeName,
 String attribute,
 List<String> body)

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.

Parameters:

typeName - The name of the type.

attribute - The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes).

body - set of labels to be added.

Returns:

A Mono that completes when a successful response is received.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

addLabelsByUniqueAttribute

public Mono<Void> addLabelsByUniqueAttribute(String typeName)

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.

Parameters:

typeName - The name of the type.

Returns:

A Mono that completes when a successful response is received.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

moveEntitiesToCollection

public Mono<EntityMutationResult> moveEntitiesToCollection(String collectionId,
 MoveEntitiesOptions body)

Move existing entities to the target collection.

Parameters:

collectionId - The collection where entities will be moved to.

body - Body parameter.

Returns:

the mutation response result of entity on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.