Class SearchCatalogRequest (1.3.0)

Version 1.3.0

• 2.13.0 (latest)
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0

public sealed class SearchCatalogRequest : IMessage<SearchCatalogRequest>, IEquatable<SearchCatalogRequest>, IDeepCloneable<SearchCatalogRequest>, IBufferMessage, IMessage, IPageRequest

Request message for [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].

Inheritance

Object > SearchCatalogRequest

Implements

IMessage<SearchCatalogRequest>, IEquatable<SearchCatalogRequest>, IDeepCloneable<SearchCatalogRequest>, IBufferMessage, IMessage, IPageRequest

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.DataCatalog.V1

Assembly

Google.Cloud.DataCatalog.V1.dll

Constructors

SearchCatalogRequest()

public SearchCatalogRequest()

SearchCatalogRequest(SearchCatalogRequest)

public SearchCatalogRequest(SearchCatalogRequest other)

Parameter
Name	Description
other	SearchCatalogRequest

Properties

OrderBy

public string OrderBy { get; set; }

Specifies the order of results.

Currently supported case-sensitive values are:

• relevance that can only be descending
• last_modified_timestamp [asc|desc] with descending (desc) as default

If this parameter is omitted, it defaults to the descending relevance.

Property Value
Type	Description
String

PageSize

public int PageSize { get; set; }

Number of results to return in a single search page.

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
Int32

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
SearchCatalogRequest.Types.Scope