Class DiscoveryClient
java.lang.Object
com.azure.analytics.purview.catalog.DiscoveryClient
Initializes a new instance of the synchronous PurviewCatalogClient type.
-
Method Summary
Modifier and TypeMethodDescriptionautoCompleteWithResponse
(BinaryData autoCompleteRequest, RequestOptions requestOptions) Get auto complete options.browseWithResponse
(BinaryData browseRequest, RequestOptions requestOptions) Browse entities by path or entity type.queryWithResponse
(BinaryData searchRequest, RequestOptions requestOptions) Gets data using search.suggestWithResponse
(BinaryData suggestRequest, RequestOptions requestOptions) Get search suggestions by query criteria.
-
Method Details
-
queryWithResponse
public Response<BinaryData> queryWithResponse(BinaryData searchRequest, 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:
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.
-
suggestWithResponse
public Response<BinaryData> suggestWithResponse(BinaryData suggestRequest, 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:
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.
-
browseWithResponse
public Response<BinaryData> browseWithResponse(BinaryData browseRequest, 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:
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.
-
autoCompleteWithResponse
public Response<BinaryData> autoCompleteWithResponse(BinaryData autoCompleteRequest, 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:
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.
-