PurviewCatalogClient.Search(RequestContent, RequestContext) Method

Reference

Definition

Namespace:: Azure.Analytics.Purview.Catalog

Assembly:: Azure.Analytics.Purview.Catalog.dll

Package:: Azure.Analytics.Purview.Catalog v1.0.0-beta.4

Source:: PurviewCatalogClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets data using search.

public virtual Azure.Response Search (Azure.Core.RequestContent content, Azure.RequestContext context = default);

abstract member Search : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.Search : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response

Public Overridable Function Search (content As RequestContent, Optional context As RequestContext = Nothing) As Response

Parameters

content: RequestContent

The content to send as the body of the request.

context: RequestContext

The request context, which can override default behaviors on the request on a per-call basis.

Returns

Response

Exceptions

ArgumentNullException

content is null.

Remarks

Schema for Request Body:

{
              keywords: string,
              offset: number,
              limit: number,
              filter: AnyObject,
              facets: [
                {
                  count: number,
                  facet: string,
                  sort: AnyObject
                }
              ],
              taxonomySetting: {
                assetTypes: [string],
                facet: SearchFacetItem
              }
            }

Schema for Response Body:

{
              @search.count: number,
              @search.facets: {
                assetType: [
                  {
                    count: number,
                    value: string
                  }
                ],
                classification: [SearchFacetItemValue],
                classificationCategory: [SearchFacetItemValue],
                contactId: [SearchFacetItemValue],
                fileExtension: [SearchFacetItemValue],
                label: [SearchFacetItemValue],
                term: [SearchFacetItemValue]
              },
              value: [SearchResultValue]
            }

Schema for Response Error:

{
              requestId: string,
              errorCode: string,
              errorMessage: string
            }

Applies to

Share via