Interface SearchCatalogRequestOrBuilder

Version 1.5.4

• 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 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`.

string order_by = 5;

Returns

Type	Description
String	The orderBy.

getOrderByBytes()

public abstract ByteString getOrderByBytes()

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`.

string order_by = 5;

Returns

Type	Description
ByteString	The bytes for orderBy.

getPageSize()

public abstract int getPageSize()

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.

int32 page_size = 2;

Returns

Type	Description
int	The pageSize.

getPageToken()

public abstract String getPageToken()

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.

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

Returns

Type	Description
String	The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

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.

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 with a minimum of 3 characters and specific syntax.
 For more information, see
 [Data Catalog search syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference).
 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`

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

Returns

Type	Description
String	The query.

getQueryBytes()

public abstract ByteString getQueryBytes()

Optional. The query string with a minimum of 3 characters and specific syntax.
 For more information, see
 [Data Catalog search syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference).
 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`

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.
 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.

.google.cloud.datacatalog.v1.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.
 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.

.google.cloud.datacatalog.v1.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.
 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.

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

Returns

Type	Description
boolean	Whether the scope field is set.