Class SearchRequest.DataStoreSpec.Builder (0.60.0)
Stay organized with collections Save and categorize content based on your preferences.

public static final class SearchRequest.DataStoreSpec.Builder extends GeneratedMessageV3.Builder<SearchRequest.DataStoreSpec.Builder> implements SearchRequest.DataStoreSpecOrBuilder

A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an INVALID_ARGUMENT error is returned.

Protobuf type google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchRequest.DataStoreSpec.Builder

Implements

SearchRequest.DataStoreSpecOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

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.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

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)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

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

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

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

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)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`SearchRequest.DataStoreSpec.Builder`

Overrides

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

build()

public SearchRequest.DataStoreSpec build()

Returns
Type	Description
`SearchRequest.DataStoreSpec`

buildPartial()

public SearchRequest.DataStoreSpec buildPartial()

Returns
Type	Description
`SearchRequest.DataStoreSpec`

clear()

public SearchRequest.DataStoreSpec.Builder clear()

Returns
Type	Description
`SearchRequest.DataStoreSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearBoostSpec()

public SearchRequest.DataStoreSpec.Builder clearBoostSpec()

Optional. Boost specification to boost certain documents. For more information on boosting, see Boosting

.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec boost_spec = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`SearchRequest.DataStoreSpec.Builder`

clearCustomSearchOperators()

public SearchRequest.DataStoreSpec.Builder clearCustomSearchOperators()

Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see SearchOperators.

string custom_search_operators = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`SearchRequest.DataStoreSpec.Builder`	This builder for chaining.

clearDataStore()

public SearchRequest.DataStoreSpec.Builder clearDataStore()

Required. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}.

string data_store = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`SearchRequest.DataStoreSpec.Builder`	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public SearchRequest.DataStoreSpec.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`SearchRequest.DataStoreSpec.Builder`

Overrides

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

clearFilter()

public SearchRequest.DataStoreSpec.Builder clearFilter()

Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see Filtering

string filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`SearchRequest.DataStoreSpec.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchRequest.DataStoreSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`SearchRequest.DataStoreSpec.Builder`

Overrides

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

clone()

public SearchRequest.DataStoreSpec.Builder clone()

Returns
Type	Description
`SearchRequest.DataStoreSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getBoostSpec()

public SearchRequest.BoostSpec getBoostSpec()

Optional. Boost specification to boost certain documents. For more information on boosting, see Boosting

.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec boost_spec = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`SearchRequest.BoostSpec`	The boostSpec.

getBoostSpecBuilder()

public SearchRequest.BoostSpec.Builder getBoostSpecBuilder()

Optional. Boost specification to boost certain documents. For more information on boosting, see Boosting

.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec boost_spec = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`SearchRequest.BoostSpec.Builder`

getBoostSpecOrBuilder()

public SearchRequest.BoostSpecOrBuilder getBoostSpecOrBuilder()

Optional. Boost specification to boost certain documents. For more information on boosting, see Boosting

.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec boost_spec = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`SearchRequest.BoostSpecOrBuilder`

getCustomSearchOperators()

public String getCustomSearchOperators()

Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see SearchOperators.

string custom_search_operators = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The customSearchOperators.

getCustomSearchOperatorsBytes()

public ByteString getCustomSearchOperatorsBytes()

Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see SearchOperators.

string custom_search_operators = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for customSearchOperators.

getDataStore()

public String getDataStore()

Required. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}.

string data_store = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`String`	The dataStore.

getDataStoreBytes()

public ByteString getDataStoreBytes()

Required. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}.

string data_store = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`ByteString`	The bytes for dataStore.

getDefaultInstanceForType()

public SearchRequest.DataStoreSpec getDefaultInstanceForType()

Returns
Type	Description
`SearchRequest.DataStoreSpec`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getFilter()

public String getFilter()

Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see Filtering

string filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see Filtering

string filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for filter.

hasBoostSpec()

public boolean hasBoostSpec()

Optional. Boost specification to boost certain documents. For more information on boosting, see Boosting

.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec boost_spec = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the boostSpec 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()

mergeBoostSpec(SearchRequest.BoostSpec value)

public SearchRequest.DataStoreSpec.Builder mergeBoostSpec(SearchRequest.BoostSpec value)

Optional. Boost specification to boost certain documents. For more information on boosting, see Boosting

.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec boost_spec = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`SearchRequest.BoostSpec`

Returns
Type	Description
`SearchRequest.DataStoreSpec.Builder`

mergeFrom(SearchRequest.DataStoreSpec other)

public SearchRequest.DataStoreSpec.Builder mergeFrom(SearchRequest.DataStoreSpec other)

Parameter
Name	Description
`other`	`SearchRequest.DataStoreSpec`

Returns
Type	Description
`SearchRequest.DataStoreSpec.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchRequest.DataStoreSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SearchRequest.DataStoreSpec.Builder`

Overrides

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

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public SearchRequest.DataStoreSpec.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`SearchRequest.DataStoreSpec.Builder`

Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.DataStoreSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`SearchRequest.DataStoreSpec.Builder`

Overrides

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

setBoostSpec(SearchRequest.BoostSpec value)

public SearchRequest.DataStoreSpec.Builder setBoostSpec(SearchRequest.BoostSpec value)

Optional. Boost specification to boost certain documents. For more information on boosting, see Boosting

.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec boost_spec = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`SearchRequest.BoostSpec`

Returns
Type	Description
`SearchRequest.DataStoreSpec.Builder`

setBoostSpec(SearchRequest.BoostSpec.Builder builderForValue)

public SearchRequest.DataStoreSpec.Builder setBoostSpec(SearchRequest.BoostSpec.Builder builderForValue)

Optional. Boost specification to boost certain documents. For more information on boosting, see Boosting

.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec boost_spec = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`builderForValue`	`SearchRequest.BoostSpec.Builder`

Returns
Type	Description
`SearchRequest.DataStoreSpec.Builder`

setCustomSearchOperators(String value)

public SearchRequest.DataStoreSpec.Builder setCustomSearchOperators(String value)

Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see SearchOperators.

string custom_search_operators = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`String` The customSearchOperators to set.

Returns
Type	Description
`SearchRequest.DataStoreSpec.Builder`	This builder for chaining.

setCustomSearchOperatorsBytes(ByteString value)

public SearchRequest.DataStoreSpec.Builder setCustomSearchOperatorsBytes(ByteString value)

Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see SearchOperators.

string custom_search_operators = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`ByteString` The bytes for customSearchOperators to set.

Returns
Type	Description
`SearchRequest.DataStoreSpec.Builder`	This builder for chaining.

setDataStore(String value)

public SearchRequest.DataStoreSpec.Builder setDataStore(String value)

Required. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}.

string data_store = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
`value`	`String` The dataStore to set.

Returns
Type	Description
`SearchRequest.DataStoreSpec.Builder`	This builder for chaining.

setDataStoreBytes(ByteString value)

public SearchRequest.DataStoreSpec.Builder setDataStoreBytes(ByteString value)

Required. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}.

string data_store = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
`value`	`ByteString` The bytes for dataStore to set.

Returns
Type	Description
`SearchRequest.DataStoreSpec.Builder`	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`SearchRequest.DataStoreSpec.Builder`

Overrides

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

setFilter(String value)

public SearchRequest.DataStoreSpec.Builder setFilter(String value)

Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see Filtering

string filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`String` The filter to set.

Returns
Type	Description
`SearchRequest.DataStoreSpec.Builder`	This builder for chaining.

setFilterBytes(ByteString value)

public SearchRequest.DataStoreSpec.Builder setFilterBytes(ByteString value)

Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see Filtering

string filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`ByteString` The bytes for filter to set.

Returns
Type	Description
`SearchRequest.DataStoreSpec.Builder`	This builder for chaining.

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

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`SearchRequest.DataStoreSpec.Builder`

Overrides

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

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.DataStoreSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`SearchRequest.DataStoreSpec.Builder`

Overrides

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

Class SearchRequest.DataStoreSpec.Builder (0.60.0) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Implements

Inherited Members

Static Methods

getDescriptor()

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

buildPartial()

clear()

clearBoostSpec()

clearCustomSearchOperators()

clearDataStore()

clearField(Descriptors.FieldDescriptor field)

clearFilter()

clearOneof(Descriptors.OneofDescriptor oneof)

clone()

getBoostSpec()

getBoostSpecBuilder()

getBoostSpecOrBuilder()

getCustomSearchOperators()

getCustomSearchOperatorsBytes()

getDataStore()

getDataStoreBytes()

getDefaultInstanceForType()

getDescriptorForType()

getFilter()

getFilterBytes()

hasBoostSpec()

internalGetFieldAccessorTable()

isInitialized()

mergeBoostSpec(SearchRequest.BoostSpec value)

mergeFrom(SearchRequest.DataStoreSpec other)

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

setBoostSpec(SearchRequest.BoostSpec value)

setBoostSpec(SearchRequest.BoostSpec.Builder builderForValue)

setCustomSearchOperators(String value)

setCustomSearchOperatorsBytes(ByteString value)

setDataStore(String value)

setDataStoreBytes(ByteString value)

setField(Descriptors.FieldDescriptor field, Object value)

setFilter(String value)

setFilterBytes(ByteString value)

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

setUnknownFields(UnknownFieldSet unknownFields)

Class SearchRequest.DataStoreSpec.Builder (0.60.0)
Stay organized with collections Save and categorize content based on your preferences.