Class VertexAISearch (3.43.0)

public final class VertexAISearch extends GeneratedMessageV3 implements VertexAISearchOrBuilder

Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation

Protobuf type google.cloud.aiplatform.v1beta1.VertexAISearch

Static Fields

DATASTORE_FIELD_NUMBER

public static final int DATASTORE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static VertexAISearch getDefaultInstance()
Returns
Type Description
VertexAISearch

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static VertexAISearch.Builder newBuilder()
Returns
Type Description
VertexAISearch.Builder

newBuilder(VertexAISearch prototype)

public static VertexAISearch.Builder newBuilder(VertexAISearch prototype)
Parameter
Name Description
prototype VertexAISearch
Returns
Type Description
VertexAISearch.Builder

parseDelimitedFrom(InputStream input)

public static VertexAISearch parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
VertexAISearch
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static VertexAISearch parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VertexAISearch
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static VertexAISearch parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
VertexAISearch
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static VertexAISearch parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VertexAISearch
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static VertexAISearch parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
VertexAISearch
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static VertexAISearch parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VertexAISearch
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static VertexAISearch parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
VertexAISearch
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static VertexAISearch parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VertexAISearch
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static VertexAISearch parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
VertexAISearch
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static VertexAISearch parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VertexAISearch
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static VertexAISearch parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
VertexAISearch
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static VertexAISearch parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VertexAISearch
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<VertexAISearch> parser()
Returns
Type Description
Parser<VertexAISearch>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDatastore()

public String getDatastore()

Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}

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

Returns
Type Description
String

The datastore.

getDatastoreBytes()

public ByteString getDatastoreBytes()

Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}

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

Returns
Type Description
ByteString

The bytes for datastore.

getDefaultInstanceForType()

public VertexAISearch getDefaultInstanceForType()
Returns
Type Description
VertexAISearch

getParserForType()

public Parser<VertexAISearch> getParserForType()
Returns
Type Description
Parser<VertexAISearch>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public VertexAISearch.Builder newBuilderForType()
Returns
Type Description
VertexAISearch.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected VertexAISearch.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
VertexAISearch.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public VertexAISearch.Builder toBuilder()
Returns
Type Description
VertexAISearch.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException