public interface SearchCatalogRequestOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
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;
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;
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;
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];
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];
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];
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];
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];
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];
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];
Type | Description |
boolean | Whether the scope field is set. |