638 строки
115 KiB
YAML
638 строки
115 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.analytics.purview.catalog.EntityClient"
|
|
fullName: "com.azure.analytics.purview.catalog.EntityClient"
|
|
name: "EntityClient"
|
|
nameWithType: "EntityClient"
|
|
summary: "Initializes a new instance of the synchronous Purview<wbr>Catalog<wbr>Client type."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **EntityClient**"
|
|
methods:
|
|
- uid: "com.azure.analytics.purview.catalog.EntityClient.addClassificationWithResponse(com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.EntityClient.addClassificationWithResponse(BinaryData request, RequestOptions requestOptions)"
|
|
name: "addClassificationWithResponse(BinaryData request, RequestOptions requestOptions)"
|
|
nameWithType: "EntityClient.addClassificationWithResponse(BinaryData request, RequestOptions requestOptions)"
|
|
summary: "Associate a classification to multiple entities in bulk."
|
|
parameters:
|
|
- description: "The request to associate a classification to multiple entities."
|
|
name: "request"
|
|
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<Void> addClassificationWithResponse(BinaryData request, RequestOptions requestOptions)"
|
|
desc: "Associate a classification to multiple entities in bulk.\n\n**Request Body Schema**\n\n```java\n{\n classification: {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n entityGuid: String\n entityStatus: String(ACTIVE/DELETED)\n removePropagationsOnEntityDelete: Boolean\n validityPeriods: [\n {\n endTime: String\n startTime: String\n timeZone: String\n }\n ]\n source: String\n sourceDetails: {\n String: Object\n }\n }\n entityGuids: [\n String\n ]\n }\n```"
|
|
returns:
|
|
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.analytics.purview.catalog.EntityClient.addClassificationsByUniqueAttributeWithResponse(java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.EntityClient.addClassificationsByUniqueAttributeWithResponse(String typeName, BinaryData atlasClassificationArray, RequestOptions requestOptions)"
|
|
name: "addClassificationsByUniqueAttributeWithResponse(String typeName, BinaryData atlasClassificationArray, RequestOptions requestOptions)"
|
|
nameWithType: "EntityClient.addClassificationsByUniqueAttributeWithResponse(String typeName, BinaryData atlasClassificationArray, RequestOptions requestOptions)"
|
|
summary: "Add classification to the entity identified by its type and unique attributes."
|
|
parameters:
|
|
- description: "The name of the type."
|
|
name: "typeName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "An array of classification to be added."
|
|
name: "atlasClassificationArray"
|
|
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<Void> addClassificationsByUniqueAttributeWithResponse(String typeName, BinaryData atlasClassificationArray, RequestOptions requestOptions)"
|
|
desc: "Add classification to the entity identified by its type and unique attributes.\n\n**Query Parameters**\n\n | ------------------ | ------ | -------- | --------------------------------- |\n | Name | Type | Required | Description |\n | attr:qualifiedName | String | No | The qualified name of the entity. |\n\n**Request Body Schema**\n\n```java\n[\n {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n entityGuid: String\n entityStatus: String(ACTIVE/DELETED)\n removePropagationsOnEntityDelete: Boolean\n validityPeriods: [\n {\n endTime: String\n startTime: String\n timeZone: String\n }\n ]\n source: String\n sourceDetails: {\n String: Object\n }\n }\n ]\n```"
|
|
returns:
|
|
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.analytics.purview.catalog.EntityClient.addClassificationsWithResponse(java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.EntityClient.addClassificationsWithResponse(String guid, BinaryData classifications, RequestOptions requestOptions)"
|
|
name: "addClassificationsWithResponse(String guid, BinaryData classifications, RequestOptions requestOptions)"
|
|
nameWithType: "EntityClient.addClassificationsWithResponse(String guid, BinaryData classifications, RequestOptions requestOptions)"
|
|
summary: "Add classifications to an existing entity represented by a GUID."
|
|
parameters:
|
|
- description: "The globally unique identifier of the entity."
|
|
name: "guid"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "An array of classifications to be added."
|
|
name: "classifications"
|
|
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<Void> addClassificationsWithResponse(String guid, BinaryData classifications, RequestOptions requestOptions)"
|
|
desc: "Add classifications to an existing entity represented by a GUID.\n\n**Request Body Schema**\n\n```java\n[\n {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n entityGuid: String\n entityStatus: String(ACTIVE/DELETED)\n removePropagationsOnEntityDelete: Boolean\n validityPeriods: [\n {\n endTime: String\n startTime: String\n timeZone: String\n }\n ]\n source: String\n sourceDetails: {\n String: Object\n }\n }\n ]\n```"
|
|
returns:
|
|
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.analytics.purview.catalog.EntityClient.addLabelWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.EntityClient.addLabelWithResponse(String guid, RequestOptions requestOptions)"
|
|
name: "addLabelWithResponse(String guid, RequestOptions requestOptions)"
|
|
nameWithType: "EntityClient.addLabelWithResponse(String guid, RequestOptions requestOptions)"
|
|
summary: "add given labels to a given entity."
|
|
parameters:
|
|
- description: "The globally unique identifier of the entity."
|
|
name: "guid"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<Void> addLabelWithResponse(String guid, RequestOptions requestOptions)"
|
|
desc: "add given labels to a given entity.\n\n**Request Body Schema**\n\n```java\n[\n String\n ]\n```"
|
|
returns:
|
|
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.analytics.purview.catalog.EntityClient.addLabelsByUniqueAttributeWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.EntityClient.addLabelsByUniqueAttributeWithResponse(String typeName, RequestOptions requestOptions)"
|
|
name: "addLabelsByUniqueAttributeWithResponse(String typeName, RequestOptions requestOptions)"
|
|
nameWithType: "EntityClient.addLabelsByUniqueAttributeWithResponse(String typeName, RequestOptions requestOptions)"
|
|
summary: "Add given labels to a given entity identified by its type and unique attributes, if labels is null/empty, no labels will be added."
|
|
parameters:
|
|
- description: "The name of the type."
|
|
name: "typeName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<Void> addLabelsByUniqueAttributeWithResponse(String typeName, RequestOptions requestOptions)"
|
|
desc: "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.\n\n**Query Parameters**\n\n | ------------------ | ------ | -------- | -------------------------------- |\n | Name | Type | Required | Description |\n | attr:qualifiedName | String | No | The qualified name of the entity |\n\n**Request Body Schema**\n\n```java\n[\n String\n ]\n```"
|
|
returns:
|
|
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.analytics.purview.catalog.EntityClient.addOrUpdateBusinessMetadataAttributesWithResponse(java.lang.String,java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.EntityClient.addOrUpdateBusinessMetadataAttributesWithResponse(String bmName, String guid, RequestOptions requestOptions)"
|
|
name: "addOrUpdateBusinessMetadataAttributesWithResponse(String bmName, String guid, RequestOptions requestOptions)"
|
|
nameWithType: "EntityClient.addOrUpdateBusinessMetadataAttributesWithResponse(String bmName, String guid, RequestOptions requestOptions)"
|
|
summary: "Add or update business metadata attributes."
|
|
parameters:
|
|
- description: "BusinessMetadata name."
|
|
name: "bmName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The globally unique identifier of the entity."
|
|
name: "guid"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<Void> addOrUpdateBusinessMetadataAttributesWithResponse(String bmName, String guid, RequestOptions requestOptions)"
|
|
desc: "Add or update business metadata attributes.\n\n**Request Body Schema**\n\n```java\n{\n String: Object\n }\n```"
|
|
returns:
|
|
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.analytics.purview.catalog.EntityClient.addOrUpdateBusinessMetadataWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.EntityClient.addOrUpdateBusinessMetadataWithResponse(String guid, RequestOptions requestOptions)"
|
|
name: "addOrUpdateBusinessMetadataWithResponse(String guid, RequestOptions requestOptions)"
|
|
nameWithType: "EntityClient.addOrUpdateBusinessMetadataWithResponse(String guid, RequestOptions requestOptions)"
|
|
summary: "Add business metadata to an entity."
|
|
parameters:
|
|
- description: "The globally unique identifier of the entity."
|
|
name: "guid"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<Void> addOrUpdateBusinessMetadataWithResponse(String guid, RequestOptions requestOptions)"
|
|
desc: "Add business metadata to an entity.\n\n**Query Parameters**\n\n | ----------- | ------- | -------- | ------------------------------------------------------------------------------------------- |\n | Name | Type | Required | Description |\n | isOverwrite | Boolean | No | Whether to overwrite the existing business metadata on the entity or not, default is false. |\n\n**Request Body Schema**\n\n```java\n{\n String: Object\n }\n```"
|
|
returns:
|
|
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.analytics.purview.catalog.EntityClient.createOrUpdateEntitiesWithResponse(com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.EntityClient.createOrUpdateEntitiesWithResponse(BinaryData entities, RequestOptions requestOptions)"
|
|
name: "createOrUpdateEntitiesWithResponse(BinaryData entities, RequestOptions requestOptions)"
|
|
nameWithType: "EntityClient.createOrUpdateEntitiesWithResponse(BinaryData entities, RequestOptions requestOptions)"
|
|
summary: "Create or update entities in Atlas in bulk."
|
|
parameters:
|
|
- description: "An array of entities to create or update."
|
|
name: "entities"
|
|
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<BinaryData> createOrUpdateEntitiesWithResponse(BinaryData entities, RequestOptions requestOptions)"
|
|
desc: "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>>.\n\n**Request Body Schema**\n\n```java\n{\n referredEntities: {\n String: {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n businessAttributes: {\n String: Object\n }\n classifications: [\n {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n entityGuid: String\n entityStatus: String(ACTIVE/DELETED)\n removePropagationsOnEntityDelete: Boolean\n validityPeriods: [\n {\n endTime: String\n startTime: String\n timeZone: String\n }\n ]\n source: String\n sourceDetails: {\n String: Object\n }\n }\n ]\n createTime: Float\n createdBy: String\n customAttributes: {\n String: String\n }\n guid: String\n homeId: String\n isIncomplete: Boolean\n labels: [\n String\n ]\n meanings: [\n {\n confidence: Integer\n createdBy: String\n description: String\n displayText: String\n expression: String\n relationGuid: String\n source: String\n status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER)\n steward: String\n termGuid: String\n }\n ]\n provenanceType: Float\n proxy: Boolean\n relationshipAttributes: {\n String: Object\n }\n status: String(ACTIVE/DELETED)\n updateTime: Float\n updatedBy: String\n version: Float\n source: String\n sourceDetails: {\n String: Object\n }\n contacts: {\n String: [\n {\n id: String\n info: String\n }\n ]\n }\n }\n }\n entities: [\n (recursive schema, see above)\n ]\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n guidAssignments: {\n String: String\n }\n mutatedEntities: {\n String: [\n {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n classificationNames: [\n String\n ]\n classifications: [\n {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n entityGuid: String\n entityStatus: String(ACTIVE/DELETED)\n removePropagationsOnEntityDelete: Boolean\n validityPeriods: [\n {\n endTime: String\n startTime: String\n timeZone: String\n }\n ]\n source: String\n sourceDetails: {\n String: Object\n }\n }\n ]\n displayText: String\n guid: String\n isIncomplete: Boolean\n labels: [\n String\n ]\n meaningNames: [\n String\n ]\n meanings: [\n {\n confidence: Integer\n createdBy: String\n description: String\n displayText: String\n expression: String\n relationGuid: String\n source: String\n status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER)\n steward: String\n termGuid: String\n }\n ]\n status: String(ACTIVE/DELETED)\n }\n ]\n }\n partialUpdatedEntities: [\n (recursive schema, see above)\n ]\n }\n```"
|
|
returns:
|
|
description: "entityMutationResponse along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.analytics.purview.catalog.EntityClient.createOrUpdateWithResponse(com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.EntityClient.createOrUpdateWithResponse(BinaryData entity, RequestOptions requestOptions)"
|
|
name: "createOrUpdateWithResponse(BinaryData entity, RequestOptions requestOptions)"
|
|
nameWithType: "EntityClient.createOrUpdateWithResponse(BinaryData entity, RequestOptions requestOptions)"
|
|
summary: "Create or update an entity in Atlas."
|
|
parameters:
|
|
- description: "Atlas entity with extended information."
|
|
name: "entity"
|
|
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<BinaryData> createOrUpdateWithResponse(BinaryData entity, RequestOptions requestOptions)"
|
|
desc: "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>>.\n\n**Request Body Schema**\n\n```java\n{\n referredEntities: {\n String: {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n businessAttributes: {\n String: Object\n }\n classifications: [\n {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n entityGuid: String\n entityStatus: String(ACTIVE/DELETED)\n removePropagationsOnEntityDelete: Boolean\n validityPeriods: [\n {\n endTime: String\n startTime: String\n timeZone: String\n }\n ]\n source: String\n sourceDetails: {\n String: Object\n }\n }\n ]\n createTime: Float\n createdBy: String\n customAttributes: {\n String: String\n }\n guid: String\n homeId: String\n isIncomplete: Boolean\n labels: [\n String\n ]\n meanings: [\n {\n confidence: Integer\n createdBy: String\n description: String\n displayText: String\n expression: String\n relationGuid: String\n source: String\n status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER)\n steward: String\n termGuid: String\n }\n ]\n provenanceType: Float\n proxy: Boolean\n relationshipAttributes: {\n String: Object\n }\n status: String(ACTIVE/DELETED)\n updateTime: Float\n updatedBy: String\n version: Float\n source: String\n sourceDetails: {\n String: Object\n }\n contacts: {\n String: [\n {\n id: String\n info: String\n }\n ]\n }\n }\n }\n entity: (recursive schema, see entity above)\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n guidAssignments: {\n String: String\n }\n mutatedEntities: {\n String: [\n {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n classificationNames: [\n String\n ]\n classifications: [\n {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n entityGuid: String\n entityStatus: String(ACTIVE/DELETED)\n removePropagationsOnEntityDelete: Boolean\n validityPeriods: [\n {\n endTime: String\n startTime: String\n timeZone: String\n }\n ]\n source: String\n sourceDetails: {\n String: Object\n }\n }\n ]\n displayText: String\n guid: String\n isIncomplete: Boolean\n labels: [\n String\n ]\n meaningNames: [\n String\n ]\n meanings: [\n {\n confidence: Integer\n createdBy: String\n description: String\n displayText: String\n expression: String\n relationGuid: String\n source: String\n status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER)\n steward: String\n termGuid: String\n }\n ]\n status: String(ACTIVE/DELETED)\n }\n ]\n }\n partialUpdatedEntities: [\n (recursive schema, see above)\n ]\n }\n```"
|
|
returns:
|
|
description: "entityMutationResponse along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.analytics.purview.catalog.EntityClient.deleteBusinessMetadataAttributesWithResponse(java.lang.String,java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.EntityClient.deleteBusinessMetadataAttributesWithResponse(String bmName, String guid, RequestOptions requestOptions)"
|
|
name: "deleteBusinessMetadataAttributesWithResponse(String bmName, String guid, RequestOptions requestOptions)"
|
|
nameWithType: "EntityClient.deleteBusinessMetadataAttributesWithResponse(String bmName, String guid, RequestOptions requestOptions)"
|
|
summary: "Delete business metadata attributes from an entity."
|
|
parameters:
|
|
- description: "BusinessMetadata name."
|
|
name: "bmName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The globally unique identifier of the entity."
|
|
name: "guid"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<Void> deleteBusinessMetadataAttributesWithResponse(String bmName, String guid, RequestOptions requestOptions)"
|
|
desc: "Delete business metadata attributes from an entity.\n\n**Request Body Schema**\n\n```java\n{\n String: Object\n }\n```"
|
|
returns:
|
|
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.analytics.purview.catalog.EntityClient.deleteBusinessMetadataWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.EntityClient.deleteBusinessMetadataWithResponse(String guid, RequestOptions requestOptions)"
|
|
name: "deleteBusinessMetadataWithResponse(String guid, RequestOptions requestOptions)"
|
|
nameWithType: "EntityClient.deleteBusinessMetadataWithResponse(String guid, RequestOptions requestOptions)"
|
|
summary: "Remove business metadata from an entity."
|
|
parameters:
|
|
- description: "The globally unique identifier of the entity."
|
|
name: "guid"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<Void> deleteBusinessMetadataWithResponse(String guid, RequestOptions requestOptions)"
|
|
desc: "Remove business metadata from an entity.\n\n**Request Body Schema**\n\n```java\n{\n String: Object\n }\n```"
|
|
returns:
|
|
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.analytics.purview.catalog.EntityClient.deleteByGuidWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.EntityClient.deleteByGuidWithResponse(String guid, RequestOptions requestOptions)"
|
|
name: "deleteByGuidWithResponse(String guid, RequestOptions requestOptions)"
|
|
nameWithType: "EntityClient.deleteByGuidWithResponse(String guid, RequestOptions requestOptions)"
|
|
summary: "Delete an entity identified by its GUID."
|
|
parameters:
|
|
- description: "The globally unique identifier of the entity."
|
|
name: "guid"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<BinaryData> deleteByGuidWithResponse(String guid, RequestOptions requestOptions)"
|
|
desc: "Delete an entity identified by its GUID.\n\n**Response Body Schema**\n\n```java\n{\n guidAssignments: {\n String: String\n }\n mutatedEntities: {\n String: [\n {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n classificationNames: [\n String\n ]\n classifications: [\n {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n entityGuid: String\n entityStatus: String(ACTIVE/DELETED)\n removePropagationsOnEntityDelete: Boolean\n validityPeriods: [\n {\n endTime: String\n startTime: String\n timeZone: String\n }\n ]\n source: String\n sourceDetails: {\n String: Object\n }\n }\n ]\n displayText: String\n guid: String\n isIncomplete: Boolean\n labels: [\n String\n ]\n meaningNames: [\n String\n ]\n meanings: [\n {\n confidence: Integer\n createdBy: String\n description: String\n displayText: String\n expression: String\n relationGuid: String\n source: String\n status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER)\n steward: String\n termGuid: String\n }\n ]\n status: String(ACTIVE/DELETED)\n }\n ]\n }\n partialUpdatedEntities: [\n (recursive schema, see above)\n ]\n }\n```"
|
|
returns:
|
|
description: "entityMutationResponse along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.analytics.purview.catalog.EntityClient.deleteByGuidsWithResponse(java.util.List<java.lang.String>,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.EntityClient.deleteByGuidsWithResponse(List<String> guids, RequestOptions requestOptions)"
|
|
name: "deleteByGuidsWithResponse(List<String> guids, RequestOptions requestOptions)"
|
|
nameWithType: "EntityClient.deleteByGuidsWithResponse(List<String> guids, RequestOptions requestOptions)"
|
|
summary: "Delete a list of entities in bulk identified by their GUIDs or unique attributes."
|
|
parameters:
|
|
- description: "An array of GUIDs of entities to delete."
|
|
name: "guids"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<BinaryData> deleteByGuidsWithResponse(List<String> guids, RequestOptions requestOptions)"
|
|
desc: "Delete a list of entities in bulk identified by their GUIDs or unique attributes.\n\n**Response Body Schema**\n\n```java\n{\n guidAssignments: {\n String: String\n }\n mutatedEntities: {\n String: [\n {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n classificationNames: [\n String\n ]\n classifications: [\n {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n entityGuid: String\n entityStatus: String(ACTIVE/DELETED)\n removePropagationsOnEntityDelete: Boolean\n validityPeriods: [\n {\n endTime: String\n startTime: String\n timeZone: String\n }\n ]\n source: String\n sourceDetails: {\n String: Object\n }\n }\n ]\n displayText: String\n guid: String\n isIncomplete: Boolean\n labels: [\n String\n ]\n meaningNames: [\n String\n ]\n meanings: [\n {\n confidence: Integer\n createdBy: String\n description: String\n displayText: String\n expression: String\n relationGuid: String\n source: String\n status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER)\n steward: String\n termGuid: String\n }\n ]\n status: String(ACTIVE/DELETED)\n }\n ]\n }\n partialUpdatedEntities: [\n (recursive schema, see above)\n ]\n }\n```"
|
|
returns:
|
|
description: "entityMutationResponse along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.analytics.purview.catalog.EntityClient.deleteByUniqueAttributeWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.EntityClient.deleteByUniqueAttributeWithResponse(String typeName, RequestOptions requestOptions)"
|
|
name: "deleteByUniqueAttributeWithResponse(String typeName, RequestOptions requestOptions)"
|
|
nameWithType: "EntityClient.deleteByUniqueAttributeWithResponse(String typeName, RequestOptions requestOptions)"
|
|
summary: "Delete an entity identified by its type and unique attributes."
|
|
parameters:
|
|
- description: "The name of the type."
|
|
name: "typeName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<BinaryData> deleteByUniqueAttributeWithResponse(String typeName, RequestOptions requestOptions)"
|
|
desc: "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.\n\n**Query Parameters**\n\n | ------------------ | ------ | -------- | --------------------------------- |\n | Name | Type | Required | Description |\n | attr:qualifiedName | String | No | The qualified name of the entity. |\n\n**Response Body Schema**\n\n```java\n{\n guidAssignments: {\n String: String\n }\n mutatedEntities: {\n String: [\n {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n classificationNames: [\n String\n ]\n classifications: [\n {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n entityGuid: String\n entityStatus: String(ACTIVE/DELETED)\n removePropagationsOnEntityDelete: Boolean\n validityPeriods: [\n {\n endTime: String\n startTime: String\n timeZone: String\n }\n ]\n source: String\n sourceDetails: {\n String: Object\n }\n }\n ]\n displayText: String\n guid: String\n isIncomplete: Boolean\n labels: [\n String\n ]\n meaningNames: [\n String\n ]\n meanings: [\n {\n confidence: Integer\n createdBy: String\n description: String\n displayText: String\n expression: String\n relationGuid: String\n source: String\n status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER)\n steward: String\n termGuid: String\n }\n ]\n status: String(ACTIVE/DELETED)\n }\n ]\n }\n partialUpdatedEntities: [\n (recursive schema, see above)\n ]\n }\n```"
|
|
returns:
|
|
description: "entityMutationResponse along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.analytics.purview.catalog.EntityClient.deleteClassificationByUniqueAttributeWithResponse(java.lang.String,java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.EntityClient.deleteClassificationByUniqueAttributeWithResponse(String typeName, String classificationName, RequestOptions requestOptions)"
|
|
name: "deleteClassificationByUniqueAttributeWithResponse(String typeName, String classificationName, RequestOptions requestOptions)"
|
|
nameWithType: "EntityClient.deleteClassificationByUniqueAttributeWithResponse(String typeName, String classificationName, RequestOptions requestOptions)"
|
|
summary: "Delete a given classification from an entity identified by its type and unique attributes."
|
|
parameters:
|
|
- description: "The name of the type."
|
|
name: "typeName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the classification."
|
|
name: "classificationName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<Void> deleteClassificationByUniqueAttributeWithResponse(String typeName, String classificationName, RequestOptions requestOptions)"
|
|
desc: "Delete a given classification from an entity identified by its type and unique attributes.\n\n**Query Parameters**\n\n | ------------------ | ------ | -------- | --------------------------------- |\n | Name | Type | Required | Description |\n | attr:qualifiedName | String | No | The qualified name of the entity. |"
|
|
returns:
|
|
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.analytics.purview.catalog.EntityClient.deleteClassificationWithResponse(java.lang.String,java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.EntityClient.deleteClassificationWithResponse(String guid, String classificationName, RequestOptions requestOptions)"
|
|
name: "deleteClassificationWithResponse(String guid, String classificationName, RequestOptions requestOptions)"
|
|
nameWithType: "EntityClient.deleteClassificationWithResponse(String guid, String classificationName, RequestOptions requestOptions)"
|
|
summary: "Delete a given classification from an existing entity represented by a GUID."
|
|
parameters:
|
|
- description: "The globally unique identifier of the entity."
|
|
name: "guid"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the classification."
|
|
name: "classificationName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<Void> deleteClassificationWithResponse(String guid, String classificationName, RequestOptions requestOptions)"
|
|
desc: "Delete a given classification from an existing entity represented by a GUID."
|
|
returns:
|
|
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.analytics.purview.catalog.EntityClient.deleteLabelsByUniqueAttributeWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.EntityClient.deleteLabelsByUniqueAttributeWithResponse(String typeName, RequestOptions requestOptions)"
|
|
name: "deleteLabelsByUniqueAttributeWithResponse(String typeName, RequestOptions requestOptions)"
|
|
nameWithType: "EntityClient.deleteLabelsByUniqueAttributeWithResponse(String typeName, RequestOptions requestOptions)"
|
|
summary: "Delete given labels to a given entity identified by its type and unique attributes, if labels is null/empty, no labels will be removed."
|
|
parameters:
|
|
- description: "The name of the type."
|
|
name: "typeName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<Void> deleteLabelsByUniqueAttributeWithResponse(String typeName, RequestOptions requestOptions)"
|
|
desc: "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.\n\n**Query Parameters**\n\n | ------------------ | ------ | -------- | -------------------------------- |\n | Name | Type | Required | Description |\n | attr:qualifiedName | String | No | The qualified name of the entity |\n\n**Request Body Schema**\n\n```java\n[\n String\n ]\n```"
|
|
returns:
|
|
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.analytics.purview.catalog.EntityClient.deleteLabelsWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.EntityClient.deleteLabelsWithResponse(String guid, RequestOptions requestOptions)"
|
|
name: "deleteLabelsWithResponse(String guid, RequestOptions requestOptions)"
|
|
nameWithType: "EntityClient.deleteLabelsWithResponse(String guid, RequestOptions requestOptions)"
|
|
summary: "delete given labels to a given entity."
|
|
parameters:
|
|
- description: "The globally unique identifier of the entity."
|
|
name: "guid"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<Void> deleteLabelsWithResponse(String guid, RequestOptions requestOptions)"
|
|
desc: "delete given labels to a given entity.\n\n**Request Body Schema**\n\n```java\n[\n String\n ]\n```"
|
|
returns:
|
|
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.analytics.purview.catalog.EntityClient.getByGuidWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.EntityClient.getByGuidWithResponse(String guid, RequestOptions requestOptions)"
|
|
name: "getByGuidWithResponse(String guid, RequestOptions requestOptions)"
|
|
nameWithType: "EntityClient.getByGuidWithResponse(String guid, RequestOptions requestOptions)"
|
|
summary: "Get complete definition of an entity given its GUID."
|
|
parameters:
|
|
- description: "The globally unique identifier of the entity."
|
|
name: "guid"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<BinaryData> getByGuidWithResponse(String guid, RequestOptions requestOptions)"
|
|
desc: "Get complete definition of an entity given its GUID.\n\n**Query Parameters**\n\n | ------------------- | ------- | -------- | ------------------------------------------------------------ |\n | Name | Type | Required | Description |\n | minExtInfo | Boolean | No | Whether to return minimal information for referred entities. |\n | ignoreRelationships | Boolean | No | Whether to ignore relationship attributes. |\n\n**Response Body Schema**\n\n```java\n{\n referredEntities: {\n String: {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n businessAttributes: {\n String: Object\n }\n classifications: [\n {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n entityGuid: String\n entityStatus: String(ACTIVE/DELETED)\n removePropagationsOnEntityDelete: Boolean\n validityPeriods: [\n {\n endTime: String\n startTime: String\n timeZone: String\n }\n ]\n source: String\n sourceDetails: {\n String: Object\n }\n }\n ]\n createTime: Float\n createdBy: String\n customAttributes: {\n String: String\n }\n guid: String\n homeId: String\n isIncomplete: Boolean\n labels: [\n String\n ]\n meanings: [\n {\n confidence: Integer\n createdBy: String\n description: String\n displayText: String\n expression: String\n relationGuid: String\n source: String\n status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER)\n steward: String\n termGuid: String\n }\n ]\n provenanceType: Float\n proxy: Boolean\n relationshipAttributes: {\n String: Object\n }\n status: String(ACTIVE/DELETED)\n updateTime: Float\n updatedBy: String\n version: Float\n source: String\n sourceDetails: {\n String: Object\n }\n contacts: {\n String: [\n {\n id: String\n info: String\n }\n ]\n }\n }\n }\n entity: (recursive schema, see entity above)\n }\n```"
|
|
returns:
|
|
description: "complete definition of an entity given its GUID along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.analytics.purview.catalog.EntityClient.getByUniqueAttributesWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.EntityClient.getByUniqueAttributesWithResponse(String typeName, RequestOptions requestOptions)"
|
|
name: "getByUniqueAttributesWithResponse(String typeName, RequestOptions requestOptions)"
|
|
nameWithType: "EntityClient.getByUniqueAttributesWithResponse(String typeName, RequestOptions requestOptions)"
|
|
summary: "Get complete definition of an entity given its type and unique attribute."
|
|
parameters:
|
|
- description: "The name of the type."
|
|
name: "typeName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<BinaryData> getByUniqueAttributesWithResponse(String typeName, RequestOptions requestOptions)"
|
|
desc: "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.\n\n**Query Parameters**\n\n | ------------------- | ------- | -------- | ------------------------------------------------------------ |\n | Name | Type | Required | Description |\n | minExtInfo | Boolean | No | Whether to return minimal information for referred entities. |\n | ignoreRelationships | Boolean | No | Whether to ignore relationship attributes. |\n | attr:qualifiedName | String | No | The qualified name of the entity. |\n\n**Response Body Schema**\n\n```java\n{\n referredEntities: {\n String: {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n businessAttributes: {\n String: Object\n }\n classifications: [\n {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n entityGuid: String\n entityStatus: String(ACTIVE/DELETED)\n removePropagationsOnEntityDelete: Boolean\n validityPeriods: [\n {\n endTime: String\n startTime: String\n timeZone: String\n }\n ]\n source: String\n sourceDetails: {\n String: Object\n }\n }\n ]\n createTime: Float\n createdBy: String\n customAttributes: {\n String: String\n }\n guid: String\n homeId: String\n isIncomplete: Boolean\n labels: [\n String\n ]\n meanings: [\n {\n confidence: Integer\n createdBy: String\n description: String\n displayText: String\n expression: String\n relationGuid: String\n source: String\n status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER)\n steward: String\n termGuid: String\n }\n ]\n provenanceType: Float\n proxy: Boolean\n relationshipAttributes: {\n String: Object\n }\n status: String(ACTIVE/DELETED)\n updateTime: Float\n updatedBy: String\n version: Float\n source: String\n sourceDetails: {\n String: Object\n }\n contacts: {\n String: [\n {\n id: String\n info: String\n }\n ]\n }\n }\n }\n entity: (recursive schema, see entity above)\n }\n```"
|
|
returns:
|
|
description: "complete definition of an entity given its type and unique attribute. In addition to the typeName path\n parameter, attribute key-value pair(s) can be provided in the following format:\n attr:\\<attrName>=<attrValue> along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.analytics.purview.catalog.EntityClient.getClassificationWithResponse(java.lang.String,java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.EntityClient.getClassificationWithResponse(String guid, String classificationName, RequestOptions requestOptions)"
|
|
name: "getClassificationWithResponse(String guid, String classificationName, RequestOptions requestOptions)"
|
|
nameWithType: "EntityClient.getClassificationWithResponse(String guid, String classificationName, RequestOptions requestOptions)"
|
|
summary: "List classifications for a given entity represented by a GUID."
|
|
parameters:
|
|
- description: "The globally unique identifier of the entity."
|
|
name: "guid"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the classification."
|
|
name: "classificationName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<BinaryData> getClassificationWithResponse(String guid, String classificationName, RequestOptions requestOptions)"
|
|
desc: "List classifications for a given entity represented by a GUID.\n\n**Response Body Schema**\n\n```java\n{\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n entityGuid: String\n entityStatus: String(ACTIVE/DELETED)\n removePropagationsOnEntityDelete: Boolean\n validityPeriods: [\n {\n endTime: String\n startTime: String\n timeZone: String\n }\n ]\n source: String\n sourceDetails: {\n String: Object\n }\n }\n```"
|
|
returns:
|
|
description: "atlasClassification along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.analytics.purview.catalog.EntityClient.getClassificationsWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.EntityClient.getClassificationsWithResponse(String guid, RequestOptions requestOptions)"
|
|
name: "getClassificationsWithResponse(String guid, RequestOptions requestOptions)"
|
|
nameWithType: "EntityClient.getClassificationsWithResponse(String guid, RequestOptions requestOptions)"
|
|
summary: "List classifications for a given entity represented by a GUID."
|
|
parameters:
|
|
- description: "The globally unique identifier of the entity."
|
|
name: "guid"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<BinaryData> getClassificationsWithResponse(String guid, RequestOptions requestOptions)"
|
|
desc: "List classifications for a given entity represented by a GUID.\n\n**Response Body Schema**\n\n```java\n{\n list: [\n Object\n ]\n pageSize: Integer\n sortBy: String\n sortType: String(NONE/ASC/DESC)\n startIndex: Long\n totalCount: Long\n }\n```"
|
|
returns:
|
|
description: "atlasClassifications along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.analytics.purview.catalog.EntityClient.getEntitiesByUniqueAttributesWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.EntityClient.getEntitiesByUniqueAttributesWithResponse(String typeName, RequestOptions requestOptions)"
|
|
name: "getEntitiesByUniqueAttributesWithResponse(String typeName, RequestOptions requestOptions)"
|
|
nameWithType: "EntityClient.getEntitiesByUniqueAttributesWithResponse(String typeName, RequestOptions requestOptions)"
|
|
summary: "Bulk API to retrieve list of entities identified by its unique attributes."
|
|
parameters:
|
|
- description: "The name of the type."
|
|
name: "typeName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<BinaryData> getEntitiesByUniqueAttributesWithResponse(String typeName, RequestOptions requestOptions)"
|
|
desc: "Bulk API to retrieve list of entities identified by its unique attributes.\n\nIn addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format\n\ntypeName=\\\\<typeName>&attr\\_1:\\\\<attrName>=\\\\<attrValue>&attr\\_2:\\\\<attrName>=\\\\<attrValue>&attr\\_3:\\\\<attrName>=\\\\<attrValue>\n\nNOTE: The attrName should be an unique attribute for the given entity-type\n\nThe REST request would look something like this\n\nGET /v2/entity/bulk/uniqueAttribute/type/hive\\_db?attr\\_0:qualifiedName=db1@cl1&attr\\_2:qualifiedName=db2@cl1.\n\n**Query Parameters**\n\n | --------------------- | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------ |\n | Name | Type | Required | Description |\n | minExtInfo | Boolean | No | Whether to return minimal information for referred entities. |\n | ignoreRelationships | Boolean | No | Whether to ignore relationship attributes. |\n | 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 |\n\n**Response Body Schema**\n\n```java\n{\n referredEntities: {\n String: {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n businessAttributes: {\n String: Object\n }\n classifications: [\n {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n entityGuid: String\n entityStatus: String(ACTIVE/DELETED)\n removePropagationsOnEntityDelete: Boolean\n validityPeriods: [\n {\n endTime: String\n startTime: String\n timeZone: String\n }\n ]\n source: String\n sourceDetails: {\n String: Object\n }\n }\n ]\n createTime: Float\n createdBy: String\n customAttributes: {\n String: String\n }\n guid: String\n homeId: String\n isIncomplete: Boolean\n labels: [\n String\n ]\n meanings: [\n {\n confidence: Integer\n createdBy: String\n description: String\n displayText: String\n expression: String\n relationGuid: String\n source: String\n status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER)\n steward: String\n termGuid: String\n }\n ]\n provenanceType: Float\n proxy: Boolean\n relationshipAttributes: {\n String: Object\n }\n status: String(ACTIVE/DELETED)\n updateTime: Float\n updatedBy: String\n version: Float\n source: String\n sourceDetails: {\n String: Object\n }\n contacts: {\n String: [\n {\n id: String\n info: String\n }\n ]\n }\n }\n }\n entities: [\n (recursive schema, see above)\n ]\n }\n```"
|
|
returns:
|
|
description: "atlasEntitiesWithExtInfo along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.analytics.purview.catalog.EntityClient.getHeaderWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.EntityClient.getHeaderWithResponse(String guid, RequestOptions requestOptions)"
|
|
name: "getHeaderWithResponse(String guid, RequestOptions requestOptions)"
|
|
nameWithType: "EntityClient.getHeaderWithResponse(String guid, RequestOptions requestOptions)"
|
|
summary: "Get entity header given its GUID."
|
|
parameters:
|
|
- description: "The globally unique identifier of the entity."
|
|
name: "guid"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<BinaryData> getHeaderWithResponse(String guid, RequestOptions requestOptions)"
|
|
desc: "Get entity header given its GUID.\n\n**Response Body Schema**\n\n```java\n{\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n classificationNames: [\n String\n ]\n classifications: [\n {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n entityGuid: String\n entityStatus: String(ACTIVE/DELETED)\n removePropagationsOnEntityDelete: Boolean\n validityPeriods: [\n {\n endTime: String\n startTime: String\n timeZone: String\n }\n ]\n source: String\n sourceDetails: {\n String: Object\n }\n }\n ]\n displayText: String\n guid: String\n isIncomplete: Boolean\n labels: [\n String\n ]\n meaningNames: [\n String\n ]\n meanings: [\n {\n confidence: Integer\n createdBy: String\n description: String\n displayText: String\n expression: String\n relationGuid: String\n source: String\n status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER)\n steward: String\n termGuid: String\n }\n ]\n status: String(ACTIVE/DELETED)\n }\n```"
|
|
returns:
|
|
description: "entity header given its GUID along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.analytics.purview.catalog.EntityClient.getSampleBusinessMetadataTemplateWithResponse(com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.EntityClient.getSampleBusinessMetadataTemplateWithResponse(RequestOptions requestOptions)"
|
|
name: "getSampleBusinessMetadataTemplateWithResponse(RequestOptions requestOptions)"
|
|
nameWithType: "EntityClient.getSampleBusinessMetadataTemplateWithResponse(RequestOptions requestOptions)"
|
|
summary: "Get the sample Template for uploading/creating bulk Business<wbr>Meta<wbr>Data."
|
|
parameters:
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<Void> getSampleBusinessMetadataTemplateWithResponse(RequestOptions requestOptions)"
|
|
desc: "Get the sample Template for uploading/creating bulk BusinessMetaData."
|
|
returns:
|
|
description: "the sample Template for uploading/creating bulk BusinessMetaData along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.analytics.purview.catalog.EntityClient.importBusinessMetadataWithResponse(com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.EntityClient.importBusinessMetadataWithResponse(RequestOptions requestOptions)"
|
|
name: "importBusinessMetadataWithResponse(RequestOptions requestOptions)"
|
|
nameWithType: "EntityClient.importBusinessMetadataWithResponse(RequestOptions requestOptions)"
|
|
summary: "Upload the file for creating Business Metadata in BULK."
|
|
parameters:
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<BinaryData> importBusinessMetadataWithResponse(RequestOptions requestOptions)"
|
|
desc: "Upload the file for creating Business Metadata in BULK.\n\n**Request Body Schema**\n\n```java\nFlux\n```\n\n**Response Body Schema**\n\n```java\n{\n failedImportInfoList: [\n {\n childObjectName: String\n importStatus: String(SUCCESS/FAILED)\n parentObjectName: String\n remarks: String\n }\n ]\n successImportInfoList: [\n (recursive schema, see above)\n ]\n }\n```"
|
|
returns:
|
|
description: "bulkImportResponse along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.analytics.purview.catalog.EntityClient.listByGuidsWithResponse(java.util.List<java.lang.String>,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.EntityClient.listByGuidsWithResponse(List<String> guids, RequestOptions requestOptions)"
|
|
name: "listByGuidsWithResponse(List<String> guids, RequestOptions requestOptions)"
|
|
nameWithType: "EntityClient.listByGuidsWithResponse(List<String> guids, RequestOptions requestOptions)"
|
|
summary: "List entities in bulk identified by its GUIDs."
|
|
parameters:
|
|
- description: "An array of GUIDs of entities to list."
|
|
name: "guids"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<BinaryData> listByGuidsWithResponse(List<String> guids, RequestOptions requestOptions)"
|
|
desc: "List entities in bulk identified by its GUIDs.\n\n**Query Parameters**\n\n | ------------------------ | ------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n | Name | Type | Required | Description |\n | minExtInfo | Boolean | No | Whether to return minimal information for referred entities. |\n | ignoreRelationships | Boolean | No | Whether to ignore relationship attributes. |\n | excludeRelationshipTypes | List<String> | No | An array of the relationship types need to be excluded from the response. Call <xref uid=\"com.azure.core.http.rest.RequestOptions.addQueryParam\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RequestOptions#addQueryParam\"></xref> to add string to array. |\n\n**Response Body Schema**\n\n```java\n{\n referredEntities: {\n String: {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n businessAttributes: {\n String: Object\n }\n classifications: [\n {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n entityGuid: String\n entityStatus: String(ACTIVE/DELETED)\n removePropagationsOnEntityDelete: Boolean\n validityPeriods: [\n {\n endTime: String\n startTime: String\n timeZone: String\n }\n ]\n source: String\n sourceDetails: {\n String: Object\n }\n }\n ]\n createTime: Float\n createdBy: String\n customAttributes: {\n String: String\n }\n guid: String\n homeId: String\n isIncomplete: Boolean\n labels: [\n String\n ]\n meanings: [\n {\n confidence: Integer\n createdBy: String\n description: String\n displayText: String\n expression: String\n relationGuid: String\n source: String\n status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER)\n steward: String\n termGuid: String\n }\n ]\n provenanceType: Float\n proxy: Boolean\n relationshipAttributes: {\n String: Object\n }\n status: String(ACTIVE/DELETED)\n updateTime: Float\n updatedBy: String\n version: Float\n source: String\n sourceDetails: {\n String: Object\n }\n contacts: {\n String: [\n {\n id: String\n info: String\n }\n ]\n }\n }\n }\n entities: [\n (recursive schema, see above)\n ]\n }\n```"
|
|
returns:
|
|
description: "atlasEntitiesWithExtInfo along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.analytics.purview.catalog.EntityClient.partialUpdateEntityAttributeByGuidWithResponse(java.lang.String,java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.EntityClient.partialUpdateEntityAttributeByGuidWithResponse(String guid, String name, BinaryData body, RequestOptions requestOptions)"
|
|
name: "partialUpdateEntityAttributeByGuidWithResponse(String guid, String name, BinaryData body, RequestOptions requestOptions)"
|
|
nameWithType: "EntityClient.partialUpdateEntityAttributeByGuidWithResponse(String guid, String name, BinaryData body, RequestOptions requestOptions)"
|
|
summary: "Update entity partially - create or update entity attribute identified by its GUID."
|
|
parameters:
|
|
- description: "The globally unique identifier of the entity."
|
|
name: "guid"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the attribute."
|
|
name: "name"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The value of the attribute."
|
|
name: "body"
|
|
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<BinaryData> partialUpdateEntityAttributeByGuidWithResponse(String guid, String name, BinaryData body, RequestOptions requestOptions)"
|
|
desc: "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.\n\n**Request Body Schema**\n\n```java\nObject\n```\n\n**Response Body Schema**\n\n```java\n{\n guidAssignments: {\n String: String\n }\n mutatedEntities: {\n String: [\n {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n classificationNames: [\n String\n ]\n classifications: [\n {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n entityGuid: String\n entityStatus: String(ACTIVE/DELETED)\n removePropagationsOnEntityDelete: Boolean\n validityPeriods: [\n {\n endTime: String\n startTime: String\n timeZone: String\n }\n ]\n source: String\n sourceDetails: {\n String: Object\n }\n }\n ]\n displayText: String\n guid: String\n isIncomplete: Boolean\n labels: [\n String\n ]\n meaningNames: [\n String\n ]\n meanings: [\n {\n confidence: Integer\n createdBy: String\n description: String\n displayText: String\n expression: String\n relationGuid: String\n source: String\n status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER)\n steward: String\n termGuid: String\n }\n ]\n status: String(ACTIVE/DELETED)\n }\n ]\n }\n partialUpdatedEntities: [\n (recursive schema, see above)\n ]\n }\n```"
|
|
returns:
|
|
description: "entityMutationResponse along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.analytics.purview.catalog.EntityClient.partialUpdateEntityByUniqueAttributesWithResponse(java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.EntityClient.partialUpdateEntityByUniqueAttributesWithResponse(String typeName, BinaryData atlasEntityWithExtInfo, RequestOptions requestOptions)"
|
|
name: "partialUpdateEntityByUniqueAttributesWithResponse(String typeName, BinaryData atlasEntityWithExtInfo, RequestOptions requestOptions)"
|
|
nameWithType: "EntityClient.partialUpdateEntityByUniqueAttributesWithResponse(String typeName, BinaryData atlasEntityWithExtInfo, RequestOptions requestOptions)"
|
|
summary: "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.<wbr>qualified<wbr>Name."
|
|
parameters:
|
|
- description: "The name of the type."
|
|
name: "typeName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Atlas entity with extended information."
|
|
name: "atlasEntityWithExtInfo"
|
|
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<BinaryData> partialUpdateEntityByUniqueAttributesWithResponse(String typeName, BinaryData atlasEntityWithExtInfo, RequestOptions requestOptions)"
|
|
desc: "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.\n\n**Query Parameters**\n\n | ------------------ | ------ | -------- | --------------------------------- |\n | Name | Type | Required | Description |\n | attr:qualifiedName | String | No | The qualified name of the entity. |\n\n**Request Body Schema**\n\n```java\n{\n referredEntities: {\n String: {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n businessAttributes: {\n String: Object\n }\n classifications: [\n {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n entityGuid: String\n entityStatus: String(ACTIVE/DELETED)\n removePropagationsOnEntityDelete: Boolean\n validityPeriods: [\n {\n endTime: String\n startTime: String\n timeZone: String\n }\n ]\n source: String\n sourceDetails: {\n String: Object\n }\n }\n ]\n createTime: Float\n createdBy: String\n customAttributes: {\n String: String\n }\n guid: String\n homeId: String\n isIncomplete: Boolean\n labels: [\n String\n ]\n meanings: [\n {\n confidence: Integer\n createdBy: String\n description: String\n displayText: String\n expression: String\n relationGuid: String\n source: String\n status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER)\n steward: String\n termGuid: String\n }\n ]\n provenanceType: Float\n proxy: Boolean\n relationshipAttributes: {\n String: Object\n }\n status: String(ACTIVE/DELETED)\n updateTime: Float\n updatedBy: String\n version: Float\n source: String\n sourceDetails: {\n String: Object\n }\n contacts: {\n String: [\n {\n id: String\n info: String\n }\n ]\n }\n }\n }\n entity: (recursive schema, see entity above)\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n guidAssignments: {\n String: String\n }\n mutatedEntities: {\n String: [\n {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n classificationNames: [\n String\n ]\n classifications: [\n {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n entityGuid: String\n entityStatus: String(ACTIVE/DELETED)\n removePropagationsOnEntityDelete: Boolean\n validityPeriods: [\n {\n endTime: String\n startTime: String\n timeZone: String\n }\n ]\n source: String\n sourceDetails: {\n String: Object\n }\n }\n ]\n displayText: String\n guid: String\n isIncomplete: Boolean\n labels: [\n String\n ]\n meaningNames: [\n String\n ]\n meanings: [\n {\n confidence: Integer\n createdBy: String\n description: String\n displayText: String\n expression: String\n relationGuid: String\n source: String\n status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER)\n steward: String\n termGuid: String\n }\n ]\n status: String(ACTIVE/DELETED)\n }\n ]\n }\n partialUpdatedEntities: [\n (recursive schema, see above)\n ]\n }\n```"
|
|
returns:
|
|
description: "entityMutationResponse along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.analytics.purview.catalog.EntityClient.setClassificationsWithResponse(com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.EntityClient.setClassificationsWithResponse(BinaryData entityHeaders, RequestOptions requestOptions)"
|
|
name: "setClassificationsWithResponse(BinaryData entityHeaders, RequestOptions requestOptions)"
|
|
nameWithType: "EntityClient.setClassificationsWithResponse(BinaryData entityHeaders, RequestOptions requestOptions)"
|
|
summary: "Set classifications on entities in bulk."
|
|
parameters:
|
|
- description: "Atlas entity headers."
|
|
name: "entityHeaders"
|
|
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<BinaryData> setClassificationsWithResponse(BinaryData entityHeaders, RequestOptions requestOptions)"
|
|
desc: "Set classifications on entities in bulk.\n\n**Request Body Schema**\n\n```java\n{\n guidHeaderMap: {\n String: {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n classificationNames: [\n String\n ]\n classifications: [\n {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n entityGuid: String\n entityStatus: String(ACTIVE/DELETED)\n removePropagationsOnEntityDelete: Boolean\n validityPeriods: [\n {\n endTime: String\n startTime: String\n timeZone: String\n }\n ]\n source: String\n sourceDetails: {\n String: Object\n }\n }\n ]\n displayText: String\n guid: String\n isIncomplete: Boolean\n labels: [\n String\n ]\n meaningNames: [\n String\n ]\n meanings: [\n {\n confidence: Integer\n createdBy: String\n description: String\n displayText: String\n expression: String\n relationGuid: String\n source: String\n status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER)\n steward: String\n termGuid: String\n }\n ]\n status: String(ACTIVE/DELETED)\n }\n }\n }\n```\n\n**Response Body Schema**\n\n```java\n[\n String\n ]\n```"
|
|
returns:
|
|
description: "response that indicates each classification mutation result along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.analytics.purview.catalog.EntityClient.setLabelsByUniqueAttributeWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.EntityClient.setLabelsByUniqueAttributeWithResponse(String typeName, RequestOptions requestOptions)"
|
|
name: "setLabelsByUniqueAttributeWithResponse(String typeName, RequestOptions requestOptions)"
|
|
nameWithType: "EntityClient.setLabelsByUniqueAttributeWithResponse(String typeName, RequestOptions requestOptions)"
|
|
summary: "Set labels to a given entity identified by its type and unique attributes, if labels is null/empty, existing labels will all be removed."
|
|
parameters:
|
|
- description: "The name of the type."
|
|
name: "typeName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<Void> setLabelsByUniqueAttributeWithResponse(String typeName, RequestOptions requestOptions)"
|
|
desc: "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.\n\n**Query Parameters**\n\n | ------------------ | ------ | -------- | -------------------------------- |\n | Name | Type | Required | Description |\n | attr:qualifiedName | String | No | The qualified name of the entity |\n\n**Request Body Schema**\n\n```java\n[\n String\n ]\n```"
|
|
returns:
|
|
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.analytics.purview.catalog.EntityClient.setLabelsWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.EntityClient.setLabelsWithResponse(String guid, RequestOptions requestOptions)"
|
|
name: "setLabelsWithResponse(String guid, RequestOptions requestOptions)"
|
|
nameWithType: "EntityClient.setLabelsWithResponse(String guid, RequestOptions requestOptions)"
|
|
summary: "Set labels to a given entity."
|
|
parameters:
|
|
- description: "The globally unique identifier of the entity."
|
|
name: "guid"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<Void> setLabelsWithResponse(String guid, RequestOptions requestOptions)"
|
|
desc: "Set labels to a given entity.\n\n**Request Body Schema**\n\n```java\n[\n String\n ]\n```"
|
|
returns:
|
|
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.analytics.purview.catalog.EntityClient.updateClassificationsByUniqueAttributeWithResponse(java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.EntityClient.updateClassificationsByUniqueAttributeWithResponse(String typeName, BinaryData atlasClassificationArray, RequestOptions requestOptions)"
|
|
name: "updateClassificationsByUniqueAttributeWithResponse(String typeName, BinaryData atlasClassificationArray, RequestOptions requestOptions)"
|
|
nameWithType: "EntityClient.updateClassificationsByUniqueAttributeWithResponse(String typeName, BinaryData atlasClassificationArray, RequestOptions requestOptions)"
|
|
summary: "Update classification on an entity identified by its type and unique attributes."
|
|
parameters:
|
|
- description: "The name of the type."
|
|
name: "typeName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "An array of classification to be updated."
|
|
name: "atlasClassificationArray"
|
|
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<Void> updateClassificationsByUniqueAttributeWithResponse(String typeName, BinaryData atlasClassificationArray, RequestOptions requestOptions)"
|
|
desc: "Update classification on an entity identified by its type and unique attributes.\n\n**Query Parameters**\n\n | ------------------ | ------ | -------- | --------------------------------- |\n | Name | Type | Required | Description |\n | attr:qualifiedName | String | No | The qualified name of the entity. |\n\n**Request Body Schema**\n\n```java\n[\n {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n entityGuid: String\n entityStatus: String(ACTIVE/DELETED)\n removePropagationsOnEntityDelete: Boolean\n validityPeriods: [\n {\n endTime: String\n startTime: String\n timeZone: String\n }\n ]\n source: String\n sourceDetails: {\n String: Object\n }\n }\n ]\n```"
|
|
returns:
|
|
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.analytics.purview.catalog.EntityClient.updateClassificationsWithResponse(java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.EntityClient.updateClassificationsWithResponse(String guid, BinaryData classifications, RequestOptions requestOptions)"
|
|
name: "updateClassificationsWithResponse(String guid, BinaryData classifications, RequestOptions requestOptions)"
|
|
nameWithType: "EntityClient.updateClassificationsWithResponse(String guid, BinaryData classifications, RequestOptions requestOptions)"
|
|
summary: "Update classifications to an existing entity represented by a guid."
|
|
parameters:
|
|
- description: "The globally unique identifier of the entity."
|
|
name: "guid"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "An array of classifications to be updated."
|
|
name: "classifications"
|
|
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<Void> updateClassificationsWithResponse(String guid, BinaryData classifications, RequestOptions requestOptions)"
|
|
desc: "Update classifications to an existing entity represented by a guid.\n\n**Request Body Schema**\n\n```java\n[\n {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n entityGuid: String\n entityStatus: String(ACTIVE/DELETED)\n removePropagationsOnEntityDelete: Boolean\n validityPeriods: [\n {\n endTime: String\n startTime: String\n timeZone: String\n }\n ]\n source: String\n sourceDetails: {\n String: Object\n }\n }\n ]\n```"
|
|
returns:
|
|
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
type: "class"
|
|
desc: "Initializes a new instance of the synchronous PurviewCatalogClient type."
|
|
metadata: {}
|
|
package: "com.azure.analytics.purview.catalog"
|
|
artifact: com.azure:azure-analytics-purview-catalog:1.0.0-beta.4
|