Interface SearchCatalogRequestOrBuilder 

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
 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
 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][google.cloud.datacatalog.v1beta1.SearchCatalogResponse.next_page_token], which
 indicates that this is a continuation of a prior
 [SearchCatalogRequest][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog]
 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][google.cloud.datacatalog.v1beta1.SearchCatalogResponse.next_page_token], which
 indicates that this is a continuation of a prior
 [SearchCatalogRequest][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog]
 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()
 
Required. The query string in search query syntax. The query must be non-empty.
 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](https://cloud.google.com/data-catalog/docs/how-to/search-reference)
 for more information.

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

Returns
Type Description
String

The query.

getQueryBytes()

public abstract ByteString getQueryBytes()
 
Required. The query string in search query syntax. The query must be non-empty.
 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](https://cloud.google.com/data-catalog/docs/how-to/search-reference)
 for more information.

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

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.