public static final class SearchCatalogRequest.Builder extends GeneratedMessageV3.Builder<SearchCatalogRequest.Builder> implements SearchCatalogRequestOrBuilder
Request message for
[SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].
Protobuf type google.cloud.datacatalog.v1.SearchCatalogRequest
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SearchCatalogRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
public SearchCatalogRequest build()
Returns
buildPartial()
public SearchCatalogRequest buildPartial()
Returns
clear()
public SearchCatalogRequest.Builder clear()
Returns
Overrides
clearField(Descriptors.FieldDescriptor field)
public SearchCatalogRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public SearchCatalogRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
clearOrderBy()
public SearchCatalogRequest.Builder clearOrderBy()
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
If this parameter is omitted, it defaults to the descending `relevance`.
string order_by = 5;
clearPageSize()
public SearchCatalogRequest.Builder clearPageSize()
Number of results to return in a single search page.
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;
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][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];
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](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];
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];
clone()
public SearchCatalogRequest.Builder clone()
Returns
Overrides
getDefaultInstanceForType()
public SearchCatalogRequest getDefaultInstanceForType()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
getOrderBy()
public 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
If this parameter is omitted, it defaults to the descending `relevance`.
string order_by = 5;
| Type | Description |
| String | The orderBy.
|
getOrderByBytes()
public 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
If this parameter is omitted, it defaults to the descending `relevance`.
string order_by = 5;
getPageSize()
Number of results to return in a single search page.
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;
| 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][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];
| 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][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];
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];
| 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](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];
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];
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];
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];
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];
| Type | Description |
| boolean | Whether the scope field is set.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(SearchCatalogRequest other)
public SearchCatalogRequest.Builder mergeFrom(SearchCatalogRequest other)
Parameter
Returns
public SearchCatalogRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public SearchCatalogRequest.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
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];
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SearchCatalogRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public SearchCatalogRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
setOrderBy(String value)
public SearchCatalogRequest.Builder setOrderBy(String value)
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
If this parameter is omitted, it defaults to the descending `relevance`.
string order_by = 5;
| Name | Description |
| value | String
The orderBy to set.
|
Returns
setOrderByBytes(ByteString value)
public SearchCatalogRequest.Builder setOrderByBytes(ByteString value)
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
If this parameter is omitted, it defaults to the descending `relevance`.
string order_by = 5;
| Name | Description |
| value | ByteString
The bytes for orderBy to set.
|
Returns
setPageSize(int value)
public SearchCatalogRequest.Builder setPageSize(int value)
Number of results to return in a single search page.
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;
| Name | Description |
| value | int
The pageSize to set.
|
Returns
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][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];
| Name | Description |
| value | String
The pageToken to set.
|
Returns
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][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];
| Name | Description |
| value | ByteString
The bytes for pageToken to set.
|
Returns
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](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];
| Name | Description |
| value | String
The query to set.
|
Returns
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](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];
| Name | Description |
| value | ByteString
The bytes for query to set.
|
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SearchCatalogRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
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];
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];
setUnknownFields(UnknownFieldSet unknownFields)
public final SearchCatalogRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
