public final class SearchCatalogRequest extends GeneratedMessageV3 implements SearchCatalogRequestOrBuilder
Request message for
[SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].
Protobuf type google.cloud.datacatalog.v1.SearchCatalogRequest
Fields
ORDER_BY_FIELD_NUMBER
public static final int ORDER_BY_FIELD_NUMBER
Field Value
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
QUERY_FIELD_NUMBER
public static final int QUERY_FIELD_NUMBER
Field Value
SCOPE_FIELD_NUMBER
public static final int SCOPE_FIELD_NUMBER
Field Value
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstance()
public static SearchCatalogRequest getDefaultInstance()
Returns
getDefaultInstanceForType()
public SearchCatalogRequest getDefaultInstanceForType()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
getOrderBy()
public String getOrderBy()
Specifies the order of results.
Currently supported case-sensitive values are:
* `relevance` that can only be descending
* `last_modified_timestamp [asc|desc]` with descending (`desc`) as default
If this parameter is omitted, it defaults to the descending `relevance`.
string order_by = 5;
| 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 descending
* `last_modified_timestamp [asc|desc]` with descending (`desc`) as default
If this parameter is omitted, it defaults to the descending `relevance`.
string order_by = 5;
getPageSize()
Number of results to return in a single search page.
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;
| 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][google.cloud.datacatalog.v1.SearchCatalogResponse.next_page_token]
field of the response to a previous
[SearchCatalogRequest][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog]
call.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| 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][google.cloud.datacatalog.v1.SearchCatalogResponse.next_page_token]
field of the response to a previous
[SearchCatalogRequest][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog]
call.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
getParserForType()
public Parser<SearchCatalogRequest> getParserForType()
Returns
Overrides
getQuery()
Optional. The query string with a minimum of 3 characters and specific syntax.
For more information, see
[Data Catalog search syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference).
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:x`
* `column:y`
* `description:z`
string query = 1 [(.google.api.field_behavior) = OPTIONAL];
| 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](https://cloud.google.com/data-catalog/docs/how-to/search-reference).
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:x`
* `column:y`
* `description:z`
string query = 1 [(.google.api.field_behavior) = OPTIONAL];
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
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
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];
| Type | Description |
| boolean | Whether the scope field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilder()
public static SearchCatalogRequest.Builder newBuilder()
Returns
newBuilder(SearchCatalogRequest prototype)
public static SearchCatalogRequest.Builder newBuilder(SearchCatalogRequest prototype)
Parameter
Returns
newBuilderForType()
public SearchCatalogRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchCatalogRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public static SearchCatalogRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static SearchCatalogRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static SearchCatalogRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchCatalogRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static SearchCatalogRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchCatalogRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static SearchCatalogRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static SearchCatalogRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static SearchCatalogRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static SearchCatalogRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static SearchCatalogRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchCatalogRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<SearchCatalogRequest> parser()
Returns
toBuilder()
public SearchCatalogRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
