- 1.53.0 (latest)
- 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 SearchCatalogRequestOrBuilder
Request 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()
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SearchCatalogRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
SearchCatalogRequest.Builder |
build()
public SearchCatalogRequest build()
Type | Description |
SearchCatalogRequest |
buildPartial()
public SearchCatalogRequest buildPartial()
Type | Description |
SearchCatalogRequest |
clear()
public SearchCatalogRequest.Builder clear()
Type | Description |
SearchCatalogRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public SearchCatalogRequest.Builder clearField(Descriptors.FieldDescriptor field)
Name | Description |
field | FieldDescriptor |
Type | Description |
SearchCatalogRequest.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public SearchCatalogRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Name | Description |
oneof | OneofDescriptor |
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 torelevance
descending.
string order_by = 5;
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;
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];
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];
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];
Type | Description |
SearchCatalogRequest.Builder |
clone()
public SearchCatalogRequest.Builder clone()
Type | Description |
SearchCatalogRequest.Builder |
getDefaultInstanceForType()
public SearchCatalogRequest getDefaultInstanceForType()
Type | Description |
SearchCatalogRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
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 torelevance
descending.
string order_by = 5;
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 torelevance
descending.
string order_by = 5;
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;
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];
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];
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];
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];
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];
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];
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];
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];
Type | Description |
boolean | Whether the scope field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Type | Description |
boolean |
mergeFrom(SearchCatalogRequest other)
public SearchCatalogRequest.Builder mergeFrom(SearchCatalogRequest other)
Name | Description |
other | SearchCatalogRequest |
Type | Description |
SearchCatalogRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SearchCatalogRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
SearchCatalogRequest.Builder |
Type | Description |
IOException |
mergeFrom(Message other)
public SearchCatalogRequest.Builder mergeFrom(Message other)
Name | Description |
other | Message |
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];
Name | Description |
value | SearchCatalogRequest.Scope |
Type | Description |
SearchCatalogRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SearchCatalogRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
SearchCatalogRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public SearchCatalogRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
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 torelevance
descending.
string order_by = 5;
Name | Description |
value | String The orderBy to set. |
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 torelevance
descending.
string order_by = 5;
Name | Description |
value | ByteString The bytes for orderBy to set. |
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;
Name | Description |
value | int The pageSize to set. |
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];
Name | Description |
value | String The pageToken to set. |
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];
Name | Description |
value | ByteString The bytes for pageToken to set. |
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];
Name | Description |
value | String The query to set. |
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];
Name | Description |
value | ByteString The bytes for query to set. |
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)
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
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];
Name | Description |
value | SearchCatalogRequest.Scope |
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];
Name | Description |
builderForValue | SearchCatalogRequest.Scope.Builder |
Type | Description |
SearchCatalogRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final SearchCatalogRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
SearchCatalogRequest.Builder |