com.google.cloud.datacatalog

Class SearchCatalogRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<SearchCatalogRequest.Builder>

com.google.cloud.datacatalog.SearchCatalogRequest.Builder

All Implemented Interfaces:

SearchCatalogRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

SearchCatalogRequest

public static final class SearchCatalogRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<SearchCatalogRequest.Builder>
implements SearchCatalogRequestOrBuilder

 Request message for
 [SearchCatalog][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog].
 

Protobuf type google.cloud.datacatalog.v1beta1.SearchCatalogRequest

Method Summary

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 ordering of results, currently supported case-sensitive choices are: <ul> <li> relevance </li> <li> last_access_timestamp [asc|desc], defaults to descending if not specified, </li> <li> last_modified_timestamp [asc|desc], defaults to descending if not specified.
SearchCatalogRequest.Builder	clearPageSize() Number of results in the search page.
SearchCatalogRequest.Builder	clearPageToken() Optional pagination token returned in an earlier [SearchCatalogResponse.next_page_token][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalogResponse.next_page_token]; indicates that this is a continuation of a prior [SearchCatalog][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog] call, and that the system should return the next page of data.
SearchCatalogRequest.Builder	clearQuery() Required.
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 ordering of results, currently supported case-sensitive choices are: <ul> <li> relevance </li> <li> last_access_timestamp [asc|desc], defaults to descending if not specified, </li> <li> last_modified_timestamp [asc|desc], defaults to descending if not specified.
com.google.protobuf.ByteString	getOrderByBytes() Specifies the ordering of results, currently supported case-sensitive choices are: <ul> <li> relevance </li> <li> last_access_timestamp [asc|desc], defaults to descending if not specified, </li> <li> last_modified_timestamp [asc|desc], defaults to descending if not specified.
int	getPageSize() Number of results in the search page.
String	getPageToken() Optional pagination token returned in an earlier [SearchCatalogResponse.next_page_token][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalogResponse.next_page_token]; indicates that this is a continuation of a prior [SearchCatalog][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog] call, and that the system should return the next page of data.
com.google.protobuf.ByteString	getPageTokenBytes() Optional pagination token returned in an earlier [SearchCatalogResponse.next_page_token][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalogResponse.next_page_token]; indicates that this is a continuation of a prior [SearchCatalog][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog] call, and that the system should return the next page of data.
String	getQuery() Required.
com.google.protobuf.ByteString	getQueryBytes() Required.
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 ordering of results, currently supported case-sensitive choices are: <ul> <li> relevance </li> <li> last_access_timestamp [asc|desc], defaults to descending if not specified, </li> <li> last_modified_timestamp [asc|desc], defaults to descending if not specified.
SearchCatalogRequest.Builder	setOrderByBytes(com.google.protobuf.ByteString value) Specifies the ordering of results, currently supported case-sensitive choices are: <ul> <li> relevance </li> <li> last_access_timestamp [asc|desc], defaults to descending if not specified, </li> <li> last_modified_timestamp [asc|desc], defaults to descending if not specified.
SearchCatalogRequest.Builder	setPageSize(int value) Number of results in the search page.
SearchCatalogRequest.Builder	setPageToken(String value) Optional pagination token returned in an earlier [SearchCatalogResponse.next_page_token][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalogResponse.next_page_token]; indicates that this is a continuation of a prior [SearchCatalog][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog] call, and that the system should return the next page of data.
SearchCatalogRequest.Builder	setPageTokenBytes(com.google.protobuf.ByteString value) Optional pagination token returned in an earlier [SearchCatalogResponse.next_page_token][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalogResponse.next_page_token]; indicates that this is a continuation of a prior [SearchCatalog][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog] call, and that the system should return the next page of data.
SearchCatalogRequest.Builder	setQuery(String value) Required.
SearchCatalogRequest.Builder	setQueryBytes(com.google.protobuf.ByteString value) Required.
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)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<SearchCatalogRequest.Builder>

clear

public SearchCatalogRequest.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<SearchCatalogRequest.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<SearchCatalogRequest.Builder>

getDefaultInstanceForType

public SearchCatalogRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public SearchCatalogRequest build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public SearchCatalogRequest buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public SearchCatalogRequest.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<SearchCatalogRequest.Builder>

