Class SearchCatalogRequest (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 ordering of results, currently supported case-sensitive choices are:

relevance, only supports descending
last_modified_timestamp [asc|desc], defaults to descending if not specified

If not specified, defaults to relevance descending.

Property Value
Type	Description
`String`

PageSize

public int PageSize { get; set; }

Number of results in the search page. If <=0 then defaults to 10. Max limit for page_size is 1000. Throws an invalid argument for page_size > 1000.

Property Value
Type	Description
`Int32`

PageToken

public string PageToken { get; set; }

Optional. Pagination token returned in an earlier [SearchCatalogResponse.next_page_token][google.cloud.datacatalog.v1.SearchCatalogResponse.next_page_token], which indicates that this is a continuation of a prior [SearchCatalogRequest][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog] call, and that the system should return the next page of data. If empty, the first page is returned.

Property Value
Type	Description
`String`

Query

public string Query { get; set; }

Optional. The query string in search query syntax. An empty query string will result in all data assets (in the specified scope) that the user has access to.

Query strings can be simple as "x" or more qualified as:

name:x
column:x
description:y

Note: Query tokens need to have a minimum of 3 characters for substring matching to work correctly. See Data Catalog Search Syntax for more information.

Property Value
Type	Description
`String`

Scope

public SearchCatalogRequest.Types.Scope Scope { get; set; }

Required. The scope of this search request. A scope that has empty include_org_ids, include_project_ids AND false include_gcp_public_datasets is considered invalid. Data Catalog will return an error in such a case.

Property Value
Type	Description
`SearchCatalogRequest.Types.Scope`