azure.purview.catalog.rest.discovery package

azure.purview.catalog.rest.discovery.build_query_request(*, json: Any = None, content: Any = None, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]

Gets data using search.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Keyword Arguments
  • json (Any) – An object specifying the search criteria.

  • content (Any) – An object specifying the search criteria.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# JSON input template you can fill out and use as your `json` input.
json = {
    "facets": [
        {
            "count": "int (optional)",
            "facet": "str (optional)",
            "sort": "object (optional)"
        }
    ],
    "filter": "object (optional)",
    "keywords": "str (optional)",
    "limit": "int (optional)",
    "offset": "int (optional)",
    "taxonomySetting": {
        "assetTypes": [
            "str (optional)"
        ],
        "facet": {
            "count": "int (optional)",
            "facet": "str (optional)",
            "sort": "object (optional)"
        }
    }
}


# response body for status code(s): 200
response_body == {
    "@search.count": "int (optional)",
    "@search.facets": {
        "assetType": [
            {
                "count": "int (optional)",
                "value": "str (optional)"
            }
        ],
        "classification": [
            {
                "count": "int (optional)",
                "value": "str (optional)"
            }
        ],
        "classificationCategory": [
            {
                "count": "int (optional)",
                "value": "str (optional)"
            }
        ],
        "contactId": [
            {
                "count": "int (optional)",
                "value": "str (optional)"
            }
        ],
        "fileExtension": [
            {
                "count": "int (optional)",
                "value": "str (optional)"
            }
        ],
        "label": [
            {
                "count": "int (optional)",
                "value": "str (optional)"
            }
        ],
        "term": [
            {
                "count": "int (optional)",
                "value": "str (optional)"
            }
        ]
    },
    "value": [
        {
            "@search.highlights": {
                "description": [
                    "str (optional)"
                ],
                "entityType": [
                    "str (optional)"
                ],
                "id": [
                    "str (optional)"
                ],
                "name": [
                    "str (optional)"
                ],
                "qualifiedName": [
                    "str (optional)"
                ]
            },
            "@search.score": "float (optional)",
            "@search.text": "str (optional)",
            "assetType": [
                "str (optional)"
            ],
            "classification": [
                "str (optional)"
            ],
            "contact": [
                {
                    "contactType": "str (optional)",
                    "id": "str (optional)",
                    "info": "str (optional)"
                }
            ],
            "description": "str (optional)",
            "entityType": "str (optional)",
            "id": "str (optional)",
            "label": [
                "str (optional)"
            ],
            "name": "str (optional)",
            "owner": "str (optional)",
            "qualifiedName": "str (optional)",
            "term": [
                {
                    "glossaryName": "str (optional)",
                    "guid": "str (optional)",
                    "name": "str (optional)"
                }
            ]
        }
    ]
}
azure.purview.catalog.rest.discovery.build_suggest_request(*, json: Any = None, content: Any = None, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]

Get search suggestions by query criteria.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Keyword Arguments
  • json (Any) – An object specifying the suggest criteria.

  • content (Any) – An object specifying the suggest criteria.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# JSON input template you can fill out and use as your `json` input.
json = {
    "filter": "object (optional)",
    "keywords": "str (optional)",
    "limit": "int (optional)"
}


# response body for status code(s): 200
response_body == {
    "value": [
        {
            "@search.score": "float (optional)",
            "@search.text": "str (optional)",
            "assetType": [
                "str (optional)"
            ],
            "classification": [
                "str (optional)"
            ],
            "contact": [
                {
                    "contactType": "str (optional)",
                    "id": "str (optional)",
                    "info": "str (optional)"
                }
            ],
            "description": "str (optional)",
            "entityType": "str (optional)",
            "id": "str (optional)",
            "label": [
                "str (optional)"
            ],
            "name": "str (optional)",
            "owner": "str (optional)",
            "qualifiedName": "str (optional)",
            "term": [
                {
                    "glossaryName": "str (optional)",
                    "guid": "str (optional)",
                    "name": "str (optional)"
                }
            ]
        }
    ]
}
azure.purview.catalog.rest.discovery.build_auto_complete_request(*, json: Any = None, content: Any = None, **kwargs: Any) → azure.purview.catalog.core.rest._rest_py3.HttpRequest[source]

Get auto complete options.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Keyword Arguments
  • json (Any) – An object specifying the autocomplete criteria.

  • content (Any) – An object specifying the autocomplete criteria.

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# JSON input template you can fill out and use as your `json` input.
json = {
    "filter": "object (optional)",
    "keywords": "str (optional)",
    "limit": "int (optional)"
}


# response body for status code(s): 200
response_body == {
    "value": [
        {
            "queryPlusText": "str (optional)",
            "text": "str (optional)"
        }
    ]
}