com.azure.analytics.purview.datamap.DiscoveryClient

public final class DiscoveryClient extends Object

Initializes a new instance of the synchronous DataMapClient type.

Method Summary

Modifier and Type

Method

Description

AutoCompleteResult

autoComplete(AutoCompleteOptions body)

Get auto complete options.

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

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

Get auto complete options.

QueryResult

query(QueryOptions body)

Get data using search.

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

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

Get data using search.

SuggestResult

suggest(SuggestOptions body)

Get search suggestions by query criteria.

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

suggestWithResponse(com.azure.core.util.BinaryData body, 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 body, com.azure.core.http.rest.RequestOptions requestOptions)

Get data using search.

Request Body Schema

 
 {
     keywords: String (Optional)
     limit: Integer (Optional)
     continuationToken: String (Optional)
     orderby (Optional): [
         BinaryData (Optional)
     ]
     filter: BinaryData (Optional)
     facets (Optional): [
          (Optional){
             count: Integer (Optional)
             facet: String (Optional)
             sort (Optional): {
                 count: String(asc/desc) (Optional)
                 value: String(asc/desc) (Optional)
             }
         }
     ]
     taxonomySetting (Optional): {
         assetTypes (Optional): [
             String (Optional)
         ]
         facet (Optional): (recursive schema, see facet above)
     }
 }

Response Body Schema

 
 {
     &#64;search.count: Integer (Optional)
     &#64;search.count.approximate: Boolean (Optional)
     continuationToken: String (Optional)
     &#64;search.facets (Optional): {
         entityType (Optional): [
              (Optional){
                 count: Integer (Optional)
                 value: String (Optional)
             }
         ]
         assetType (Optional): [
             (recursive schema, see above)
         ]
         classification (Optional): [
             (recursive schema, see above)
         ]
         term (Optional): [
             (recursive schema, see above)
         ]
         contactId (Optional): [
             (recursive schema, see above)
         ]
         contactType (Optional): [
             (recursive schema, see above)
         ]
         label (Optional): [
             (recursive schema, see above)
         ]
         glossaryType (Optional): [
             (recursive schema, see above)
         ]
         termStatus (Optional): [
             (recursive schema, see above)
         ]
         termTemplate (Optional): [
             (recursive schema, see above)
         ]
     }
     value (Optional): [
          (Optional){
             &#64;search.score: Double (Optional)
             &#64;search.highlights (Optional): {
                 id (Optional): [
                     String (Optional)
                 ]
                 qualifiedName (Optional): [
                     String (Optional)
                 ]
                 name (Optional): [
                     String (Optional)
                 ]
                 description (Optional): [
                     String (Optional)
                 ]
                 entityType (Optional): [
                     String (Optional)
                 ]
             }
             objectType: String (Optional)
             createTime: Long (Optional)
             updateTime: Long (Optional)
             id: String (Optional)
             name: String (Optional)
             qualifiedName: String (Optional)
             entityType: String (Optional)
             description: String (Optional)
             endorsement (Optional): [
                 String (Optional)
             ]
             owner: String (Optional)
             classification (Optional): [
                 String (Optional)
             ]
             label (Optional): [
                 String (Optional)
             ]
             term (Optional): [
                  (Optional){
                     name: String (Optional)
                     glossaryName: String (Optional)
                     guid: String (Optional)
                 }
             ]
             contact (Optional): [
                  (Optional){
                     id: String (Optional)
                     info: String (Optional)
                     contactType: String (Optional)
                 }
             ]
             assetType (Optional): [
                 String (Optional)
             ]
             glossaryType: String (Optional)
             glossary: String (Optional)
             termStatus: String (Optional)
             termTemplate (Optional): [
                 String (Optional)
             ]
             longDescription: String (Optional)
         }
     ]
 }

Parameters:: body - Body parameter.; 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 body, com.azure.core.http.rest.RequestOptions requestOptions)

Get search suggestions by query criteria.

Request Body Schema

 
 {
     keywords: String (Optional)
     limit: Integer (Optional)
     filter: BinaryData (Optional)
 }

Response Body Schema

 
 {
     value (Optional): [
          (Optional){
             &#64;search.score: Double (Optional)
             &#64;search.text: String (Optional)
             objectType: String (Optional)
             createTime: Long (Optional)
             updateTime: Long (Optional)
             id: String (Optional)
             name: String (Optional)
             qualifiedName: String (Optional)
             entityType: String (Optional)
             description: String (Optional)
             endorsement (Optional): [
                 String (Optional)
             ]
             owner: String (Optional)
             classification (Optional): [
                 String (Optional)
             ]
             label (Optional): [
                 String (Optional)
             ]
             term (Optional): [
                  (Optional){
                     name: String (Optional)
                     glossaryName: String (Optional)
                     guid: String (Optional)
                 }
             ]
             contact (Optional): [
                  (Optional){
                     id: String (Optional)
                     info: String (Optional)
                     contactType: String (Optional)
                 }
             ]
             assetType (Optional): [
                 String (Optional)
             ]
             glossaryType: String (Optional)
             glossary: String (Optional)
             termStatus: String (Optional)
             termTemplate (Optional): [
                 String (Optional)
             ]
             longDescription: String (Optional)
         }
     ]
 }

Parameters:: body - Body parameter.; 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.

autoCompleteWithResponse

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

body - Body parameter.

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

public QueryResult query(QueryOptions body)

Get data using search.

Parameters:

body - Body parameter.

Returns:

data using search.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

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.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
suggest

public SuggestResult suggest(SuggestOptions body)

Get search suggestions by query criteria.

Parameters:

body - Body parameter.

Returns:

search suggestions by query criteria.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

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.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
autoComplete

public AutoCompleteResult autoComplete(AutoCompleteOptions body)

Get auto complete options.

Parameters:

body - Body parameter.

Returns:

auto complete options.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

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.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

Class DiscoveryClient

Method Summary

Methods inherited from class java.lang.Object

Method Details

queryWithResponse

suggestWithResponse

autoCompleteWithResponse

query

suggest

autoComplete