- 1.59.0 (latest)
- 1.58.0
- 1.57.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.36.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.5
- 1.8.4
- 1.7.2
- 1.6.2
- 1.5.4
public static final class SearchCatalogRequest.Builder extends GeneratedMessageV3.Builder<SearchCatalogRequest.Builder> implements SearchCatalogRequestOrBuilderRequest message for SearchCatalog.
Protobuf type google.cloud.datacatalog.v1.SearchCatalogRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchCatalogRequest.BuilderImplements
SearchCatalogRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SearchCatalogRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SearchCatalogRequest.Builder |
|
build()
public SearchCatalogRequest build()| Returns | |
|---|---|
| Type | Description |
SearchCatalogRequest |
|
buildPartial()
public SearchCatalogRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
SearchCatalogRequest |
|
clear()
public SearchCatalogRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
SearchCatalogRequest.Builder |
|
clearAdminSearch()
public SearchCatalogRequest.Builder clearAdminSearch() 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 | |
|---|---|
| Type | Description |
SearchCatalogRequest.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public SearchCatalogRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
SearchCatalogRequest.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public SearchCatalogRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
SearchCatalogRequest.Builder |
|
clearOrderBy()
public SearchCatalogRequest.Builder clearOrderBy()Specifies the order of results.
Currently supported case-sensitive values are:
relevancethat can only be descendinglast_modified_timestamp [asc|desc]with descending (desc) as defaultdefaultthat can only be descendingSearch 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 | |
|---|---|
| Type | Description |
SearchCatalogRequest.Builder |
This builder for chaining. |
clearPageSize()
public SearchCatalogRequest.Builder clearPageSize()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 | |
|---|---|
| Type | Description |
SearchCatalogRequest.Builder |
This builder for chaining. |
clearPageToken()
public SearchCatalogRequest.Builder clearPageToken()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 field of the response to a previous SearchCatalogRequest call.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SearchCatalogRequest.Builder |
This builder for chaining. |
clearQuery()
public SearchCatalogRequest.Builder clearQuery()Optional. The query string with a minimum of 3 characters and specific syntax. For more information, see Data Catalog search syntax.
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:xcolumn:ydescription:z
string query = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SearchCatalogRequest.Builder |
This builder for chaining. |
clearScope()
public SearchCatalogRequest.Builder clearScope()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 | |
|---|---|
| Type | Description |
SearchCatalogRequest.Builder |
|
clone()
public SearchCatalogRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
SearchCatalogRequest.Builder |
|
getAdminSearch()
public 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 | |
|---|---|
| Type | Description |
boolean |
The adminSearch. |
getDefaultInstanceForType()
public SearchCatalogRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
SearchCatalogRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getOrderBy()
public String getOrderBy()Specifies the order of results.
Currently supported case-sensitive values are:
relevancethat can only be descendinglast_modified_timestamp [asc|desc]with descending (desc) as defaultdefaultthat can only be descendingSearch 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 | |
|---|---|
| Type | Description |
String |
The orderBy. |
getOrderByBytes()
public ByteString getOrderByBytes()Specifies the order of results.
Currently supported case-sensitive values are:
relevancethat can only be descendinglast_modified_timestamp [asc|desc]with descending (desc) as defaultdefaultthat can only be descendingSearch 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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for orderBy. |
getPageSize()
public 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 | |
|---|---|
| Type | Description |
int |
The pageSize. |
getPageToken()
public 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 field of the response to a previous SearchCatalogRequest call.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The pageToken. |
getPageTokenBytes()
public 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 field of the response to a previous SearchCatalogRequest call.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for pageToken. |
getQuery()
public String getQuery()Optional. The query string with a minimum of 3 characters and specific syntax. For more information, see Data Catalog search syntax.
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:xcolumn:ydescription:z
string query = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The query. |
getQueryBytes()
public ByteString getQueryBytes()Optional. The query string with a minimum of 3 characters and specific syntax. For more information, see Data Catalog search syntax.
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:xcolumn:ydescription:z
string query = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for query. |
getScope()
public 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 | |
|---|---|
| Type | Description |
SearchCatalogRequest.Scope |
The scope. |
getScopeBuilder()
public SearchCatalogRequest.Scope.Builder getScopeBuilder()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 | |
|---|---|
| Type | Description |
SearchCatalogRequest.Scope.Builder |
|
getScopeOrBuilder()
public 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];
| Returns | |
|---|---|
| Type | Description |
SearchCatalogRequest.ScopeOrBuilder |
|
hasScope()
public 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 | |
|---|---|
| Type | Description |
boolean |
Whether the scope field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(SearchCatalogRequest other)
public SearchCatalogRequest.Builder mergeFrom(SearchCatalogRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
SearchCatalogRequest |
| Returns | |
|---|---|
| Type | Description |
SearchCatalogRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SearchCatalogRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SearchCatalogRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public SearchCatalogRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
SearchCatalogRequest.Builder |
|
mergeScope(SearchCatalogRequest.Scope value)
public SearchCatalogRequest.Builder mergeScope(SearchCatalogRequest.Scope value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
SearchCatalogRequest.Scope |
| Returns | |
|---|---|
| Type | Description |
SearchCatalogRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SearchCatalogRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
SearchCatalogRequest.Builder |
|
setAdminSearch(boolean value)
public SearchCatalogRequest.Builder setAdminSearch(boolean value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe adminSearch to set. |
| Returns | |
|---|---|
| Type | Description |
SearchCatalogRequest.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public SearchCatalogRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SearchCatalogRequest.Builder |
|
setOrderBy(String value)
public SearchCatalogRequest.Builder setOrderBy(String value)Specifies the order of results.
Currently supported case-sensitive values are:
relevancethat can only be descendinglast_modified_timestamp [asc|desc]with descending (desc) as defaultdefaultthat can only be descendingSearch 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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe orderBy to set. |
| Returns | |
|---|---|
| Type | Description |
SearchCatalogRequest.Builder |
This builder for chaining. |
setOrderByBytes(ByteString value)
public SearchCatalogRequest.Builder setOrderByBytes(ByteString value)Specifies the order of results.
Currently supported case-sensitive values are:
relevancethat can only be descendinglast_modified_timestamp [asc|desc]with descending (desc) as defaultdefaultthat can only be descendingSearch 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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for orderBy to set. |
| Returns | |
|---|---|
| Type | Description |
SearchCatalogRequest.Builder |
This builder for chaining. |
setPageSize(int value)
public SearchCatalogRequest.Builder setPageSize(int value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe pageSize to set. |
| Returns | |
|---|---|
| Type | Description |
SearchCatalogRequest.Builder |
This builder for chaining. |
setPageToken(String value)
public SearchCatalogRequest.Builder setPageToken(String value)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 field of the response to a previous SearchCatalogRequest call.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
SearchCatalogRequest.Builder |
This builder for chaining. |
setPageTokenBytes(ByteString value)
public SearchCatalogRequest.Builder setPageTokenBytes(ByteString value)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 field of the response to a previous SearchCatalogRequest call.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
SearchCatalogRequest.Builder |
This builder for chaining. |
setQuery(String value)
public SearchCatalogRequest.Builder setQuery(String value)Optional. The query string with a minimum of 3 characters and specific syntax. For more information, see Data Catalog search syntax.
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:xcolumn:ydescription:z
string query = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe query to set. |
| Returns | |
|---|---|
| Type | Description |
SearchCatalogRequest.Builder |
This builder for chaining. |
setQueryBytes(ByteString value)
public SearchCatalogRequest.Builder setQueryBytes(ByteString value)Optional. The query string with a minimum of 3 characters and specific syntax. For more information, see Data Catalog search syntax.
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:xcolumn:ydescription:z
string query = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for query to set. |
| Returns | |
|---|---|
| Type | Description |
SearchCatalogRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SearchCatalogRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SearchCatalogRequest.Builder |
|
setScope(SearchCatalogRequest.Scope value)
public SearchCatalogRequest.Builder setScope(SearchCatalogRequest.Scope value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
SearchCatalogRequest.Scope |
| Returns | |
|---|---|
| Type | Description |
SearchCatalogRequest.Builder |
|
setScope(SearchCatalogRequest.Scope.Builder builderForValue)
public SearchCatalogRequest.Builder setScope(SearchCatalogRequest.Scope.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
SearchCatalogRequest.Scope.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchCatalogRequest.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final SearchCatalogRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
SearchCatalogRequest.Builder |
|