public sealed class SearchCatalogRequest : IMessage<SearchCatalogRequest>, IEquatable<SearchCatalogRequest>, IDeepCloneable<SearchCatalogRequest>, IBufferMessage, IMessage, IPageRequest
Reference documentation and code samples for the Data Catalog v1 API class SearchCatalogRequest.
Request message for [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].
Implements
IMessageSearchCatalogRequest, IEquatableSearchCatalogRequest, IDeepCloneableSearchCatalogRequest, IBufferMessage, IMessage, IPageRequestNamespace
Google.Cloud.DataCatalog.V1Assembly
Google.Cloud.DataCatalog.V1.dll
Constructors
SearchCatalogRequest()
public SearchCatalogRequest()
SearchCatalogRequest(SearchCatalogRequest)
public SearchCatalogRequest(SearchCatalogRequest other)
Parameter | |
---|---|
Name | Description |
other | SearchCatalogRequest |
Properties
AdminSearch
public bool AdminSearch { get; set; }
Optional. If set, use searchAll permission granted on organizations from
include_org_ids
and projects from include_project_ids
instead of the
fine grained per resource permissions when filtering the search results.
The only allowed order_by
criteria for admin_search mode is default
.
Using this flags guarantees a full recall of the search results.
Property Value | |
---|---|
Type | Description |
bool |
OrderBy
public string OrderBy { get; set; }
Specifies the order of results.
Currently supported case-sensitive values are:
relevance
that can only be descendinglast_modified_timestamp [asc|desc]
with descending (desc
) as defaultdefault
that can only be descending
Search queries don't guarantee full recall. Results that match your query
might not be returned, even in subsequent result pages. Additionally,
returned (and not returned) results can vary if you repeat search queries.
If you are experiencing recall issues and you don't have to fetch the
results in any specific order, consider setting this parameter to
default
.
If this parameter is omitted, it defaults to the descending relevance
.
Property Value | |
---|---|
Type | Description |
string |
PageSize
public int PageSize { get; set; }
Upper bound on the number of results you can get in a single response.
Can't be negative or 0, defaults to 10 in this case. The maximum number is 1000. If exceeded, throws an "invalid argument" exception.
Property Value | |
---|---|
Type | Description |
int |
PageToken
public string PageToken { get; set; }
Optional. Pagination token that, if specified, returns the next page of search results. If empty, returns the first page.
This token is returned in the [SearchCatalogResponse.next_page_token][google.cloud.datacatalog.v1.SearchCatalogResponse.next_page_token] field of the response to a previous [SearchCatalogRequest][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog] call.
Property Value | |
---|---|
Type | Description |
string |
Query
public string Query { get; set; }
Optional. The query string with a minimum of 3 characters and specific syntax. For more information, see Data Catalog search syntax.
An empty query string returns all data assets (in the specified scope) that you have access to.
A query string can be a simple xyz
or qualified by predicates:
name:x
column:y
description:z
Property Value | |
---|---|
Type | Description |
string |
Scope
public SearchCatalogRequest.Types.Scope Scope { get; set; }
Required. The scope of this search request.
The scope
is invalid if include_org_ids
, include_project_ids
are
empty AND include_gcp_public_datasets
is set to false
. In this case,
the request returns an error.
Property Value | |
---|---|
Type | Description |
SearchCatalogRequestTypesScope |