dataplex-search-entries

About

A dataplex-search-entries tool returns all entries in Dataplex Catalog (e.g. tables, views, models) that matches given user query. It’s compatible with the following sources:

• dataplex

dataplex-search-entries takes a required query parameter based on which entries are filtered and returned to the user and a required name parameter which is constructed using source’s project if user does not provide it explicitly and has the following format: projects/{project}/locations/global. It also optionally accepts following parameters:

• pageSize - Number of results in the search page. Defaults to 5.
• pageToken - Page token received from a previous locations.searchEntries call.
• orderBy - Specifies the ordering of results. Supported values are: relevance (default), last_modified_timestamp, last_modified_timestamp asc
• semanticSearch - Specifies whether the search should understand the meaning and intent behind the query, rather than just matching keywords. Defaults to true.
• scope - The scope under which the search should be operating. Since this parameter is not exposed to the toolbox user, it defaults to the organization where the project provided in name is located.

Requirements

IAM Permissions

Dataplex uses Identity and Access Management (IAM) to control user and group access to Dataplex resources. Toolbox will use your Application Default Credentials (ADC) to authorize and authenticate when interacting with [Dataplex][dataplex-docs].

In addition to setting the ADC for your server, you need to ensure the IAM identity has been given the correct IAM permissions for the tasks you intend to perform. See Dataplex Universal Catalog IAM permissions and Dataplex Universal Catalog IAM roles for more information on applying IAM permissions and roles to an identity.

Example

tools:
  dataplex-search-entries:
    kind: dataplex-search-entries
    source: my-dataplex-source
    description: Use this tool to get all the entries based on the provided query.

Reference