setField

public SearchCatalogRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                             Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchCatalogRequest.Builder>

clearField

public SearchCatalogRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchCatalogRequest.Builder>

clearOneof

public SearchCatalogRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<SearchCatalogRequest.Builder>

setRepeatedField

public SearchCatalogRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                     int index,
                                                     Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchCatalogRequest.Builder>

addRepeatedField

public SearchCatalogRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                     Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchCatalogRequest.Builder>

mergeFrom

public SearchCatalogRequest.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchCatalogRequest.Builder>

mergeFrom

public SearchCatalogRequest.Builder mergeFrom(SearchCatalogRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<SearchCatalogRequest.Builder>

mergeFrom

public SearchCatalogRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchCatalogRequest.Builder>

Throws:

IOException

hasScope

public boolean hasScope()

 Required. The scope of this search request.
 

.google.cloud.datacatalog.v1beta1.SearchCatalogRequest.Scope scope = 6;

Specified by:

hasScope in interface SearchCatalogRequestOrBuilder

getScope

public SearchCatalogRequest.Scope getScope()

 Required. The scope of this search request.
 

.google.cloud.datacatalog.v1beta1.SearchCatalogRequest.Scope scope = 6;

Specified by:

getScope in interface SearchCatalogRequestOrBuilder

setScope

public SearchCatalogRequest.Builder setScope(SearchCatalogRequest.Scope value)

 Required. The scope of this search request.
 

.google.cloud.datacatalog.v1beta1.SearchCatalogRequest.Scope scope = 6;

setScope

public SearchCatalogRequest.Builder setScope(SearchCatalogRequest.Scope.Builder builderForValue)

 Required. The scope of this search request.
 

.google.cloud.datacatalog.v1beta1.SearchCatalogRequest.Scope scope = 6;

mergeScope

public SearchCatalogRequest.Builder mergeScope(SearchCatalogRequest.Scope value)

 Required. The scope of this search request.
 

.google.cloud.datacatalog.v1beta1.SearchCatalogRequest.Scope scope = 6;

clearScope

public SearchCatalogRequest.Builder clearScope()

 Required. The scope of this search request.
 

.google.cloud.datacatalog.v1beta1.SearchCatalogRequest.Scope scope = 6;

getScopeBuilder

public SearchCatalogRequest.Scope.Builder getScopeBuilder()

 Required. The scope of this search request.
 

.google.cloud.datacatalog.v1beta1.SearchCatalogRequest.Scope scope = 6;

getScopeOrBuilder

public SearchCatalogRequest.ScopeOrBuilder getScopeOrBuilder()

 Required. The scope of this search request.
 

.google.cloud.datacatalog.v1beta1.SearchCatalogRequest.Scope scope = 6;

Specified by:

getScopeOrBuilder in interface SearchCatalogRequestOrBuilder

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](/data-catalog/docs/how-to/search-reference) for more information.
 

string query = 1;

Specified by:

getQuery in interface SearchCatalogRequestOrBuilder

getQueryBytes

public com.google.protobuf.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](/data-catalog/docs/how-to/search-reference) for more information.
 

string query = 1;

Specified by:

getQueryBytes in interface SearchCatalogRequestOrBuilder

setQuery

public SearchCatalogRequest.Builder setQuery(String value)

 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](/data-catalog/docs/how-to/search-reference) for more information.
 

string query = 1;

clearQuery

public SearchCatalogRequest.Builder clearQuery()

 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](/data-catalog/docs/how-to/search-reference) for more information.
 

string query = 1;

setQueryBytes

public SearchCatalogRequest.Builder setQueryBytes(com.google.protobuf.ByteString value)

 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](/data-catalog/docs/how-to/search-reference) for more information.
 

string query = 1;

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;

Specified by:

getPageSize in interface SearchCatalogRequestOrBuilder

setPageSize

public SearchCatalogRequest.Builder setPageSize(int value)

 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;

clearPageSize

public SearchCatalogRequest.Builder clearPageSize()

 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;

getPageToken

public String getPageToken()

 Optional pagination token returned in an earlier
 [SearchCatalogResponse.next_page_token][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalogResponse.next_page_token];
 indicates that this is a continuation of a prior
 [SearchCatalog][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog]
 call, and that the system should return the next page of data. If empty
 then the first page is returned.
 

