Class SearchCatalogRequest (1.24.0)
1.94.0 (latest)
1.93.0
1.91.0
1.89.0
1.88.0
1.87.0
1.86.0
1.84.0
1.82.0
1.81.0
1.80.0
1.79.0
1.78.0
1.76.0
1.74.0
1.73.0
1.70.0
1.69.0
1.68.0
1.66.0
1.65.0
1.64.0
1.63.0
1.62.0
1.61.0
1.60.0
1.59.0
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 final class SearchCatalogRequest extends GeneratedMessageV3 implements SearchCatalogRequestOrBuilder
Request message for
SearchCatalog .
Protobuf type google.cloud.datacatalog.v1beta1.SearchCatalogRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
ORDER_BY_FIELD_NUMBER
public static final int ORDER_BY_FIELD_NUMBER
Field Value
Type Description
int
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int
QUERY_FIELD_NUMBER
public static final int QUERY_FIELD_NUMBER
Field Value
Type Description
int
SCOPE_FIELD_NUMBER
public static final int SCOPE_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static SearchCatalogRequest getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static SearchCatalogRequest . Builder newBuilder ()
newBuilder(SearchCatalogRequest prototype)
public static SearchCatalogRequest . Builder newBuilder ( SearchCatalogRequest prototype )
public static SearchCatalogRequest parseDelimitedFrom ( InputStream input )
public static SearchCatalogRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static SearchCatalogRequest parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchCatalogRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static SearchCatalogRequest parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchCatalogRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static SearchCatalogRequest parseFrom ( CodedInputStream input )
public static SearchCatalogRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static SearchCatalogRequest parseFrom ( InputStream input )
public static SearchCatalogRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static SearchCatalogRequest parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchCatalogRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<SearchCatalogRequest> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public SearchCatalogRequest getDefaultInstanceForType ()
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 to relevance descending.
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 to relevance descending.
string order_by = 5;
Returns
Type Description
ByteString The bytes for orderBy.
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.
getParserForType()
public Parser<SearchCatalogRequest> getParserForType ()
Overrides
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];
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];
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Overrides
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.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public SearchCatalogRequest . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchCatalogRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public SearchCatalogRequest . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-03-31 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-03-31 UTC."],[],[]]
