SearchCatalogRequestOrBuilder (proto-google-cloud-datacatalog-v1beta1 0.110.0 API)

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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`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 * `default` that can only be descending If not specified, defaults to `relevance` descending.
`com.google.protobuf.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 * `default` that can only be descending If not specified, defaults to `relevance` descending.
`int`	`getPageSize()` Number of results in the search page.
`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. 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:: Whether the scope field is set.

getScope

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:: The scope.

getScopeOrBuilder

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

getQuery

String getQuery()

 Optional. The query string in search query syntax. An empty query string
 will result in all data assets (in the specified scope) that the user has
 access to. 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) = OPTIONAL];

Returns:: The query.

getQueryBytes

com.google.protobuf.ByteString getQueryBytes()

 Optional. The query string in search query syntax. An empty query string
 will result in all data assets (in the specified scope) that the user has
 access to. 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) = OPTIONAL];

Returns:: The bytes for query.

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;

Returns:: The pageSize.

getPageToken

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:: The pageToken.

getPageTokenBytes

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