Class VertexAISearch (3.41.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.v1.VertexAISearch

Static Fields

DATASTORE_FIELD_NUMBER

public static final int DATASTORE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static VertexAISearch getDefaultInstance()
Returns
TypeDescription
VertexAISearch

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static VertexAISearch.Builder newBuilder()
Returns
TypeDescription
VertexAISearch.Builder

newBuilder(VertexAISearch prototype)

public static VertexAISearch.Builder newBuilder(VertexAISearch prototype)
Parameter
NameDescription
prototypeVertexAISearch
Returns
TypeDescription
VertexAISearch.Builder

parseDelimitedFrom(InputStream input)

public static VertexAISearch parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
VertexAISearch
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static VertexAISearch parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
VertexAISearch
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static VertexAISearch parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
VertexAISearch
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static VertexAISearch parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
VertexAISearch
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static VertexAISearch parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
VertexAISearch
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static VertexAISearch parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
VertexAISearch
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static VertexAISearch parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
VertexAISearch
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static VertexAISearch parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
VertexAISearch
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static VertexAISearch parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
VertexAISearch
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static VertexAISearch parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
VertexAISearch
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static VertexAISearch parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
VertexAISearch
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static VertexAISearch parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
VertexAISearch
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<VertexAISearch> parser()
Returns
TypeDescription
Parser<VertexAISearch>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for datastore.

getDefaultInstanceForType()

public VertexAISearch getDefaultInstanceForType()
Returns
TypeDescription
VertexAISearch

getParserForType()

public Parser<VertexAISearch> getParserForType()
Returns
TypeDescription
Parser<VertexAISearch>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public VertexAISearch.Builder newBuilderForType()
Returns
TypeDescription
VertexAISearch.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected VertexAISearch.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
VertexAISearch.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public VertexAISearch.Builder toBuilder()
Returns
TypeDescription
VertexAISearch.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException