Class GoogleCloudDatacatalogV1SearchCatalogRequest
Request message for SearchCatalog.
Implements
Inherited Members
Namespace: Google.Apis.DataCatalog.v1.Data
Assembly: Google.Apis.DataCatalog.v1.dll
Syntax
public class GoogleCloudDatacatalogV1SearchCatalogRequest : IDirectResponseSchema
Properties
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
OrderBy
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 * default
that
can only be descending If this parameter is omitted, it defaults to the descending relevance
.
Declaration
[JsonProperty("orderBy")]
public virtual string OrderBy { get; set; }
Property Value
Type | Description |
---|---|
string |
PageSize
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.
Declaration
[JsonProperty("pageSize")]
public virtual int? PageSize { get; set; }
Property Value
Type | Description |
---|---|
int? |
PageToken
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 field of the response to a previous SearchCatalogRequest call.
Declaration
[JsonProperty("pageToken")]
public virtual string PageToken { get; set; }
Property Value
Type | Description |
---|---|
string |
Query
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
Declaration
[JsonProperty("query")]
public virtual string Query { get; set; }
Property Value
Type | Description |
---|---|
string |
Scope
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.
Declaration
[JsonProperty("scope")]
public virtual GoogleCloudDatacatalogV1SearchCatalogRequestScope Scope { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudDatacatalogV1SearchCatalogRequestScope |