java.lang.Object
- com.azure.analytics.purview.catalog.CollectionAsyncClient

```
public final class CollectionAsyncClient
extends Object
```
Initializes a new instance of the asynchronous PurviewCatalogClient type.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>`	`createOrUpdateBulkWithResponse(String collection, com.azure.core.util.BinaryData entities, com.azure.core.http.rest.RequestOptions requestOptions)`	Creates or updates entities in bulk to a collection.
`Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>`	`createOrUpdateWithResponse(String collection, com.azure.core.util.BinaryData entity, com.azure.core.http.rest.RequestOptions requestOptions)`	Creates or updates an entity to a collection.
`Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>`	`moveEntitiesToCollectionWithResponse(String collection, com.azure.core.util.BinaryData moveEntitiesRequest, com.azure.core.http.rest.RequestOptions requestOptions)`	Move existing entities to the target collection.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createOrUpdateWithResponse

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

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

Query Parameters

Query Parameters
Name	Type	Required	Description
api-version	String	Yes	Api Version

Request Body Schema


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

Response Body Schema


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

Parameters:: collection - the collection unique name.; entity - Atlas entity with extended information.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: entityMutationResponse along with Response on successful completion of Mono.
Throws:: com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.; com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.; com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.; com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

createOrUpdateBulkWithResponse

public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> createOrUpdateBulkWithResponse(String collection,
                                                                                                              com.azure.core.util.BinaryData entities,
                                                                                                              com.azure.core.http.rest.RequestOptions requestOptions)

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

Query Parameters

Query Parameters
Name	Type	Required	Description
api-version	String	Yes	Api Version

Request Body Schema


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

Response Body Schema


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

Parameters:: collection - the collection unique name.; entities - Atlas entities with extended information.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: entityMutationResponse along with Response on successful completion of Mono.
Throws:: com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.; com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.; com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.; com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

moveEntitiesToCollectionWithResponse

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

Move existing entities to the target collection.

Query Parameters

Query Parameters
Name	Type	Required	Description
api-version	String	Yes	Api Version

Request Body Schema


 {
     entityGuids: [
         String
     ]
 }

Response Body Schema


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

Parameters:: collection - the collection unique name.; moveEntitiesRequest - Entity guids to be moved to target collection.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: entityMutationResponse along with Response on successful completion of Mono.
Throws:: com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.; com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.; com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.; com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

Class CollectionAsyncClient

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createOrUpdateWithResponse

createOrUpdateBulkWithResponse

moveEntitiesToCollectionWithResponse