Package com.azure.analytics.purview.administration

Class CollectionsAsyncClient

java.lang.Object
com.azure.analytics.purview.administration.CollectionsAsyncClient
public final class CollectionsAsyncClient extends Object
Initializes a new instance of the asynchronous PurviewAccountClient type.

  • Method Details

    • getCollectionWithResponse

      public Mono<Response<BinaryData>> getCollectionWithResponse(String collectionName, RequestOptions requestOptions)
      Get a collection.

      Response Body Schema 

      
 {
     collectionProvisioningState: String(Unknown/Creating/Moving/Deleting/Failed/Succeeded)
     description: String
     friendlyName: String
     name: String
     parentCollection: {
         referenceName: String
         type: String
     }
     systemData: {
         createdAt: OffsetDateTime
         createdBy: String
         createdByType: String(User/Application/ManagedIdentity/Key)
         lastModifiedAt: OffsetDateTime
         lastModifiedBy: String
         lastModifiedByType: String(User/Application/ManagedIdentity/Key)
     }
 }
      Parameters:
      collectionName - The collectionName parameter.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      a collection along with Response on successful completion of Mono.
      Throws:
      HttpResponseException - thrown if the request is rejected by server.
      ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • createOrUpdateCollectionWithResponse

      public Mono<Response<BinaryData>> createOrUpdateCollectionWithResponse(String collectionName, BinaryData collection, RequestOptions requestOptions)
      Creates or updates a collection entity.

      Request Body Schema 

      
 {
     collectionProvisioningState: String(Unknown/Creating/Moving/Deleting/Failed/Succeeded)
     description: String
     friendlyName: String
     name: String
     parentCollection: {
         referenceName: String
         type: String
     }
     systemData: {
         createdAt: OffsetDateTime
         createdBy: String
         createdByType: String(User/Application/ManagedIdentity/Key)
         lastModifiedAt: OffsetDateTime
         lastModifiedBy: String
         lastModifiedByType: String(User/Application/ManagedIdentity/Key)
     }
 }

      Response Body Schema 

      
 {
     collectionProvisioningState: String(Unknown/Creating/Moving/Deleting/Failed/Succeeded)
     description: String
     friendlyName: String
     name: String
     parentCollection: {
         referenceName: String
         type: String
     }
     systemData: {
         createdAt: OffsetDateTime
         createdBy: String
         createdByType: String(User/Application/ManagedIdentity/Key)
         lastModifiedAt: OffsetDateTime
         lastModifiedBy: String
         lastModifiedByType: String(User/Application/ManagedIdentity/Key)
     }
 }
      Parameters:
      collectionName - The collectionName parameter.
      collection - Collection resource.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      collection resource along with Response on successful completion of Mono.
      Throws:
      HttpResponseException - thrown if the request is rejected by server.
      ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • deleteCollectionWithResponse

      public Mono<Response<Void>> deleteCollectionWithResponse(String collectionName, RequestOptions requestOptions)
      Deletes a Collection entity.
      Parameters:
      collectionName - The collectionName parameter.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      HttpResponseException - thrown if the request is rejected by server.
      ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • listCollections

      public PagedFlux<BinaryData> listCollections(RequestOptions requestOptions)
      List the collections in the account.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      $skipTokenStringNoThe skipToken parameter

      Response Body Schema 

      
 {
     count: Long
     nextLink: String
     value: [
         {
             collectionProvisioningState: String(Unknown/Creating/Moving/Deleting/Failed/Succeeded)
             description: String
             friendlyName: String
             name: String
             parentCollection: {
                 referenceName: String
                 type: String
             }
             systemData: {
                 createdAt: OffsetDateTime
                 createdBy: String
                 createdByType: String(User/Application/ManagedIdentity/Key)
                 lastModifiedAt: OffsetDateTime
                 lastModifiedBy: String
                 lastModifiedByType: String(User/Application/ManagedIdentity/Key)
             }
         }
     ]
 }
      Parameters:
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      paged list of collections as paginated response with PagedFlux.
      Throws:
      HttpResponseException - thrown if the request is rejected by server.
      ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • listChildCollectionNames

      public PagedFlux<BinaryData> listChildCollectionNames(String collectionName, RequestOptions requestOptions)
      Lists the child collections names in the collection.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      $skipTokenStringNoThe skipToken parameter

      Response Body Schema 

      
 {
     count: Long
     nextLink: String
     value: [
         {
             friendlyName: String
             name: String
         }
     ]
 }
      Parameters:
      collectionName - The collectionName parameter.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      paged list of collections as paginated response with PagedFlux.
      Throws:
      HttpResponseException - thrown if the request is rejected by server.
      ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • getCollectionPathWithResponse

      public Mono<Response<BinaryData>> getCollectionPathWithResponse(String collectionName, RequestOptions requestOptions)
      Gets the parent name and parent friendly name chains that represent the collection path.

      Response Body Schema 

      
 {
     parentFriendlyNameChain: [
         String
     ]
     parentNameChain: [
         String
     ]
 }
      Parameters:
      collectionName - The collectionName parameter.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the parent name and parent friendly name chains that represent the collection path along with Response on successful completion of Mono.
      Throws:
      HttpResponseException - thrown if the request is rejected by server.
      ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      ResourceModifiedException - thrown if the request is rejected by server on status code 409.