98 строки
14 KiB
YAML
98 строки
14 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.analytics.purview.catalog.DiscoveryAsyncClient"
|
|
fullName: "com.azure.analytics.purview.catalog.DiscoveryAsyncClient"
|
|
name: "DiscoveryAsyncClient"
|
|
nameWithType: "DiscoveryAsyncClient"
|
|
summary: "Initializes a new instance of the asynchronous Purview<wbr>Catalog<wbr>Client type."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **DiscoveryAsyncClient**"
|
|
methods:
|
|
- uid: "com.azure.analytics.purview.catalog.DiscoveryAsyncClient.autoCompleteWithResponse(com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.DiscoveryAsyncClient.autoCompleteWithResponse(BinaryData autoCompleteRequest, RequestOptions requestOptions)"
|
|
name: "autoCompleteWithResponse(BinaryData autoCompleteRequest, RequestOptions requestOptions)"
|
|
nameWithType: "DiscoveryAsyncClient.autoCompleteWithResponse(BinaryData autoCompleteRequest, RequestOptions requestOptions)"
|
|
summary: "Get auto complete options."
|
|
parameters:
|
|
- description: "An object specifying the autocomplete criteria."
|
|
name: "autoCompleteRequest"
|
|
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<BinaryData>> autoCompleteWithResponse(BinaryData autoCompleteRequest, RequestOptions requestOptions)"
|
|
desc: "Get auto complete options.\n\n**Request Body Schema**\n\n```java\n{\n keywords: String\n limit: Integer\n filter: Object\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n value: [\n {\n text: String\n queryPlusText: String\n }\n ]\n }\n```"
|
|
returns:
|
|
description: "auto complete options along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>>"
|
|
- uid: "com.azure.analytics.purview.catalog.DiscoveryAsyncClient.browseWithResponse(com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.DiscoveryAsyncClient.browseWithResponse(BinaryData browseRequest, RequestOptions requestOptions)"
|
|
name: "browseWithResponse(BinaryData browseRequest, RequestOptions requestOptions)"
|
|
nameWithType: "DiscoveryAsyncClient.browseWithResponse(BinaryData browseRequest, RequestOptions requestOptions)"
|
|
summary: "Browse entities by path or entity type."
|
|
parameters:
|
|
- description: "An object specifying the browse criteria."
|
|
name: "browseRequest"
|
|
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<BinaryData>> browseWithResponse(BinaryData browseRequest, RequestOptions requestOptions)"
|
|
desc: "Browse entities by path or entity type.\n\n**Request Body Schema**\n\n```java\n{\n entityType: String\n path: String\n limit: Integer\n offset: Integer\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n searchCount: Integer\n value: [\n {\n entityType: String\n id: String\n isLeaf: Boolean\n name: String\n owner: [\n {\n id: String\n displayName: String\n mail: String\n contactType: String\n }\n ]\n path: String\n qualifiedName: String\n }\n ]\n }\n```"
|
|
returns:
|
|
description: "browseResult along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>>"
|
|
- uid: "com.azure.analytics.purview.catalog.DiscoveryAsyncClient.queryWithResponse(com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.DiscoveryAsyncClient.queryWithResponse(BinaryData searchRequest, RequestOptions requestOptions)"
|
|
name: "queryWithResponse(BinaryData searchRequest, RequestOptions requestOptions)"
|
|
nameWithType: "DiscoveryAsyncClient.queryWithResponse(BinaryData searchRequest, RequestOptions requestOptions)"
|
|
summary: "Gets data using search."
|
|
parameters:
|
|
- description: "An object specifying the search criteria."
|
|
name: "searchRequest"
|
|
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<BinaryData>> queryWithResponse(BinaryData searchRequest, RequestOptions requestOptions)"
|
|
desc: "Gets data using search.\n\n**Request Body Schema**\n\n```java\n{\n keywords: String\n offset: Integer\n limit: Integer\n filter: Object\n facets: [\n {\n count: Integer\n facet: String\n sort: Object\n }\n ]\n taxonomySetting: {\n assetTypes: [\n String\n ]\n facet: (recursive schema, see facet above)\n }\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n searchCount: Integer\n searchFacets: {\n assetType: [\n {\n count: Integer\n value: String\n }\n ]\n classification: [\n (recursive schema, see above)\n ]\n classificationCategory: [\n (recursive schema, see above)\n ]\n contactId: [\n (recursive schema, see above)\n ]\n fileExtension: [\n (recursive schema, see above)\n ]\n label: [\n (recursive schema, see above)\n ]\n term: [\n (recursive schema, see above)\n ]\n }\n value: [\n {\n searchScore: Float\n searchHighlights: {\n id: [\n String\n ]\n qualifiedName: [\n String\n ]\n name: [\n String\n ]\n description: [\n String\n ]\n entityType: [\n String\n ]\n }\n searchText: String\n description: String\n id: String\n name: String\n owner: String\n qualifiedName: String\n entityType: String\n classification: [\n String\n ]\n label: [\n String\n ]\n term: [\n {\n name: String\n glossaryName: String\n guid: String\n }\n ]\n contact: [\n {\n id: String\n info: String\n contactType: String\n }\n ]\n assetType: [\n String\n ]\n }\n ]\n }\n```"
|
|
returns:
|
|
description: "data using search along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>>"
|
|
- uid: "com.azure.analytics.purview.catalog.DiscoveryAsyncClient.suggestWithResponse(com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.DiscoveryAsyncClient.suggestWithResponse(BinaryData suggestRequest, RequestOptions requestOptions)"
|
|
name: "suggestWithResponse(BinaryData suggestRequest, RequestOptions requestOptions)"
|
|
nameWithType: "DiscoveryAsyncClient.suggestWithResponse(BinaryData suggestRequest, RequestOptions requestOptions)"
|
|
summary: "Get search suggestions by query criteria."
|
|
parameters:
|
|
- description: "An object specifying the suggest criteria."
|
|
name: "suggestRequest"
|
|
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<BinaryData>> suggestWithResponse(BinaryData suggestRequest, RequestOptions requestOptions)"
|
|
desc: "Get search suggestions by query criteria.\n\n**Request Body Schema**\n\n```java\n{\n keywords: String\n limit: Integer\n filter: Object\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n value: [\n {\n searchScore: Float\n searchText: String\n description: String\n id: String\n name: String\n owner: String\n qualifiedName: String\n entityType: String\n classification: [\n String\n ]\n label: [\n String\n ]\n term: [\n {\n name: String\n glossaryName: String\n guid: String\n }\n ]\n contact: [\n {\n id: String\n info: String\n contactType: String\n }\n ]\n assetType: [\n String\n ]\n }\n ]\n }\n```"
|
|
returns:
|
|
description: "search suggestions by query criteria along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>>"
|
|
type: "class"
|
|
desc: "Initializes a new instance of the asynchronous PurviewCatalogClient type."
|
|
metadata: {}
|
|
package: "com.azure.analytics.purview.catalog"
|
|
artifact: com.azure:azure-analytics-purview-catalog:1.0.0-beta.4
|