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)
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
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:
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:
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()
Optional. The query string in search query syntax. An empty query string
will result in all data assets (in the specified scope) that the user has
access to. Query strings can be simple as "x" or more qualified as:
string query = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The query.
|
getQueryBytes()
public ByteString getQueryBytes()
Optional. The query string in search query syntax. An empty query string
will result in all data assets (in the specified scope) that the user has
access to. Query strings can be simple as "x" or more qualified as:
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. 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
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
