public static final class SearchCatalogRequest.Builder extends GeneratedMessageV3.Builder<SearchCatalogRequest.Builder> implements SearchCatalogRequestOrBuilderRequest message for SearchCatalog.
Protobuf type google.cloud.datacatalog.v1beta1.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 |
|
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 ordering of results, currently supported case-sensitive choices are:
relevance, only supports descendinglast_modified_timestamp [asc|desc], defaults to descending if not specified If not specified, defaults torelevancedescending.
string order_by = 5;
| Returns | |
|---|---|
| Type | Description |
SearchCatalogRequest.Builder |
This builder for chaining. |
clearPageSize()
public SearchCatalogRequest.Builder clearPageSize()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 | |
|---|---|
| Type | Description |
SearchCatalogRequest.Builder |
This builder for chaining. |
clearPageToken()
public SearchCatalogRequest.Builder clearPageToken()Optional. Pagination token returned in an earlier SearchCatalogResponse.next_page_token, which indicates that this is a continuation of a prior SearchCatalogRequest 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 | |
|---|---|
| Type | Description |
SearchCatalogRequest.Builder |
This builder for chaining. |
clearQuery()
public SearchCatalogRequest.Builder clearQuery()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 for more information.
string query = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
SearchCatalogRequest.Builder |
This builder for chaining. |
clearScope()
public SearchCatalogRequest.Builder clearScope() 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 | |
|---|---|
| Type | Description |
SearchCatalogRequest.Builder |
|
clone()
public SearchCatalogRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
SearchCatalogRequest.Builder |
|
getDefaultInstanceForType()
public SearchCatalogRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
SearchCatalogRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getOrderBy()
public String getOrderBy()Specifies the ordering of results, currently supported case-sensitive choices are:
relevance, only supports descendinglast_modified_timestamp [asc|desc], defaults to descending if not specified If not specified, defaults torelevancedescending.
string order_by = 5;
| Returns | |
|---|---|
| Type | Description |
String |
The orderBy. |
getOrderByBytes()
public ByteString getOrderByBytes()Specifies the ordering of results, currently supported case-sensitive choices are:
relevance, only supports descendinglast_modified_timestamp [asc|desc], defaults to descending if not specified If not specified, defaults torelevancedescending.
string order_by = 5;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for orderBy. |
getPageSize()
public 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 | |
|---|---|
| Type | Description |
int |
The pageSize. |
getPageToken()
public String getPageToken()Optional. Pagination token returned in an earlier SearchCatalogResponse.next_page_token, which indicates that this is a continuation of a prior SearchCatalogRequest 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 | |
|---|---|
| Type | Description |
String |
The pageToken. |
getPageTokenBytes()
public ByteString getPageTokenBytes()Optional. Pagination token returned in an earlier SearchCatalogResponse.next_page_token, which indicates that this is a continuation of a prior SearchCatalogRequest 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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for pageToken. |
getQuery()
public 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 for more information.
string query = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The query. |
getQueryBytes()
public 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 for more information.
string query = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for query. |
getScope()
public 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 | |
|---|---|
| Type | Description |
SearchCatalogRequest.Scope |
The scope. |
getScopeBuilder()
public SearchCatalogRequest.Scope.Builder getScopeBuilder() 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 | |
|---|---|
| Type | Description |
SearchCatalogRequest.Scope.Builder |
|
getScopeOrBuilder()
public 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];
| Returns | |
|---|---|
| Type | Description |
SearchCatalogRequest.ScopeOrBuilder |
|
hasScope()
public 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 | |
|---|---|
| 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. 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];
| 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 |
|
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 ordering of results, currently supported case-sensitive choices are:
relevance, only supports descendinglast_modified_timestamp [asc|desc], defaults to descending if not specified If not specified, defaults torelevancedescending.
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 ordering of results, currently supported case-sensitive choices are:
relevance, only supports descendinglast_modified_timestamp [asc|desc], defaults to descending if not specified If not specified, defaults torelevancedescending.
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)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;
| 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 returned in an earlier SearchCatalogResponse.next_page_token, which indicates that this is a continuation of a prior SearchCatalogRequest 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];
| 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 returned in an earlier SearchCatalogResponse.next_page_token, which indicates that this is a continuation of a prior SearchCatalogRequest 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];
| 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)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 for more information.
string query = 1 [(.google.api.field_behavior) = REQUIRED];
| 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)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 for more information.
string query = 1 [(.google.api.field_behavior) = REQUIRED];
| 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. 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];
| 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. 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];
| 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 |
|