Send feedback
Class SearchCatalogRequest (1.21.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 1.21.0 keyboard_arrow_down
public final class SearchCatalogRequest extends GeneratedMessageV3 implements SearchCatalogRequestOrBuilder
Request message for
SearchCatalog .
Protobuf type google.cloud.datacatalog.v1beta1.SearchCatalogRequest
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 data
byte []
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 obj
Object
Overrides
getDefaultInstanceForType()
public SearchCatalogRequest getDefaultInstanceForType ()
getOrderBy()
public String getOrderBy ()
Specifies the ordering of results, currently supported case-sensitive
choices are:
relevance
, only supports descending
last_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 descending
last_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 )
Overrides
toBuilder()
public SearchCatalogRequest . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
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 2024-09-19 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
Need to tell us more?
{"lastModified": "Last updated 2024-09-19 UTC."}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-19 UTC."]]