com.google.cloud.datacatalog.v1

Interface SearchCatalogRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

SearchCatalogRequest, SearchCatalogRequest.Builder

public interface SearchCatalogRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	getAdminSearch() Optional.
String	getOrderBy() Specifies the order of results.
com.google.protobuf.ByteString	getOrderByBytes() Specifies the order of results.
int	getPageSize() Upper bound on the number of results you can get in a single response.
String	getPageToken() Optional.
com.google.protobuf.ByteString	getPageTokenBytes() Optional.
String	getQuery() Optional.
com.google.protobuf.ByteString	getQueryBytes() Optional.
SearchCatalogRequest.Scope	getScope() Required.
SearchCatalogRequest.ScopeOrBuilder	getScopeOrBuilder() Required.
boolean	hasScope() Required.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasScope

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:

Whether the scope field is set.

getScope

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:

The scope.

getScopeOrBuilder

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];

getQuery

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:

The query.

getQueryBytes

com.google.protobuf.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:

The bytes for query.

getPageSize

int getPageSize()

 Upper bound on the number of results you can get in a single response.

 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:

The pageSize.

getPageToken

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:

The pageToken.

getPageTokenBytes

com.google.protobuf.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:

The bytes for pageToken.

getOrderBy

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
 * `default` that can only be descending

 Search queries don't guarantee full recall. Results that match your query
 might not be returned, even in subsequent result pages. Additionally,
 returned (and not returned) results can vary if you repeat search queries.
 If you are experiencing recall issues and you don't have to fetch the
 results in any specific order, consider setting this parameter to
 `default`.

 If this parameter is omitted, it defaults to the descending `relevance`.
 

string order_by = 5;

Returns:

The orderBy.

getOrderByBytes

com.google.protobuf.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
 * `default` that can only be descending

 Search queries don't guarantee full recall. Results that match your query
 might not be returned, even in subsequent result pages. Additionally,
 returned (and not returned) results can vary if you repeat search queries.
 If you are experiencing recall issues and you don't have to fetch the
 results in any specific order, consider setting this parameter to
 `default`.

 If this parameter is omitted, it defaults to the descending `relevance`.
 

string order_by = 5;

Returns:

The bytes for orderBy.

getAdminSearch

boolean getAdminSearch()

 Optional. If set, use searchAll permission granted on organizations from
 `include_org_ids` and projects from `include_project_ids` instead of the
 fine grained per resource permissions when filtering the search results.
 The only allowed `order_by` criteria for admin_search mode is `default`.
 Using this flags guarantees a full recall of the search results.
 

bool admin_search = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The adminSearch.