com.google.cloud.discoveryengine.v1

Interface SearchRequest.DataStoreSpecOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

SearchRequest.DataStoreSpec, SearchRequest.DataStoreSpec.Builder

Enclosing class:

SearchRequest

public static interface SearchRequest.DataStoreSpecOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
SearchRequest.BoostSpec	getBoostSpec() Optional.
SearchRequest.BoostSpecOrBuilder	getBoostSpecOrBuilder() Optional.
String	getCustomSearchOperators() Optional.
com.google.protobuf.ByteString	getCustomSearchOperatorsBytes() Optional.
String	getDataStore() Required.
com.google.protobuf.ByteString	getDataStoreBytes() Required.
String	getFilter() Optional.
com.google.protobuf.ByteString	getFilterBytes() Optional.
boolean	hasBoostSpec() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getDataStore

String getDataStore()

 Required. Full resource name of
 [DataStore][google.cloud.discoveryengine.v1.DataStore], such as
 `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
 The path must include the project number, project id is not supported for
 this field.
 

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

Returns:

The dataStore.

getDataStoreBytes

com.google.protobuf.ByteString getDataStoreBytes()

 Required. Full resource name of
 [DataStore][google.cloud.discoveryengine.v1.DataStore], such as
 `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
 The path must include the project number, project id is not supported for
 this field.
 

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

Returns:

The bytes for dataStore.

getFilter

String getFilter()

 Optional. Filter specification to filter documents in the data store
 specified by data_store field. For more information on filtering, see
 [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
 

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

Returns:

The filter.

getFilterBytes

com.google.protobuf.ByteString getFilterBytes()

 Optional. Filter specification to filter documents in the data store
 specified by data_store field. For more information on filtering, see
 [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
 

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

Returns:

The bytes for filter.

hasBoostSpec

boolean hasBoostSpec()

 Optional. Boost specification to boost certain documents.
 For more information on boosting, see
 [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
 

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

Returns:

Whether the boostSpec field is set.

getBoostSpec

SearchRequest.BoostSpec getBoostSpec()

 Optional. Boost specification to boost certain documents.
 For more information on boosting, see
 [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
 

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

Returns:

The boostSpec.

getBoostSpecOrBuilder

SearchRequest.BoostSpecOrBuilder getBoostSpecOrBuilder()

 Optional. Boost specification to boost certain documents.
 For more information on boosting, see
 [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
 

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

getCustomSearchOperators

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](https://support.google.com/cloudsearch/answer/6172299).
 

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

Returns:

The customSearchOperators.

getCustomSearchOperatorsBytes

com.google.protobuf.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](https://support.google.com/cloudsearch/answer/6172299).
 

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

Returns:

The bytes for customSearchOperators.