com.google.cloud.datacatalog

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
String	getOrderBy() Specifies the ordering of results, currently supported case-sensitive choices are: <ul> <li> relevance </li> <li> last_access_timestamp [asc|desc], defaults to descending if not specified, </li> <li> last_modified_timestamp [asc|desc], defaults to descending if not specified.
com.google.protobuf.ByteString	getOrderByBytes() Specifies the ordering of results, currently supported case-sensitive choices are: <ul> <li> relevance </li> <li> last_access_timestamp [asc|desc], defaults to descending if not specified, </li> <li> last_modified_timestamp [asc|desc], defaults to descending if not specified.
int	getPageSize() Number of results in the search page.
String	getPageToken() Optional pagination token returned in an earlier [SearchCatalogResponse.next_page_token][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalogResponse.next_page_token]; indicates that this is a continuation of a prior [SearchCatalog][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog] call, and that the system should return the next page of data.
com.google.protobuf.ByteString	getPageTokenBytes() Optional pagination token returned in an earlier [SearchCatalogResponse.next_page_token][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalogResponse.next_page_token]; indicates that this is a continuation of a prior [SearchCatalog][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog] call, and that the system should return the next page of data.
String	getQuery() Required.
com.google.protobuf.ByteString	getQueryBytes() Required.
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.
 

.google.cloud.datacatalog.v1beta1.SearchCatalogRequest.Scope scope = 6;

getScope

SearchCatalogRequest.Scope getScope()

 Required. The scope of this search request.
 

.google.cloud.datacatalog.v1beta1.SearchCatalogRequest.Scope scope = 6;

getScopeOrBuilder

SearchCatalogRequest.ScopeOrBuilder getScopeOrBuilder()

 Required. The scope of this search request.
 

.google.cloud.datacatalog.v1beta1.SearchCatalogRequest.Scope scope = 6;

getQuery

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](/data-catalog/docs/how-to/search-reference) for more information.
 

string query = 1;

getQueryBytes

com.google.protobuf.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](/data-catalog/docs/how-to/search-reference) for more information.
 

string query = 1;

getPageSize

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;

getPageToken

String getPageToken()

 Optional pagination token returned in an earlier
 [SearchCatalogResponse.next_page_token][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalogResponse.next_page_token];
 indicates that this is a continuation of a prior
 [SearchCatalog][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog]
 call, and that the system should return the next page of data. If empty
 then the first page is returned.
 

string page_token = 3;

getPageTokenBytes

com.google.protobuf.ByteString getPageTokenBytes()

 Optional pagination token returned in an earlier
 [SearchCatalogResponse.next_page_token][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalogResponse.next_page_token];
 indicates that this is a continuation of a prior
 [SearchCatalog][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog]
 call, and that the system should return the next page of data. If empty
 then the first page is returned.
 

string page_token = 3;

getOrderBy

String getOrderBy()

 Specifies the ordering of results, currently supported case-sensitive
 choices are:
 <ul>
   <li> relevance </li>
   <li> last_access_timestamp [asc|desc], defaults to descending if not
   specified, </li>
   <li> last_modified_timestamp [asc|desc], defaults to descending if not
   specified. </li>
 </ul>
 

string order_by = 5;

getOrderByBytes

com.google.protobuf.ByteString getOrderByBytes()

 Specifies the ordering of results, currently supported case-sensitive
 choices are:
 <ul>
   <li> relevance </li>
   <li> last_access_timestamp [asc|desc], defaults to descending if not
   specified, </li>
   <li> last_modified_timestamp [asc|desc], defaults to descending if not
   specified. </li>
 </ul>
 

string order_by = 5;