string page_token = 3;

Specified by:

getPageToken in interface SearchCatalogRequestOrBuilder

getPageTokenBytes

public com.google.protobuf.ByteString getPageTokenBytes()

 Optional pagination token returned in an earlier
 [SearchCatalogResponse.next_page_token][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalogResponse.next_page_token];
 indicates that this is a continuation of a prior
 [SearchCatalog][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog]
 call, and that the system should return the next page of data. If empty
 then the first page is returned.
 

string page_token = 3;

Specified by:

getPageTokenBytes in interface SearchCatalogRequestOrBuilder

setPageToken

public SearchCatalogRequest.Builder setPageToken(String value)

 Optional pagination token returned in an earlier
 [SearchCatalogResponse.next_page_token][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalogResponse.next_page_token];
 indicates that this is a continuation of a prior
 [SearchCatalog][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog]
 call, and that the system should return the next page of data. If empty
 then the first page is returned.
 

string page_token = 3;

clearPageToken

public SearchCatalogRequest.Builder clearPageToken()

 Optional pagination token returned in an earlier
 [SearchCatalogResponse.next_page_token][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalogResponse.next_page_token];
 indicates that this is a continuation of a prior
 [SearchCatalog][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog]
 call, and that the system should return the next page of data. If empty
 then the first page is returned.
 

string page_token = 3;

setPageTokenBytes

public SearchCatalogRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)

 Optional pagination token returned in an earlier
 [SearchCatalogResponse.next_page_token][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalogResponse.next_page_token];
 indicates that this is a continuation of a prior
 [SearchCatalog][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog]
 call, and that the system should return the next page of data. If empty
 then the first page is returned.
 

string page_token = 3;

getOrderBy

public String getOrderBy()

 Specifies the ordering of results, currently supported case-sensitive
 choices are:
 <ul>
   <li> relevance </li>
   <li> last_access_timestamp [asc|desc], defaults to descending if not
   specified, </li>
   <li> last_modified_timestamp [asc|desc], defaults to descending if not
   specified. </li>
 </ul>
 

string order_by = 5;

Specified by:

getOrderBy in interface SearchCatalogRequestOrBuilder

getOrderByBytes

public com.google.protobuf.ByteString getOrderByBytes()

 Specifies the ordering of results, currently supported case-sensitive
 choices are:
 <ul>
   <li> relevance </li>
   <li> last_access_timestamp [asc|desc], defaults to descending if not
   specified, </li>
   <li> last_modified_timestamp [asc|desc], defaults to descending if not
   specified. </li>
 </ul>
 

string order_by = 5;

Specified by:

getOrderByBytes in interface SearchCatalogRequestOrBuilder

setOrderBy

public SearchCatalogRequest.Builder setOrderBy(String value)

 Specifies the ordering of results, currently supported case-sensitive
 choices are:
 <ul>
   <li> relevance </li>
   <li> last_access_timestamp [asc|desc], defaults to descending if not
   specified, </li>
   <li> last_modified_timestamp [asc|desc], defaults to descending if not
   specified. </li>
 </ul>
 

string order_by = 5;

clearOrderBy

public SearchCatalogRequest.Builder clearOrderBy()

 Specifies the ordering of results, currently supported case-sensitive
 choices are:
 <ul>
   <li> relevance </li>
   <li> last_access_timestamp [asc|desc], defaults to descending if not
   specified, </li>
   <li> last_modified_timestamp [asc|desc], defaults to descending if not
   specified. </li>
 </ul>
 

string order_by = 5;

setOrderByBytes

public SearchCatalogRequest.Builder setOrderByBytes(com.google.protobuf.ByteString value)

 Specifies the ordering of results, currently supported case-sensitive
 choices are:
 <ul>
   <li> relevance </li>
   <li> last_access_timestamp [asc|desc], defaults to descending if not
   specified, </li>
   <li> last_modified_timestamp [asc|desc], defaults to descending if not
   specified. </li>
 </ul>
 

string order_by = 5;

setUnknownFields

public final SearchCatalogRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchCatalogRequest.Builder>

mergeUnknownFields

public final SearchCatalogRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchCatalogRequest.Builder>