Class SearchCatalogRequest 

public final class SearchCatalogRequest extends GeneratedMessageV3 implements SearchCatalogRequestOrBuilder
 
Request message for
 [SearchCatalog][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog].

Protobuf type google.cloud.datacatalog.v1beta1.SearchCatalogRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SearchCatalogRequest

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstance()

public static SearchCatalogRequest getDefaultInstance()
Returns
Type Description
SearchCatalogRequest

getDefaultInstanceForType()

public SearchCatalogRequest getDefaultInstanceForType()
Returns
Type Description
SearchCatalogRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

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()

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][google.cloud.datacatalog.v1beta1.SearchCatalogResponse.next_page_token], which
 indicates that this is a continuation of a prior
 [SearchCatalogRequest][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog]
 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][google.cloud.datacatalog.v1beta1.SearchCatalogResponse.next_page_token], which
 indicates that this is a continuation of a prior
 [SearchCatalogRequest][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog]
 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()
Returns
Type Description
Parser<SearchCatalogRequest>
Overrides

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](https://cloud.google.com/data-catalog/docs/how-to/search-reference)
 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](https://cloud.google.com/data-catalog/docs/how-to/search-reference)
 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.

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
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()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilder()

public static SearchCatalogRequest.Builder newBuilder()
Returns
Type Description
SearchCatalogRequest.Builder

newBuilder(SearchCatalogRequest prototype)

public static SearchCatalogRequest.Builder newBuilder(SearchCatalogRequest prototype)
Parameter
Name Description
prototype SearchCatalogRequest
Returns
Type Description
SearchCatalogRequest.Builder

newBuilderForType()

public SearchCatalogRequest.Builder newBuilderForType()
Returns
Type Description
SearchCatalogRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchCatalogRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchCatalogRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

parseDelimitedFrom(InputStream input)

public static SearchCatalogRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchCatalogRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchCatalogRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchCatalogRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SearchCatalogRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SearchCatalogRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchCatalogRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchCatalogRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchCatalogRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchCatalogRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchCatalogRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchCatalogRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchCatalogRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchCatalogRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchCatalogRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchCatalogRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SearchCatalogRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchCatalogRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchCatalogRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchCatalogRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SearchCatalogRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchCatalogRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchCatalogRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchCatalogRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SearchCatalogRequest> parser()
Returns
Type Description
Parser<SearchCatalogRequest>

toBuilder()

public SearchCatalogRequest.Builder toBuilder()
Returns
Type Description
SearchCatalogRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides Exceptions
Type Description
IOException