Class EntityClient
-
Method Summary
Modifier and TypeMethodDescriptioncom.azure.core.http.rest.Response<Void>
addClassificationsByUniqueAttributeWithResponse
(String typeName, com.azure.core.util.BinaryData atlasClassificationArray, com.azure.core.http.rest.RequestOptions requestOptions) Add classification to the entity identified by its type and unique attributes.com.azure.core.http.rest.Response<Void>
addClassificationsWithResponse
(String guid, com.azure.core.util.BinaryData classifications, com.azure.core.http.rest.RequestOptions requestOptions) Add classifications to an existing entity represented by a GUID.com.azure.core.http.rest.Response<Void>
addClassificationWithResponse
(com.azure.core.util.BinaryData request, com.azure.core.http.rest.RequestOptions requestOptions) Associate a classification to multiple entities in bulk.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.com.azure.core.http.rest.Response<Void>
addLabelWithResponse
(String guid, com.azure.core.http.rest.RequestOptions requestOptions) add given labels to a given entity.com.azure.core.http.rest.Response<Void>
addOrUpdateBusinessMetadataAttributesWithResponse
(String bmName, String guid, com.azure.core.http.rest.RequestOptions requestOptions) Add or update business metadata attributes.com.azure.core.http.rest.Response<Void>
addOrUpdateBusinessMetadataWithResponse
(String guid, com.azure.core.http.rest.RequestOptions requestOptions) Add business metadata to an entity.com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>
createOrUpdateEntitiesWithResponse
(com.azure.core.util.BinaryData entities, com.azure.core.http.rest.RequestOptions requestOptions) Create or update entities in Atlas in bulk.com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>
createOrUpdateWithResponse
(com.azure.core.util.BinaryData entity, com.azure.core.http.rest.RequestOptions requestOptions) Create or update an entity in Atlas.com.azure.core.http.rest.Response<Void>
deleteBusinessMetadataAttributesWithResponse
(String bmName, String guid, com.azure.core.http.rest.RequestOptions requestOptions) Delete business metadata attributes from an entity.com.azure.core.http.rest.Response<Void>
deleteBusinessMetadataWithResponse
(String guid, com.azure.core.http.rest.RequestOptions requestOptions) Remove business metadata from an entity.com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>
deleteByGuidsWithResponse
(List<String> guids, com.azure.core.http.rest.RequestOptions requestOptions) Delete a list of entities in bulk identified by their GUIDs or unique attributes.com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>
deleteByGuidWithResponse
(String guid, com.azure.core.http.rest.RequestOptions requestOptions) Delete an entity identified by its GUID.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.com.azure.core.http.rest.Response<Void>
deleteClassificationByUniqueAttributeWithResponse
(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.com.azure.core.http.rest.Response<Void>
deleteClassificationWithResponse
(String guid, String classificationName, com.azure.core.http.rest.RequestOptions requestOptions) Delete a given classification from an existing entity represented by a GUID.com.azure.core.http.rest.Response<Void>
deleteLabelsByUniqueAttributeWithResponse
(String typeName, com.azure.core.http.rest.RequestOptions requestOptions) Delete given labels to a given entity identified by its type and unique attributes, if labels is null/empty, no labels will be removed.com.azure.core.http.rest.Response<Void>
deleteLabelsWithResponse
(String guid, com.azure.core.http.rest.RequestOptions requestOptions) delete given labels to a given entity.com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>
getByGuidWithResponse
(String guid, com.azure.core.http.rest.RequestOptions requestOptions) Get complete definition of an entity given its GUID.com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>
getByUniqueAttributesWithResponse
(String typeName, com.azure.core.http.rest.RequestOptions requestOptions) Get complete definition of an entity given its type and unique attribute.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.com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>
getClassificationWithResponse
(String guid, String classificationName, com.azure.core.http.rest.RequestOptions requestOptions) List classifications for a given entity represented by a GUID.com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>
getEntitiesByUniqueAttributesWithResponse
(String typeName, com.azure.core.http.rest.RequestOptions requestOptions) Bulk API to retrieve list of entities identified by its unique attributes.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.com.azure.core.http.rest.Response<Void>
getSampleBusinessMetadataTemplateWithResponse
(com.azure.core.http.rest.RequestOptions requestOptions) Get the sample Template for uploading/creating bulk BusinessMetaData.com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>
importBusinessMetadataWithResponse
(com.azure.core.http.rest.RequestOptions requestOptions) Upload the file for creating Business Metadata in BULK.com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>
listByGuidsWithResponse
(List<String> guids, com.azure.core.http.rest.RequestOptions requestOptions) List entities in bulk identified by its GUIDs.com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>
partialUpdateEntityAttributeByGuidWithResponse
(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.com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>
partialUpdateEntityByUniqueAttributesWithResponse
(String typeName, com.azure.core.util.BinaryData atlasEntityWithExtInfo, 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.com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>
setClassificationsWithResponse
(com.azure.core.util.BinaryData entityHeaders, com.azure.core.http.rest.RequestOptions requestOptions) Set classifications on entities in bulk.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.com.azure.core.http.rest.Response<Void>
setLabelsWithResponse
(String guid, com.azure.core.http.rest.RequestOptions requestOptions) Set labels to a given entity.com.azure.core.http.rest.Response<Void>
updateClassificationsByUniqueAttributeWithResponse
(String typeName, com.azure.core.util.BinaryData atlasClassificationArray, com.azure.core.http.rest.RequestOptions requestOptions) Update classification on an entity identified by its type and unique attributes.com.azure.core.http.rest.Response<Void>
updateClassificationsWithResponse
(String guid, com.azure.core.util.BinaryData classifications, com.azure.core.http.rest.RequestOptions requestOptions) Update classifications to an existing entity represented by a guid.
-
Method Details
-
createOrUpdateWithResponse
public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> createOrUpdateWithResponse(com.azure.core.util.BinaryData entity, com.azure.core.http.rest.RequestOptions requestOptions) Create or update an entity in Atlas. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. Map and array of collections are not well supported. E.g., array<array<int>>, array<map<string, int>>.Request Body Schema
{ referredEntities: { String: { attributes: { String: Object } typeName: String lastModifiedTS: String businessAttributes: { String: Object } classifications: [ { attributes: { String: Object } typeName: String lastModifiedTS: String entityGuid: String entityStatus: String(ACTIVE/DELETED) removePropagationsOnEntityDelete: Boolean validityPeriods: [ { endTime: String startTime: String timeZone: String } ] source: String sourceDetails: { String: Object } } ] createTime: Float createdBy: String customAttributes: { String: String } guid: String homeId: String isIncomplete: Boolean labels: [ String ] meanings: [ { confidence: Integer createdBy: String description: String displayText: String expression: String relationGuid: String source: String status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) steward: String termGuid: String } ] provenanceType: Float proxy: Boolean relationshipAttributes: { String: Object } status: String(ACTIVE/DELETED) updateTime: Float updatedBy: String version: Float source: String sourceDetails: { String: Object } contacts: { String: [ { id: String info: String } ] } } } entity: (recursive schema, see entity above) }
Response Body Schema
{ guidAssignments: { String: String } mutatedEntities: { String: [ { attributes: { String: Object } typeName: String lastModifiedTS: String classificationNames: [ String ] classifications: [ { attributes: { String: Object } typeName: String lastModifiedTS: String entityGuid: String entityStatus: String(ACTIVE/DELETED) removePropagationsOnEntityDelete: Boolean validityPeriods: [ { endTime: String startTime: String timeZone: String } ] source: String sourceDetails: { String: Object } } ] displayText: String guid: String isIncomplete: Boolean labels: [ String ] meaningNames: [ String ] meanings: [ { confidence: Integer createdBy: String description: String displayText: String expression: String relationGuid: String source: String status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) steward: String termGuid: String } ] status: String(ACTIVE/DELETED) } ] } partialUpdatedEntities: [ (recursive schema, see above) ] }
- Parameters:
entity
- Atlas entity with extended information.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- entityMutationResponse along with
Response
. - 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.
-
listByGuidsWithResponse
public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> listByGuidsWithResponse(List<String> guids, 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. excludeRelationshipTypes List<String> No An array of the relationship types need to be excluded from the response. Call RequestOptions.addQueryParam(java.lang.String, java.lang.String)
to add string to array.Response Body Schema
{ referredEntities: { String: { attributes: { String: Object } typeName: String lastModifiedTS: String businessAttributes: { String: Object } classifications: [ { attributes: { String: Object } typeName: String lastModifiedTS: String entityGuid: String entityStatus: String(ACTIVE/DELETED) removePropagationsOnEntityDelete: Boolean validityPeriods: [ { endTime: String startTime: String timeZone: String } ] source: String sourceDetails: { String: Object } } ] createTime: Float createdBy: String customAttributes: { String: String } guid: String homeId: String isIncomplete: Boolean labels: [ String ] meanings: [ { confidence: Integer createdBy: String description: String displayText: String expression: String relationGuid: String source: String status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) steward: String termGuid: String } ] provenanceType: Float proxy: Boolean relationshipAttributes: { String: Object } status: String(ACTIVE/DELETED) updateTime: Float updatedBy: String version: Float source: String sourceDetails: { String: Object } contacts: { String: [ { id: String info: String } ] } } } entities: [ (recursive schema, see above) ] }
- Parameters:
guids
- An array of GUIDs of entities to list.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- atlasEntitiesWithExtInfo along with
Response
. - 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.
-
createOrUpdateEntitiesWithResponse
public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> createOrUpdateEntitiesWithResponse(com.azure.core.util.BinaryData entities, com.azure.core.http.rest.RequestOptions requestOptions) Create or update entities in Atlas in bulk. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. Map and array of collections are not well supported. E.g., array<array<int>>, array<map<string, int>>.Request Body Schema
{ referredEntities: { String: { attributes: { String: Object } typeName: String lastModifiedTS: String businessAttributes: { String: Object } classifications: [ { attributes: { String: Object } typeName: String lastModifiedTS: String entityGuid: String entityStatus: String(ACTIVE/DELETED) removePropagationsOnEntityDelete: Boolean validityPeriods: [ { endTime: String startTime: String timeZone: String } ] source: String sourceDetails: { String: Object } } ] createTime: Float createdBy: String customAttributes: { String: String } guid: String homeId: String isIncomplete: Boolean labels: [ String ] meanings: [ { confidence: Integer createdBy: String description: String displayText: String expression: String relationGuid: String source: String status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) steward: String termGuid: String } ] provenanceType: Float proxy: Boolean relationshipAttributes: { String: Object } status: String(ACTIVE/DELETED) updateTime: Float updatedBy: String version: Float source: String sourceDetails: { String: Object } contacts: { String: [ { id: String info: String } ] } } } entities: [ (recursive schema, see above) ] }
Response Body Schema
{ guidAssignments: { String: String } mutatedEntities: { String: [ { attributes: { String: Object } typeName: String lastModifiedTS: String classificationNames: [ String ] classifications: [ { attributes: { String: Object } typeName: String lastModifiedTS: String entityGuid: String entityStatus: String(ACTIVE/DELETED) removePropagationsOnEntityDelete: Boolean validityPeriods: [ { endTime: String startTime: String timeZone: String } ] source: String sourceDetails: { String: Object } } ] displayText: String guid: String isIncomplete: Boolean labels: [ String ] meaningNames: [ String ] meanings: [ { confidence: Integer createdBy: String description: String displayText: String expression: String relationGuid: String source: String status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) steward: String termGuid: String } ] status: String(ACTIVE/DELETED) } ] } partialUpdatedEntities: [ (recursive schema, see above) ] }
- Parameters:
entities
- An array of entities to create or update.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- entityMutationResponse along with
Response
. - 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.
-
deleteByGuidsWithResponse
public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> deleteByGuidsWithResponse(List<String> guids, 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: { String: String } mutatedEntities: { String: [ { attributes: { String: Object } typeName: String lastModifiedTS: String classificationNames: [ String ] classifications: [ { attributes: { String: Object } typeName: String lastModifiedTS: String entityGuid: String entityStatus: String(ACTIVE/DELETED) removePropagationsOnEntityDelete: Boolean validityPeriods: [ { endTime: String startTime: String timeZone: String } ] source: String sourceDetails: { String: Object } } ] displayText: String guid: String isIncomplete: Boolean labels: [ String ] meaningNames: [ String ] meanings: [ { confidence: Integer createdBy: String description: String displayText: String expression: String relationGuid: String source: String status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) steward: String termGuid: String } ] status: String(ACTIVE/DELETED) } ] } partialUpdatedEntities: [ (recursive schema, see above) ] }
- Parameters:
guids
- An array of GUIDs of entities to delete.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- entityMutationResponse along with
Response
. - 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 com.azure.core.http.rest.Response<Void> addClassificationWithResponse(com.azure.core.util.BinaryData request, com.azure.core.http.rest.RequestOptions requestOptions) Associate a classification to multiple entities in bulk.Request Body Schema
{ classification: { attributes: { String: Object } typeName: String lastModifiedTS: String entityGuid: String entityStatus: String(ACTIVE/DELETED) removePropagationsOnEntityDelete: Boolean validityPeriods: [ { endTime: String startTime: String timeZone: String } ] source: String sourceDetails: { String: Object } } entityGuids: [ String ] }
- Parameters:
request
- The request to associate a classification to multiple entities.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- the
Response
. - 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.
-
getByGuidWithResponse
public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getByGuidWithResponse(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. Response Body Schema
{ referredEntities: { String: { attributes: { String: Object } typeName: String lastModifiedTS: String businessAttributes: { String: Object } classifications: [ { attributes: { String: Object } typeName: String lastModifiedTS: String entityGuid: String entityStatus: String(ACTIVE/DELETED) removePropagationsOnEntityDelete: Boolean validityPeriods: [ { endTime: String startTime: String timeZone: String } ] source: String sourceDetails: { String: Object } } ] createTime: Float createdBy: String customAttributes: { String: String } guid: String homeId: String isIncomplete: Boolean labels: [ String ] meanings: [ { confidence: Integer createdBy: String description: String displayText: String expression: String relationGuid: String source: String status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) steward: String termGuid: String } ] provenanceType: Float proxy: Boolean relationshipAttributes: { String: Object } status: String(ACTIVE/DELETED) updateTime: Float updatedBy: String version: Float source: String sourceDetails: { String: Object } contacts: { String: [ { id: String info: String } ] } } } entity: (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
. - 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.
-
partialUpdateEntityAttributeByGuidWithResponse
public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> partialUpdateEntityAttributeByGuidWithResponse(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
Object
Response Body Schema
{ guidAssignments: { String: String } mutatedEntities: { String: [ { attributes: { String: Object } typeName: String lastModifiedTS: String classificationNames: [ String ] classifications: [ { attributes: { String: Object } typeName: String lastModifiedTS: String entityGuid: String entityStatus: String(ACTIVE/DELETED) removePropagationsOnEntityDelete: Boolean validityPeriods: [ { endTime: String startTime: String timeZone: String } ] source: String sourceDetails: { String: Object } } ] displayText: String guid: String isIncomplete: Boolean labels: [ String ] meaningNames: [ String ] meanings: [ { confidence: Integer createdBy: String description: String displayText: String expression: String relationGuid: String source: String status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) steward: String termGuid: String } ] status: String(ACTIVE/DELETED) } ] } partialUpdatedEntities: [ (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:
- entityMutationResponse along with
Response
. - 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.
-
deleteByGuidWithResponse
public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> deleteByGuidWithResponse(String guid, com.azure.core.http.rest.RequestOptions requestOptions) Delete an entity identified by its GUID.Response Body Schema
{ guidAssignments: { String: String } mutatedEntities: { String: [ { attributes: { String: Object } typeName: String lastModifiedTS: String classificationNames: [ String ] classifications: [ { attributes: { String: Object } typeName: String lastModifiedTS: String entityGuid: String entityStatus: String(ACTIVE/DELETED) removePropagationsOnEntityDelete: Boolean validityPeriods: [ { endTime: String startTime: String timeZone: String } ] source: String sourceDetails: { String: Object } } ] displayText: String guid: String isIncomplete: Boolean labels: [ String ] meaningNames: [ String ] meanings: [ { confidence: Integer createdBy: String description: String displayText: String expression: String relationGuid: String source: String status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) steward: String termGuid: String } ] status: String(ACTIVE/DELETED) } ] } partialUpdatedEntities: [ (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:
- entityMutationResponse along with
Response
. - 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 com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getClassificationWithResponse(String guid, String classificationName, com.azure.core.http.rest.RequestOptions requestOptions) List classifications for a given entity represented by a GUID.Response Body Schema
{ attributes: { String: Object } typeName: String lastModifiedTS: String entityGuid: String entityStatus: String(ACTIVE/DELETED) removePropagationsOnEntityDelete: Boolean validityPeriods: [ { endTime: String startTime: String timeZone: String } ] source: String sourceDetails: { String: Object } }
- 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:
- atlasClassification along with
Response
. - 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.
-
deleteClassificationWithResponse
public com.azure.core.http.rest.Response<Void> deleteClassificationWithResponse(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
. - 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 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: [ Object ] pageSize: Integer sortBy: String sortType: String(NONE/ASC/DESC) startIndex: Long totalCount: Long }
- Parameters:
guid
- The globally unique identifier of the entity.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- atlasClassifications along with
Response
. - 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 com.azure.core.http.rest.Response<Void> addClassificationsWithResponse(String guid, com.azure.core.util.BinaryData classifications, com.azure.core.http.rest.RequestOptions requestOptions) Add classifications to an existing entity represented by a GUID.Request Body Schema
[ { attributes: { String: Object } typeName: String lastModifiedTS: String entityGuid: String entityStatus: String(ACTIVE/DELETED) removePropagationsOnEntityDelete: Boolean validityPeriods: [ { endTime: String startTime: String timeZone: String } ] source: String sourceDetails: { String: Object } } ]
- Parameters:
guid
- The globally unique identifier of the entity.classifications
- An array of classifications to be added.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- the
Response
. - 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 com.azure.core.http.rest.Response<Void> updateClassificationsWithResponse(String guid, com.azure.core.util.BinaryData classifications, com.azure.core.http.rest.RequestOptions requestOptions) Update classifications to an existing entity represented by a guid.Request Body Schema
[ { attributes: { String: Object } typeName: String lastModifiedTS: String entityGuid: String entityStatus: String(ACTIVE/DELETED) removePropagationsOnEntityDelete: Boolean validityPeriods: [ { endTime: String startTime: String timeZone: String } ] source: String sourceDetails: { String: Object } } ]
- Parameters:
guid
- The globally unique identifier of the entity.classifications
- An array of classifications to be updated.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- the
Response
. - 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.
-
getByUniqueAttributesWithResponse
public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getByUniqueAttributesWithResponse(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. Response Body Schema
{ referredEntities: { String: { attributes: { String: Object } typeName: String lastModifiedTS: String businessAttributes: { String: Object } classifications: [ { attributes: { String: Object } typeName: String lastModifiedTS: String entityGuid: String entityStatus: String(ACTIVE/DELETED) removePropagationsOnEntityDelete: Boolean validityPeriods: [ { endTime: String startTime: String timeZone: String } ] source: String sourceDetails: { String: Object } } ] createTime: Float createdBy: String customAttributes: { String: String } guid: String homeId: String isIncomplete: Boolean labels: [ String ] meanings: [ { confidence: Integer createdBy: String description: String displayText: String expression: String relationGuid: String source: String status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) steward: String termGuid: String } ] provenanceType: Float proxy: Boolean relationshipAttributes: { String: Object } status: String(ACTIVE/DELETED) updateTime: Float updatedBy: String version: Float source: String sourceDetails: { String: Object } contacts: { String: [ { id: String info: String } ] } } } entity: (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> along with
Response
. - 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.
-
partialUpdateEntityByUniqueAttributesWithResponse
public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> partialUpdateEntityByUniqueAttributesWithResponse(String typeName, com.azure.core.util.BinaryData atlasEntityWithExtInfo, 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. Request Body Schema
{ referredEntities: { String: { attributes: { String: Object } typeName: String lastModifiedTS: String businessAttributes: { String: Object } classifications: [ { attributes: { String: Object } typeName: String lastModifiedTS: String entityGuid: String entityStatus: String(ACTIVE/DELETED) removePropagationsOnEntityDelete: Boolean validityPeriods: [ { endTime: String startTime: String timeZone: String } ] source: String sourceDetails: { String: Object } } ] createTime: Float createdBy: String customAttributes: { String: String } guid: String homeId: String isIncomplete: Boolean labels: [ String ] meanings: [ { confidence: Integer createdBy: String description: String displayText: String expression: String relationGuid: String source: String status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) steward: String termGuid: String } ] provenanceType: Float proxy: Boolean relationshipAttributes: { String: Object } status: String(ACTIVE/DELETED) updateTime: Float updatedBy: String version: Float source: String sourceDetails: { String: Object } contacts: { String: [ { id: String info: String } ] } } } entity: (recursive schema, see entity above) }
Response Body Schema
{ guidAssignments: { String: String } mutatedEntities: { String: [ { attributes: { String: Object } typeName: String lastModifiedTS: String classificationNames: [ String ] classifications: [ { attributes: { String: Object } typeName: String lastModifiedTS: String entityGuid: String entityStatus: String(ACTIVE/DELETED) removePropagationsOnEntityDelete: Boolean validityPeriods: [ { endTime: String startTime: String timeZone: String } ] source: String sourceDetails: { String: Object } } ] displayText: String guid: String isIncomplete: Boolean labels: [ String ] meaningNames: [ String ] meanings: [ { confidence: Integer createdBy: String description: String displayText: String expression: String relationGuid: String source: String status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) steward: String termGuid: String } ] status: String(ACTIVE/DELETED) } ] } partialUpdatedEntities: [ (recursive schema, see above) ] }
- Parameters:
typeName
- The name of the type.atlasEntityWithExtInfo
- Atlas entity with extended information.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- entityMutationResponse along with
Response
. - 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 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. Response Body Schema
{ guidAssignments: { String: String } mutatedEntities: { String: [ { attributes: { String: Object } typeName: String lastModifiedTS: String classificationNames: [ String ] classifications: [ { attributes: { String: Object } typeName: String lastModifiedTS: String entityGuid: String entityStatus: String(ACTIVE/DELETED) removePropagationsOnEntityDelete: Boolean validityPeriods: [ { endTime: String startTime: String timeZone: String } ] source: String sourceDetails: { String: Object } } ] displayText: String guid: String isIncomplete: Boolean labels: [ String ] meaningNames: [ String ] meanings: [ { confidence: Integer createdBy: String description: String displayText: String expression: String relationGuid: String source: String status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) steward: String termGuid: String } ] status: String(ACTIVE/DELETED) } ] } partialUpdatedEntities: [ (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:
- entityMutationResponse along with
Response
. - 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.
-
deleteClassificationByUniqueAttributeWithResponse
public com.azure.core.http.rest.Response<Void> deleteClassificationByUniqueAttributeWithResponse(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. - 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
. - 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 com.azure.core.http.rest.Response<Void> addClassificationsByUniqueAttributeWithResponse(String typeName, com.azure.core.util.BinaryData atlasClassificationArray, 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. Request Body Schema
[ { attributes: { String: Object } typeName: String lastModifiedTS: String entityGuid: String entityStatus: String(ACTIVE/DELETED) removePropagationsOnEntityDelete: Boolean validityPeriods: [ { endTime: String startTime: String timeZone: String } ] source: String sourceDetails: { String: Object } } ]
- Parameters:
typeName
- The name of the type.atlasClassificationArray
- An array of classification to be added.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- the
Response
. - 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.
-
updateClassificationsByUniqueAttributeWithResponse
public com.azure.core.http.rest.Response<Void> updateClassificationsByUniqueAttributeWithResponse(String typeName, com.azure.core.util.BinaryData atlasClassificationArray, 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. Request Body Schema
[ { attributes: { String: Object } typeName: String lastModifiedTS: String entityGuid: String entityStatus: String(ACTIVE/DELETED) removePropagationsOnEntityDelete: Boolean validityPeriods: [ { endTime: String startTime: String timeZone: String } ] source: String sourceDetails: { String: Object } } ]
- Parameters:
typeName
- The name of the type.atlasClassificationArray
- An array of classification to be updated.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- the
Response
. - 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.
-
setClassificationsWithResponse
public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> setClassificationsWithResponse(com.azure.core.util.BinaryData entityHeaders, com.azure.core.http.rest.RequestOptions requestOptions) Set classifications on entities in bulk.Request Body Schema
{ guidHeaderMap: { String: { attributes: { String: Object } typeName: String lastModifiedTS: String classificationNames: [ String ] classifications: [ { attributes: { String: Object } typeName: String lastModifiedTS: String entityGuid: String entityStatus: String(ACTIVE/DELETED) removePropagationsOnEntityDelete: Boolean validityPeriods: [ { endTime: String startTime: String timeZone: String } ] source: String sourceDetails: { String: Object } } ] displayText: String guid: String isIncomplete: Boolean labels: [ String ] meaningNames: [ String ] meanings: [ { confidence: Integer createdBy: String description: String displayText: String expression: String relationGuid: String source: String status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) steward: String termGuid: String } ] status: String(ACTIVE/DELETED) } } }
Response Body Schema
[ String ]
- Parameters:
entityHeaders
- Atlas entity headers.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- response that indicates each classification mutation result along with
Response
. - 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.
-
getEntitiesByUniqueAttributesWithResponse
public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getEntitiesByUniqueAttributesWithResponse(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_0:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1.
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_0:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1 Response Body Schema
{ referredEntities: { String: { attributes: { String: Object } typeName: String lastModifiedTS: String businessAttributes: { String: Object } classifications: [ { attributes: { String: Object } typeName: String lastModifiedTS: String entityGuid: String entityStatus: String(ACTIVE/DELETED) removePropagationsOnEntityDelete: Boolean validityPeriods: [ { endTime: String startTime: String timeZone: String } ] source: String sourceDetails: { String: Object } } ] createTime: Float createdBy: String customAttributes: { String: String } guid: String homeId: String isIncomplete: Boolean labels: [ String ] meanings: [ { confidence: Integer createdBy: String description: String displayText: String expression: String relationGuid: String source: String status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) steward: String termGuid: String } ] provenanceType: Float proxy: Boolean relationshipAttributes: { String: Object } status: String(ACTIVE/DELETED) updateTime: Float updatedBy: String version: Float source: String sourceDetails: { String: Object } contacts: { String: [ { id: String info: String } ] } } } entities: [ (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:
- atlasEntitiesWithExtInfo along with
Response
. - 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 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: { String: Object } typeName: String lastModifiedTS: String classificationNames: [ String ] classifications: [ { attributes: { String: Object } typeName: String lastModifiedTS: String entityGuid: String entityStatus: String(ACTIVE/DELETED) removePropagationsOnEntityDelete: Boolean validityPeriods: [ { endTime: String startTime: String timeZone: String } ] source: String sourceDetails: { String: Object } } ] displayText: String guid: String isIncomplete: Boolean labels: [ String ] meaningNames: [ String ] meanings: [ { confidence: Integer createdBy: String description: String displayText: String expression: String relationGuid: String source: String status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER) steward: String termGuid: String } ] status: String(ACTIVE/DELETED) }
- 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
. - 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.
-
deleteBusinessMetadataWithResponse
public com.azure.core.http.rest.Response<Void> deleteBusinessMetadataWithResponse(String guid, com.azure.core.http.rest.RequestOptions requestOptions) Remove business metadata from an entity.Request Body Schema
{ String: Object }
- 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
. - 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 com.azure.core.http.rest.Response<Void> addOrUpdateBusinessMetadataWithResponse(String guid, 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. Request Body Schema
{ String: Object }
- 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
. - 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.
-
deleteBusinessMetadataAttributesWithResponse
public com.azure.core.http.rest.Response<Void> deleteBusinessMetadataAttributesWithResponse(String bmName, String guid, com.azure.core.http.rest.RequestOptions requestOptions) Delete business metadata attributes from an entity.Request Body Schema
{ String: Object }
- Parameters:
bmName
- BusinessMetadata name.guid
- The globally unique identifier of the entity.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- the
Response
. - 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 com.azure.core.http.rest.Response<Void> addOrUpdateBusinessMetadataAttributesWithResponse(String bmName, String guid, com.azure.core.http.rest.RequestOptions requestOptions) Add or update business metadata attributes.Request Body Schema
{ String: Object }
- Parameters:
bmName
- BusinessMetadata name.guid
- The globally unique identifier of the entity.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- the
Response
. - 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.
-
getSampleBusinessMetadataTemplateWithResponse
public com.azure.core.http.rest.Response<Void> getSampleBusinessMetadataTemplateWithResponse(com.azure.core.http.rest.RequestOptions requestOptions) Get the sample Template for uploading/creating bulk BusinessMetaData.- 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
. - 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.
-
importBusinessMetadataWithResponse
public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> importBusinessMetadataWithResponse(com.azure.core.http.rest.RequestOptions requestOptions) Upload the file for creating Business Metadata in BULK.Request Body Schema
Flux<ByteBuffer>
Response Body Schema
{ failedImportInfoList: [ { childObjectName: String importStatus: String(SUCCESS/FAILED) parentObjectName: String remarks: String } ] successImportInfoList: [ (recursive schema, see above) ] }
- Parameters:
requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- bulkImportResponse along with
Response
. - 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.
-
deleteLabelsWithResponse
public com.azure.core.http.rest.Response<Void> deleteLabelsWithResponse(String guid, com.azure.core.http.rest.RequestOptions requestOptions) delete given labels to a given entity.Request Body Schema
[ String ]
- 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
. - 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 com.azure.core.http.rest.Response<Void> setLabelsWithResponse(String guid, com.azure.core.http.rest.RequestOptions requestOptions) Set labels to a given entity.Request Body Schema
[ String ]
- 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
. - 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 com.azure.core.http.rest.Response<Void> addLabelWithResponse(String guid, com.azure.core.http.rest.RequestOptions requestOptions) add given labels to a given entity.Request Body Schema
[ String ]
- 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
. - 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.
-
deleteLabelsByUniqueAttributeWithResponse
public com.azure.core.http.rest.Response<Void> deleteLabelsByUniqueAttributeWithResponse(String typeName, com.azure.core.http.rest.RequestOptions requestOptions) Delete given labels to a given entity identified by its type and unique attributes, if labels is null/empty, no labels will be removed. If any labels in labels set are non-existing labels, they will be ignored, only existing labels will be removed. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.Query Parameters
Query Parameters Name Type Required Description attr:qualifiedName String No The qualified name of the entity Request Body Schema
[ String ]
- Parameters:
typeName
- The name of the type.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- the
Response
. - 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 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 Request Body Schema
[ String ]
- Parameters:
typeName
- The name of the type.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- the
Response
. - 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 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 Request Body Schema
[ String ]
- Parameters:
typeName
- The name of the type.requestOptions
- The options to configure the HTTP request before HTTP client sends it.- Returns:
- the
Response
. - 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.
-