public final class SearchCatalogRequest extends GeneratedMessageV3 implements SearchCatalogRequestOrBuilder
Request message for
SearchCatalog.
Protobuf type google.cloud.datacatalog.v1.SearchCatalogRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ADMIN_SEARCH_FIELD_NUMBER
public static final int ADMIN_SEARCH_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
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
getAdminSearch()
public boolean getAdminSearch()
Optional. If set, use searchAll permission granted on organizations from
include_org_ids and projects from include_project_ids instead of the
fine grained per resource permissions when filtering the search results.
The only allowed order_by criteria for admin_search mode is default.
Using this flags guarantees a full recall of the search results.
bool admin_search = 17 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
The adminSearch.
|
getDefaultInstanceForType()
public SearchCatalogRequest getDefaultInstanceForType()
getOrderBy()
public String getOrderBy()
Specifies the order of results.
Currently supported case-sensitive values are:
relevance that can only be descendinglast_modified_timestamp [asc|desc] with descending (desc) as defaultdefault that can only be descending
Search queries don't guarantee full recall. Results that match your query
might not be returned, even in subsequent result pages. Additionally,
returned (and not returned) results can vary if you repeat search queries.
If you are experiencing recall issues and you don't have to fetch the
results in any specific order, consider setting this parameter to
default.
If this parameter is omitted, it defaults to the descending relevance.
string order_by = 5;
| Returns |
| Type |
Description |
String |
The orderBy.
|
getOrderByBytes()
public ByteString getOrderByBytes()
Specifies the order of results.
Currently supported case-sensitive values are:
relevance that can only be descendinglast_modified_timestamp [asc|desc] with descending (desc) as defaultdefault that can only be descending
Search queries don't guarantee full recall. Results that match your query
might not be returned, even in subsequent result pages. Additionally,
returned (and not returned) results can vary if you repeat search queries.
If you are experiencing recall issues and you don't have to fetch the
results in any specific order, consider setting this parameter to
default.
If this parameter is omitted, it defaults to the descending relevance.
string order_by = 5;
| Returns |
| Type |
Description |
ByteString |
The bytes for orderBy.
|
getPageSize()
Upper bound on the number of results you can get in a single response.
Can't be negative or 0, defaults to 10 in this case.
The maximum number is 1000. If exceeded, throws an "invalid argument"
exception.
int32 page_size = 2;
| Returns |
| Type |
Description |
int |
The pageSize.
|
getPageToken()
public String getPageToken()
Optional. Pagination token that, if specified, returns the next page of
search results. If empty, returns the first page.
This token is returned in the
SearchCatalogResponse.next_page_token
field of the response to a previous
SearchCatalogRequest
call.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The pageToken.
|
getPageTokenBytes()
public ByteString getPageTokenBytes()
Optional. Pagination token that, if specified, returns the next page of
search results. If empty, returns the first page.
This token is returned in the
SearchCatalogResponse.next_page_token
field of the response to a previous
SearchCatalogRequest
call.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for pageToken.
|
getParserForType()
public Parser<SearchCatalogRequest> getParserForType()
Overrides
getQuery()
Optional. The query string with a minimum of 3 characters and specific
syntax. For more information, see Data Catalog search
syntax.
An empty query string returns all data assets (in the specified scope)
that you have access to.
A query string can be a simple xyz or qualified by predicates:
name:xcolumn:ydescription:z
string query = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The query.
|
getQueryBytes()
public ByteString getQueryBytes()
Optional. The query string with a minimum of 3 characters and specific
syntax. For more information, see Data Catalog search
syntax.
An empty query string returns all data assets (in the specified scope)
that you have access to.
A query string can be a simple xyz or qualified by predicates:
name:xcolumn:ydescription:z
string query = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for query.
|
getScope()
public SearchCatalogRequest.Scope getScope()
Required. The scope of this search request.
The scope is invalid if include_org_ids, include_project_ids are
empty AND include_gcp_public_datasets is set to false. In this case,
the request returns an error.
.google.cloud.datacatalog.v1.SearchCatalogRequest.Scope scope = 6 [(.google.api.field_behavior) = REQUIRED];
getScopeOrBuilder()
public SearchCatalogRequest.ScopeOrBuilder getScopeOrBuilder()
Required. The scope of this search request.
The scope is invalid if include_org_ids, include_project_ids are
empty AND include_gcp_public_datasets is set to false. In this case,
the request returns an error.
.google.cloud.datacatalog.v1.SearchCatalogRequest.Scope scope = 6 [(.google.api.field_behavior) = REQUIRED];
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hasScope()
public boolean hasScope()
Required. The scope of this search request.
The scope is invalid if include_org_ids, include_project_ids are
empty AND include_gcp_public_datasets is set to false. In this case,
the request returns an error.
.google.cloud.datacatalog.v1.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
