public static final class VertexAISearch.DataStoreSpec extends GeneratedMessage implements VertexAISearch.DataStoreSpecOrBuilderDefine data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec
Protobuf type google.cloud.vertexai.v1.VertexAISearch.DataStoreSpec
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > VertexAISearch.DataStoreSpecImplements
VertexAISearch.DataStoreSpecOrBuilderStatic Fields
DATA_STORE_FIELD_NUMBER
public static final int DATA_STORE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static VertexAISearch.DataStoreSpec getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
VertexAISearch.DataStoreSpec |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static VertexAISearch.DataStoreSpec.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
VertexAISearch.DataStoreSpec.Builder |
|
newBuilder(VertexAISearch.DataStoreSpec prototype)
public static VertexAISearch.DataStoreSpec.Builder newBuilder(VertexAISearch.DataStoreSpec prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
VertexAISearch.DataStoreSpec |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.DataStoreSpec.Builder |
|
parseDelimitedFrom(InputStream input)
public static VertexAISearch.DataStoreSpec parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.DataStoreSpec |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static VertexAISearch.DataStoreSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.DataStoreSpec |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static VertexAISearch.DataStoreSpec parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.DataStoreSpec |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static VertexAISearch.DataStoreSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.DataStoreSpec |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static VertexAISearch.DataStoreSpec parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.DataStoreSpec |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static VertexAISearch.DataStoreSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.DataStoreSpec |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static VertexAISearch.DataStoreSpec parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.DataStoreSpec |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static VertexAISearch.DataStoreSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.DataStoreSpec |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static VertexAISearch.DataStoreSpec parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.DataStoreSpec |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static VertexAISearch.DataStoreSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.DataStoreSpec |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static VertexAISearch.DataStoreSpec parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.DataStoreSpec |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static VertexAISearch.DataStoreSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.DataStoreSpec |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<VertexAISearch.DataStoreSpec> parser()| Returns | |
|---|---|
| Type | Description |
Parser<DataStoreSpec> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getDataStore()
public String getDataStore() Full resource name of DataStore, such as
Format:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}
string data_store = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The dataStore. |
getDataStoreBytes()
public ByteString getDataStoreBytes() Full resource name of DataStore, such as
Format:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}
string data_store = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for dataStore. |
getDefaultInstanceForType()
public VertexAISearch.DataStoreSpec getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
VertexAISearch.DataStoreSpec |
|
getFilter()
public String getFilter()Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see Filtering
string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The filter. |
getFilterBytes()
public ByteString getFilterBytes()Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see Filtering
string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for filter. |
getParserForType()
public Parser<VertexAISearch.DataStoreSpec> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<DataStoreSpec> |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public VertexAISearch.DataStoreSpec.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
VertexAISearch.DataStoreSpec.Builder |
|
newBuilderForType(AbstractMessage.BuilderParent parent)
protected VertexAISearch.DataStoreSpec.Builder newBuilderForType(AbstractMessage.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
VertexAISearch.DataStoreSpec.Builder |
|
toBuilder()
public VertexAISearch.DataStoreSpec.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
VertexAISearch.DataStoreSpec.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|