com.google.cloud.aiplatform.v1

Interface VertexAISearchOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

VertexAISearch, VertexAISearch.Builder

public interface VertexAISearchOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getDatastore() Optional.
com.google.protobuf.ByteString	getDatastoreBytes() Optional.
VertexAISearch.DataStoreSpec	getDataStoreSpecs(int index) Specifications that define the specific DataStores to be searched, along with configurations for those data stores.
int	getDataStoreSpecsCount() Specifications that define the specific DataStores to be searched, along with configurations for those data stores.
List<VertexAISearch.DataStoreSpec>	getDataStoreSpecsList() Specifications that define the specific DataStores to be searched, along with configurations for those data stores.
VertexAISearch.DataStoreSpecOrBuilder	getDataStoreSpecsOrBuilder(int index) Specifications that define the specific DataStores to be searched, along with configurations for those data stores.
List<? extends VertexAISearch.DataStoreSpecOrBuilder>	getDataStoreSpecsOrBuilderList() Specifications that define the specific DataStores to be searched, along with configurations for those data stores.
String	getEngine() Optional.
com.google.protobuf.ByteString	getEngineBytes() Optional.
String	getFilter() Optional.
com.google.protobuf.ByteString	getFilterBytes() Optional.
int	getMaxResults() 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()

 Optional. Fully-qualified Vertex AI Search data store resource ID.
 Format:
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
 

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

Returns:

The datastore.

getDatastoreBytes

com.google.protobuf.ByteString getDatastoreBytes()

 Optional. Fully-qualified Vertex AI Search data store resource ID.
 Format:
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
 

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

Returns:

The bytes for datastore.

getEngine

String getEngine()

 Optional. Fully-qualified Vertex AI Search engine resource ID.
 Format:
 `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
 

string engine = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The engine.

getEngineBytes

com.google.protobuf.ByteString getEngineBytes()

 Optional. Fully-qualified Vertex AI Search engine resource ID.
 Format:
 `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
 

string engine = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for engine.

getMaxResults

int getMaxResults()

 Optional. Number of search results to return per query.
 The default value is 10.
 The maximumm allowed value is 10.
 

int32 max_results = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The maxResults.

getFilter

String getFilter()

 Optional. Filter strings to be passed to the search API.
 

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

Returns:

The filter.

getFilterBytes

com.google.protobuf.ByteString getFilterBytes()

 Optional. Filter strings to be passed to the search API.
 

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

Returns:

The bytes for filter.

getDataStoreSpecsList

List<VertexAISearch.DataStoreSpec> getDataStoreSpecsList()

 Specifications that define the specific DataStores to be searched, along
 with configurations for those data stores. This is only considered for
 Engines with multiple data stores.
 It should only be set if engine is used.
 

repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;

getDataStoreSpecs

VertexAISearch.DataStoreSpec getDataStoreSpecs(int index)

 Specifications that define the specific DataStores to be searched, along
 with configurations for those data stores. This is only considered for
 Engines with multiple data stores.
 It should only be set if engine is used.
 

repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;

getDataStoreSpecsCount

int getDataStoreSpecsCount()

 Specifications that define the specific DataStores to be searched, along
 with configurations for those data stores. This is only considered for
 Engines with multiple data stores.
 It should only be set if engine is used.
 

repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;

getDataStoreSpecsOrBuilderList

List<? extends VertexAISearch.DataStoreSpecOrBuilder> getDataStoreSpecsOrBuilderList()

 Specifications that define the specific DataStores to be searched, along
 with configurations for those data stores. This is only considered for
 Engines with multiple data stores.
 It should only be set if engine is used.
 

repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;

getDataStoreSpecsOrBuilder

VertexAISearch.DataStoreSpecOrBuilder getDataStoreSpecsOrBuilder(int index)

 Specifications that define the specific DataStores to be searched, along
 with configurations for those data stores. This is only considered for
 Engines with multiple data stores.
 It should only be set if engine is used.
 

repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;