Class SearchRequest.DataStoreSpec.Builder (0.58.0)

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

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

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

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

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

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

clone()

public SearchRequest.DataStoreSpec.Builder clone()
Returns
Type Description
SearchRequest.DataStoreSpec.Builder
Overrides

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

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

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.DataStoreSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SearchRequest.DataStoreSpec.Builder
Overrides

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

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

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

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.DataStoreSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SearchRequest.DataStoreSpec.Builder
Overrides