Class VertexAISearch.DataStoreSpec.Builder (3.68.0)

public static final class VertexAISearch.DataStoreSpec.Builder extends GeneratedMessageV3.Builder<VertexAISearch.DataStoreSpec.Builder> implements VertexAISearch.DataStoreSpecOrBuilder

Define 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.aiplatform.v1.VertexAISearch.DataStoreSpec

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public VertexAISearch.DataStoreSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
VertexAISearch.DataStoreSpec.Builder
Overrides

build()

public VertexAISearch.DataStoreSpec build()
Returns
Type Description
VertexAISearch.DataStoreSpec

buildPartial()

public VertexAISearch.DataStoreSpec buildPartial()
Returns
Type Description
VertexAISearch.DataStoreSpec

clear()

public VertexAISearch.DataStoreSpec.Builder clear()
Returns
Type Description
VertexAISearch.DataStoreSpec.Builder
Overrides

clearDataStore()

public VertexAISearch.DataStoreSpec.Builder clearDataStore()

Full resource name of DataStore, such as Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}

string data_store = 1;

Returns
Type Description
VertexAISearch.DataStoreSpec.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public VertexAISearch.DataStoreSpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
VertexAISearch.DataStoreSpec.Builder
Overrides

clearFilter()

public VertexAISearch.DataStoreSpec.Builder clearFilter()

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
VertexAISearch.DataStoreSpec.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public VertexAISearch.DataStoreSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
VertexAISearch.DataStoreSpec.Builder
Overrides

clone()

public VertexAISearch.DataStoreSpec.Builder clone()
Returns
Type Description
VertexAISearch.DataStoreSpec.Builder
Overrides

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(VertexAISearch.DataStoreSpec other)

public VertexAISearch.DataStoreSpec.Builder mergeFrom(VertexAISearch.DataStoreSpec other)
Parameter
Name Description
other VertexAISearch.DataStoreSpec
Returns
Type Description
VertexAISearch.DataStoreSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public VertexAISearch.DataStoreSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VertexAISearch.DataStoreSpec.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public VertexAISearch.DataStoreSpec.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
VertexAISearch.DataStoreSpec.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final VertexAISearch.DataStoreSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
VertexAISearch.DataStoreSpec.Builder
Overrides

setDataStore(String value)

public VertexAISearch.DataStoreSpec.Builder setDataStore(String value)

Full resource name of DataStore, such as Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}

string data_store = 1;

Parameter
Name Description
value String

The dataStore to set.

Returns
Type Description
VertexAISearch.DataStoreSpec.Builder

This builder for chaining.

setDataStoreBytes(ByteString value)

public VertexAISearch.DataStoreSpec.Builder setDataStoreBytes(ByteString value)

Full resource name of DataStore, such as Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}

string data_store = 1;

Parameter
Name Description
value ByteString

The bytes for dataStore to set.

Returns
Type Description
VertexAISearch.DataStoreSpec.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public VertexAISearch.DataStoreSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
VertexAISearch.DataStoreSpec.Builder
Overrides

setFilter(String value)

public VertexAISearch.DataStoreSpec.Builder setFilter(String value)

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];

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
VertexAISearch.DataStoreSpec.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public VertexAISearch.DataStoreSpec.Builder setFilterBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
VertexAISearch.DataStoreSpec.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public VertexAISearch.DataStoreSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
VertexAISearch.DataStoreSpec.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final VertexAISearch.DataStoreSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
VertexAISearch.DataStoreSpec.Builder
Overrides