public static final class SearchCatalogRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<SearchCatalogRequest.Builder> implements SearchCatalogRequestOrBuilder
Request message for [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].Protobuf type
google.cloud.datacatalog.v1.SearchCatalogRequest| Modifier and Type | Method and Description |
|---|---|
SearchCatalogRequest.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
SearchCatalogRequest |
build() |
SearchCatalogRequest |
buildPartial() |
SearchCatalogRequest.Builder |
clear() |
SearchCatalogRequest.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
SearchCatalogRequest.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
SearchCatalogRequest.Builder |
clearOrderBy()
Specifies the order of results.
|
SearchCatalogRequest.Builder |
clearPageSize()
Number of results to return in a single search page.
|
SearchCatalogRequest.Builder |
clearPageToken()
Optional.
|
SearchCatalogRequest.Builder |
clearQuery()
Optional.
|
SearchCatalogRequest.Builder |
clearScope()
Required.
|
SearchCatalogRequest.Builder |
clone() |
SearchCatalogRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
String |
getOrderBy()
Specifies the order of results.
|
com.google.protobuf.ByteString |
getOrderByBytes()
Specifies the order of results.
|
int |
getPageSize()
Number of results to return in a single search page.
|
String |
getPageToken()
Optional.
|
com.google.protobuf.ByteString |
getPageTokenBytes()
Optional.
|
String |
getQuery()
Optional.
|
com.google.protobuf.ByteString |
getQueryBytes()
Optional.
|
SearchCatalogRequest.Scope |
getScope()
Required.
|
SearchCatalogRequest.Scope.Builder |
getScopeBuilder()
Required.
|
SearchCatalogRequest.ScopeOrBuilder |
getScopeOrBuilder()
Required.
|
boolean |
hasScope()
Required.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
SearchCatalogRequest.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
SearchCatalogRequest.Builder |
mergeFrom(com.google.protobuf.Message other) |
SearchCatalogRequest.Builder |
mergeFrom(SearchCatalogRequest other) |
SearchCatalogRequest.Builder |
mergeScope(SearchCatalogRequest.Scope value)
Required.
|
SearchCatalogRequest.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
SearchCatalogRequest.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
SearchCatalogRequest.Builder |
setOrderBy(String value)
Specifies the order of results.
|
SearchCatalogRequest.Builder |
setOrderByBytes(com.google.protobuf.ByteString value)
Specifies the order of results.
|
SearchCatalogRequest.Builder |
setPageSize(int value)
Number of results to return in a single search page.
|
SearchCatalogRequest.Builder |
setPageToken(String value)
Optional.
|
SearchCatalogRequest.Builder |
setPageTokenBytes(com.google.protobuf.ByteString value)
Optional.
|
SearchCatalogRequest.Builder |
setQuery(String value)
Optional.
|
SearchCatalogRequest.Builder |
setQueryBytes(com.google.protobuf.ByteString value)
Optional.
|
SearchCatalogRequest.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
SearchCatalogRequest.Builder |
setScope(SearchCatalogRequest.Scope.Builder builderForValue)
Required.
|
SearchCatalogRequest.Builder |
setScope(SearchCatalogRequest.Scope value)
Required.
|
SearchCatalogRequest.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<SearchCatalogRequest.Builder>public SearchCatalogRequest.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<SearchCatalogRequest.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<SearchCatalogRequest.Builder>public SearchCatalogRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic SearchCatalogRequest build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic SearchCatalogRequest buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic SearchCatalogRequest.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<SearchCatalogRequest.Builder>public SearchCatalogRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchCatalogRequest.Builder>public SearchCatalogRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchCatalogRequest.Builder>public SearchCatalogRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<SearchCatalogRequest.Builder>public SearchCatalogRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchCatalogRequest.Builder>public SearchCatalogRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchCatalogRequest.Builder>public SearchCatalogRequest.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchCatalogRequest.Builder>public SearchCatalogRequest.Builder mergeFrom(SearchCatalogRequest other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<SearchCatalogRequest.Builder>public SearchCatalogRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchCatalogRequest.Builder>IOExceptionpublic 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];
hasScope in interface SearchCatalogRequestOrBuilderpublic 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];
getScope in interface SearchCatalogRequestOrBuilderpublic SearchCatalogRequest.Builder setScope(SearchCatalogRequest.Scope value)
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];
public SearchCatalogRequest.Builder setScope(SearchCatalogRequest.Scope.Builder builderForValue)
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];
public SearchCatalogRequest.Builder mergeScope(SearchCatalogRequest.Scope value)
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];
public SearchCatalogRequest.Builder clearScope()
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];
public SearchCatalogRequest.Scope.Builder getScopeBuilder()
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];
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];
getScopeOrBuilder in interface SearchCatalogRequestOrBuilderpublic String 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];getQuery in interface SearchCatalogRequestOrBuilderpublic com.google.protobuf.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];getQueryBytes in interface SearchCatalogRequestOrBuilderpublic SearchCatalogRequest.Builder setQuery(String value)
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];value - The query to set.public SearchCatalogRequest.Builder clearQuery()
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];public SearchCatalogRequest.Builder setQueryBytes(com.google.protobuf.ByteString value)
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];value - The bytes for query to set.public int 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;getPageSize in interface SearchCatalogRequestOrBuilderpublic SearchCatalogRequest.Builder setPageSize(int value)
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;value - The pageSize to set.public SearchCatalogRequest.Builder clearPageSize()
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;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];getPageToken in interface SearchCatalogRequestOrBuilderpublic com.google.protobuf.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];getPageTokenBytes in interface SearchCatalogRequestOrBuilderpublic SearchCatalogRequest.Builder setPageToken(String value)
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];value - The pageToken to set.public SearchCatalogRequest.Builder clearPageToken()
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];public SearchCatalogRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
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];value - The bytes for pageToken to set.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 * `default` that can only be descending If this parameter is omitted, it defaults to the descending `relevance`.
string order_by = 5;getOrderBy in interface SearchCatalogRequestOrBuilderpublic com.google.protobuf.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 * `default` that can only be descending If this parameter is omitted, it defaults to the descending `relevance`.
string order_by = 5;getOrderByBytes in interface SearchCatalogRequestOrBuilderpublic SearchCatalogRequest.Builder setOrderBy(String value)
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 * `default` that can only be descending If this parameter is omitted, it defaults to the descending `relevance`.
string order_by = 5;value - The orderBy to set.public SearchCatalogRequest.Builder clearOrderBy()
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 * `default` that can only be descending If this parameter is omitted, it defaults to the descending `relevance`.
string order_by = 5;public SearchCatalogRequest.Builder setOrderByBytes(com.google.protobuf.ByteString value)
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 * `default` that can only be descending If this parameter is omitted, it defaults to the descending `relevance`.
string order_by = 5;value - The bytes for orderBy to set.public final SearchCatalogRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchCatalogRequest.Builder>public final SearchCatalogRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchCatalogRequest.Builder>Copyright © 2023 Google LLC. All rights reserved.