Interface SearchCatalogRequestOrBuilder (1.47.0)

Version 1.47.0

• 1.59.0 (latest)
• 1.58.0
• 1.57.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.5
• 1.8.4
• 1.7.2
• 1.6.2
• 1.5.4

public interface SearchCatalogRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getOrderBy()

public abstract String getOrderBy()

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

• default that can only be descending

  If not specified, defaults to relevance descending.

string order_by = 5;

Returns
Type	Description
String	The orderBy.

getOrderByBytes()

public abstract ByteString getOrderByBytes()

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

• default that can only be descending

  If not specified, defaults to relevance descending.

string order_by = 5;

Returns
Type	Description
ByteString	The bytes for orderBy.

getPageSize()

public abstract int getPageSize()

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.

int32 page_size = 2;

Returns
Type	Description
int	The pageSize.

getPageToken()

public abstract String getPageToken()

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

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

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

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for pageToken.

getQuery()

public abstract String getQuery()

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.

string query = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The query.

getQueryBytes()

public abstract ByteString getQueryBytes()

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.

string query = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for query.

getScope()

public abstract SearchCatalogRequest.Scope getScope()

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.

.google.cloud.datacatalog.v1beta1.SearchCatalogRequest.Scope scope = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
SearchCatalogRequest.Scope	The scope.

getScopeOrBuilder()

public abstract SearchCatalogRequest.ScopeOrBuilder getScopeOrBuilder()

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.

.google.cloud.datacatalog.v1beta1.SearchCatalogRequest.Scope scope = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
SearchCatalogRequest.ScopeOrBuilder

hasScope()

public abstract boolean hasScope()

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.

.google.cloud.datacatalog.v1beta1.SearchCatalogRequest.Scope scope = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the scope field is set.