Class SearchCatalogRequest.Builder (1.6.2)

Version 1.6.2

• 1.59.0 (latest)
• 1.58.0
• 1.57.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.5
• 1.8.4
• 1.7.2
• 1.6.2
• 1.5.4

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

Request message for SearchCatalog.

Protobuf type google.cloud.datacatalog.v1.SearchCatalogRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchCatalogRequest.Builder

Implements

SearchCatalogRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
SearchCatalogRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public SearchCatalogRequest build()

Returns

Type	Description
SearchCatalogRequest

buildPartial()

public SearchCatalogRequest buildPartial()

Returns

Type	Description
SearchCatalogRequest

clear()

public SearchCatalogRequest.Builder clear()

Returns

Type	Description
SearchCatalogRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public SearchCatalogRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
SearchCatalogRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchCatalogRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
SearchCatalogRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearOrderBy()

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 If this parameter is omitted, it defaults to the descending relevance.

string order_by = 5;

Returns

Type	Description
SearchCatalogRequest.Builder	This builder for chaining.

clearPageSize()

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;

Returns

Type	Description
SearchCatalogRequest.Builder	This builder for chaining.

clearPageToken()

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 field of the response to a previous SearchCatalogRequest call.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
SearchCatalogRequest.Builder	This builder for chaining.

clearQuery()

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. 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];

Returns

Type	Description
SearchCatalogRequest.Builder	This builder for chaining.

clearScope()

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];

Returns

Type	Description
SearchCatalogRequest.Builder

clone()

public SearchCatalogRequest.Builder clone()

Returns

Type	Description
SearchCatalogRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public SearchCatalogRequest getDefaultInstanceForType()

Returns

Type	Description
SearchCatalogRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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;

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 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;

Returns

Type	Description
ByteString	The bytes for orderBy.

getPageSize()

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;

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.

getQuery()

public String 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:x
• column:y
• description: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:x
• column:y
• description: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];

Returns

Type	Description
SearchCatalogRequest.Scope	The scope.

getScopeBuilder()

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];

Returns

Type	Description
SearchCatalogRequest.Scope.Builder

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];

Returns

Type	Description
SearchCatalogRequest.ScopeOrBuilder

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(SearchCatalogRequest other)

public SearchCatalogRequest.Builder mergeFrom(SearchCatalogRequest other)

Parameter

Name	Description
other	SearchCatalogRequest

Returns

Type	Description
SearchCatalogRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchCatalogRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
SearchCatalogRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public SearchCatalogRequest.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
SearchCatalogRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeScope(SearchCatalogRequest.Scope value)

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];

Parameter

Name	Description
value	SearchCatalogRequest.Scope

Returns

Type	Description
SearchCatalogRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchCatalogRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
SearchCatalogRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
SearchCatalogRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setOrderBy(String value)

public 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 If this parameter is omitted, it defaults to the descending relevance.

string order_by = 5;

Parameter

Name	Description
value	String The orderBy to set.

Returns

Type	Description
SearchCatalogRequest.Builder	This builder for chaining.

setOrderByBytes(ByteString value)

public SearchCatalogRequest.Builder setOrderByBytes(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 If this parameter is omitted, it defaults to the descending relevance.

string order_by = 5;

Parameter

Name	Description
value	ByteString The bytes for orderBy to set.

Returns

Type	Description
SearchCatalogRequest.Builder	This builder for chaining.

setPageSize(int value)

public 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;

Parameter

Name	Description
value	int The pageSize to set.

Returns

Type	Description
SearchCatalogRequest.Builder	This builder for chaining.

setPageToken(String value)

public 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 field of the response to a previous SearchCatalogRequest call.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	String The pageToken to set.

Returns

Type	Description
SearchCatalogRequest.Builder	This builder for chaining.

setPageTokenBytes(ByteString value)

public SearchCatalogRequest.Builder setPageTokenBytes(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 field of the response to a previous SearchCatalogRequest call.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	ByteString The bytes for pageToken to set.

Returns

Type	Description
SearchCatalogRequest.Builder	This builder for chaining.

setQuery(String value)

public 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. 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];

Parameter

Name	Description
value	String The query to set.

Returns

Type	Description
SearchCatalogRequest.Builder	This builder for chaining.

setQueryBytes(ByteString value)

public SearchCatalogRequest.Builder setQueryBytes(ByteString value)

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:x
• column:y
• description:z

string query = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	ByteString The bytes for query to set.

Returns

Type	Description
SearchCatalogRequest.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
SearchCatalogRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setScope(SearchCatalogRequest.Scope value)

public 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];

Parameter

Name	Description
value	SearchCatalogRequest.Scope

Returns

Type	Description
SearchCatalogRequest.Builder

setScope(SearchCatalogRequest.Scope.Builder builderForValue)

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];

Parameter

Name	Description
builderForValue	SearchCatalogRequest.Scope.Builder

Returns

Type	Description
SearchCatalogRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchCatalogRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
SearchCatalogRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)