Send feedback
Class VertexAISearch (3.79.0)
Version latestkeyboard_arrow_down
public final class VertexAISearch extends GeneratedMessageV3 implements VertexAISearchOrBuilder
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int DATASTORE_FIELD_NUMBER
Field Value
Type Description
int
public static final int DATA_STORE_SPECS_FIELD_NUMBER
Field Value
Type Description
int
public static final int ENGINE_FIELD_NUMBER
Field Value
Type Description
int
public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int
public static final int MAX_RESULTS_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
public static VertexAISearch getDefaultInstance ()
public static final Descriptors . Descriptor getDescriptor ()
public static VertexAISearch . Builder newBuilder ()
public static VertexAISearch . Builder newBuilder ( VertexAISearch prototype )
public static VertexAISearch parseDelimitedFrom ( InputStream input )
public static VertexAISearch parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static VertexAISearch parseFrom ( byte [] data )
Parameter
Name Description
databyte []
public static VertexAISearch parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
public static VertexAISearch parseFrom ( ByteString data )
public static VertexAISearch parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static VertexAISearch parseFrom ( CodedInputStream input )
public static VertexAISearch parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static VertexAISearch parseFrom ( InputStream input )
public static VertexAISearch parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static VertexAISearch parseFrom ( ByteBuffer data )
public static VertexAISearch parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
public static Parser<VertexAISearch> parser ()
Methods
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
public 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;
Parameter
Name Description
indexint
public 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;
Returns
Type Description
int
public 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;
public 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;
Parameter
Name Description
indexint
public 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;
Returns
Type Description
List <? extends com.google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpecOrBuilder >
public 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
Type Description
String The datastore.
public 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
Type Description
ByteString The bytes for datastore.
public VertexAISearch getDefaultInstanceForType ()
public 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
Type Description
String The engine.
public 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
Type Description
ByteString The bytes for engine.
public String getFilter ()
Optional. Filter strings to be passed to the search API.
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
String The filter.
public ByteString getFilterBytes ()
Optional. Filter strings to be passed to the search API.
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
ByteString The bytes for filter.
public 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
Type Description
int The maxResults.
public Parser<VertexAISearch> getParserForType ()
Overrides
public int getSerializedSize ()
Returns
Type Description
int
Overrides
Returns
Type Description
int
Overrides
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
public final boolean isInitialized ()
Overrides
public VertexAISearch . Builder newBuilderForType ()
protected VertexAISearch . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
public VertexAISearch . Builder toBuilder ()
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-29 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]
