90 строки
22 KiB
YAML
90 строки
22 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.analytics.purview.catalog.CollectionAsyncClient"
|
|
fullName: "com.azure.analytics.purview.catalog.CollectionAsyncClient"
|
|
name: "CollectionAsyncClient"
|
|
nameWithType: "CollectionAsyncClient"
|
|
summary: "Initializes a new instance of the asynchronous 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 **CollectionAsyncClient**"
|
|
methods:
|
|
- uid: "com.azure.analytics.purview.catalog.CollectionAsyncClient.createOrUpdateBulkWithResponse(java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.CollectionAsyncClient.createOrUpdateBulkWithResponse(String collection, BinaryData entities, RequestOptions requestOptions)"
|
|
name: "createOrUpdateBulkWithResponse(String collection, BinaryData entities, RequestOptions requestOptions)"
|
|
nameWithType: "CollectionAsyncClient.createOrUpdateBulkWithResponse(String collection, BinaryData entities, RequestOptions requestOptions)"
|
|
summary: "Creates or updates entities in bulk to a collection."
|
|
parameters:
|
|
- description: "the collection unique name."
|
|
name: "collection"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Atlas entities with extended information."
|
|
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 Mono<Response<BinaryData>> createOrUpdateBulkWithResponse(String collection, BinaryData entities, RequestOptions requestOptions)"
|
|
desc: "Creates or updates entities in bulk to a collection. 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> on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<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.CollectionAsyncClient.createOrUpdateWithResponse(java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.CollectionAsyncClient.createOrUpdateWithResponse(String collection, BinaryData entity, RequestOptions requestOptions)"
|
|
name: "createOrUpdateWithResponse(String collection, BinaryData entity, RequestOptions requestOptions)"
|
|
nameWithType: "CollectionAsyncClient.createOrUpdateWithResponse(String collection, BinaryData entity, RequestOptions requestOptions)"
|
|
summary: "Creates or updates an entity to a collection."
|
|
parameters:
|
|
- description: "the collection unique name."
|
|
name: "collection"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- 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 Mono<Response<BinaryData>> createOrUpdateWithResponse(String collection, BinaryData entity, RequestOptions requestOptions)"
|
|
desc: "Creates or updates an entity to a collection. 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> on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<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.CollectionAsyncClient.moveEntitiesToCollectionWithResponse(java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.CollectionAsyncClient.moveEntitiesToCollectionWithResponse(String collection, BinaryData moveEntitiesRequest, RequestOptions requestOptions)"
|
|
name: "moveEntitiesToCollectionWithResponse(String collection, BinaryData moveEntitiesRequest, RequestOptions requestOptions)"
|
|
nameWithType: "CollectionAsyncClient.moveEntitiesToCollectionWithResponse(String collection, BinaryData moveEntitiesRequest, RequestOptions requestOptions)"
|
|
summary: "Move existing entities to the target collection."
|
|
parameters:
|
|
- description: "the collection unique name."
|
|
name: "collection"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Entity guids to be moved to target collection."
|
|
name: "moveEntitiesRequest"
|
|
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 Mono<Response<BinaryData>> moveEntitiesToCollectionWithResponse(String collection, BinaryData moveEntitiesRequest, RequestOptions requestOptions)"
|
|
desc: "Move existing entities to the target collection.\n\n**Request Body Schema**\n\n```java\n{\n entityGuids: [\n String\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> on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<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\" />>>"
|
|
type: "class"
|
|
desc: "Initializes a new instance of the asynchronous PurviewCatalogClient type."
|
|
metadata: {}
|
|
package: "com.azure.analytics.purview.catalog"
|
|
artifact: com.azure:azure-analytics-purview-catalog:1.0.0-beta.4
|