com.azure.analytics.purview.catalog.DiscoveryClient

public final class DiscoveryClient extends Object

Initializes a new instance of the synchronous PurviewCatalogClient type.

Method Summary

Modifier and Type

Method

Description

com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>

autoCompleteWithResponse(com.azure.core.util.BinaryData autoCompleteRequest, com.azure.core.http.rest.RequestOptions requestOptions)

Get auto complete options.

com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>

browseWithResponse(com.azure.core.util.BinaryData browseRequest, com.azure.core.http.rest.RequestOptions requestOptions)

Browse entities by path or entity type.

com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>

queryWithResponse(com.azure.core.util.BinaryData searchRequest, com.azure.core.http.rest.RequestOptions requestOptions)

Gets data using search.

com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>

suggestWithResponse(com.azure.core.util.BinaryData suggestRequest, com.azure.core.http.rest.RequestOptions requestOptions)

Get search suggestions by query criteria.

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

Method Details

queryWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> queryWithResponse(com.azure.core.util.BinaryData searchRequest, com.azure.core.http.rest.RequestOptions requestOptions)

Gets data using search.

Request Body Schema


 {
     keywords: String
     offset: Integer
     limit: Integer
     filter: Object
     facets: [
         {
             count: Integer
             facet: String
             sort: Object
         }
     ]
     taxonomySetting: {
         assetTypes: [
             String
         ]
         facet: (recursive schema, see facet above)
     }
 }

Response Body Schema


 {
     searchCount: Integer
     searchFacets: {
         assetType: [
             {
                 count: Integer
                 value: String
             }
         ]
         classification: [
             (recursive schema, see above)
         ]
         classificationCategory: [
             (recursive schema, see above)
         ]
         contactId: [
             (recursive schema, see above)
         ]
         fileExtension: [
             (recursive schema, see above)
         ]
         label: [
             (recursive schema, see above)
         ]
         term: [
             (recursive schema, see above)
         ]
     }
     value: [
         {
             searchScore: Float
             searchHighlights: {
                 id: [
                     String
                 ]
                 qualifiedName: [
                     String
                 ]
                 name: [
                     String
                 ]
                 description: [
                     String
                 ]
                 entityType: [
                     String
                 ]
             }
             searchText: String
             description: String
             id: String
             name: String
             owner: String
             qualifiedName: String
             entityType: String
             classification: [
                 String
             ]
             label: [
                 String
             ]
             term: [
                 {
                     name: String
                     glossaryName: String
                     guid: String
                 }
             ]
             contact: [
                 {
                     id: String
                     info: String
                     contactType: String
                 }
             ]
             assetType: [
                 String
             ]
         }
     ]
 }

Parameters:: searchRequest - An object specifying the search criteria.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: data using search along with Response.
Throws:: com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.; com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.; com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.; com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

suggestWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> suggestWithResponse(com.azure.core.util.BinaryData suggestRequest, com.azure.core.http.rest.RequestOptions requestOptions)
Get search suggestions by query criteria.
Request Body Schema
```
 {
     keywords: String
     limit: Integer
     filter: Object
 }
 
```
Response Body Schema
```
 {
     value: [
         {
             searchScore: Float
             searchText: String
             description: String
             id: String
             name: String
             owner: String
             qualifiedName: String
             entityType: String
             classification: [
                 String
             ]
             label: [
                 String
             ]
             term: [
                 {
                     name: String
                     glossaryName: String
                     guid: String
                 }
             ]
             contact: [
                 {
                     id: String
                     info: String
                     contactType: String
                 }
             ]
             assetType: [
                 String
             ]
         }
     ]
 }
 
```
Parameters:

suggestRequest - An object specifying the suggest criteria.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

search suggestions by query criteria along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
browseWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> browseWithResponse(com.azure.core.util.BinaryData browseRequest, com.azure.core.http.rest.RequestOptions requestOptions)
Browse entities by path or entity type.
Request Body Schema
```
 {
     entityType: String
     path: String
     limit: Integer
     offset: Integer
 }
 
```
Response Body Schema
```
 {
     searchCount: Integer
     value: [
         {
             entityType: String
             id: String
             isLeaf: Boolean
             name: String
             owner: [
                 {
                     id: String
                     displayName: String
                     mail: String
                     contactType: String
                 }
             ]
             path: String
             qualifiedName: String
         }
     ]
 }
 
```
Parameters:

browseRequest - An object specifying the browse criteria.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

browseResult along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
autoCompleteWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> autoCompleteWithResponse(com.azure.core.util.BinaryData autoCompleteRequest, com.azure.core.http.rest.RequestOptions requestOptions)
Get auto complete options.
Request Body Schema
```
 {
     keywords: String
     limit: Integer
     filter: Object
 }
 
```
Response Body Schema
```
 {
     value: [
         {
             text: String
             queryPlusText: String
         }
     ]
 }
 
```
Parameters:

autoCompleteRequest - An object specifying the autocomplete criteria.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

auto complete options along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

Class DiscoveryClient

Method Summary

Methods inherited from class java.lang.Object

Method Details

queryWithResponse

suggestWithResponse

browseWithResponse

autoCompleteWithResponse