com.google.cloud.aiplatform.v1

Class VertexAISearch.DataStoreSpec.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<VertexAISearch.DataStoreSpec.Builder>

com.google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec.Builder

All Implemented Interfaces:

VertexAISearch.DataStoreSpecOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

VertexAISearch.DataStoreSpec

public static final class VertexAISearch.DataStoreSpec.Builder
extends com.google.protobuf.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

Method Summary

Modifier and Type	Method and Description
VertexAISearch.DataStoreSpec.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
VertexAISearch.DataStoreSpec	build()
VertexAISearch.DataStoreSpec	buildPartial()
VertexAISearch.DataStoreSpec.Builder	clear()
VertexAISearch.DataStoreSpec.Builder	clearDataStore() Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` string data_store = 1;
VertexAISearch.DataStoreSpec.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
VertexAISearch.DataStoreSpec.Builder	clearFilter() Optional.
VertexAISearch.DataStoreSpec.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
VertexAISearch.DataStoreSpec.Builder	clone()
String	getDataStore() Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` string data_store = 1;
com.google.protobuf.ByteString	getDataStoreBytes() Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` string data_store = 1;
VertexAISearch.DataStoreSpec	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getFilter() Optional.
com.google.protobuf.ByteString	getFilterBytes() Optional.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
VertexAISearch.DataStoreSpec.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
VertexAISearch.DataStoreSpec.Builder	mergeFrom(com.google.protobuf.Message other)
VertexAISearch.DataStoreSpec.Builder	mergeFrom(VertexAISearch.DataStoreSpec other)
VertexAISearch.DataStoreSpec.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
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;
VertexAISearch.DataStoreSpec.Builder	setDataStoreBytes(com.google.protobuf.ByteString value) Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` string data_store = 1;
VertexAISearch.DataStoreSpec.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
VertexAISearch.DataStoreSpec.Builder	setFilter(String value) Optional.
VertexAISearch.DataStoreSpec.Builder	setFilterBytes(com.google.protobuf.ByteString value) Optional.
VertexAISearch.DataStoreSpec.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
VertexAISearch.DataStoreSpec.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<VertexAISearch.DataStoreSpec.Builder>

clear

public VertexAISearch.DataStoreSpec.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<VertexAISearch.DataStoreSpec.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<VertexAISearch.DataStoreSpec.Builder>

getDefaultInstanceForType

public VertexAISearch.DataStoreSpec getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public VertexAISearch.DataStoreSpec build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public VertexAISearch.DataStoreSpec buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public VertexAISearch.DataStoreSpec.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<VertexAISearch.DataStoreSpec.Builder>

setField

public VertexAISearch.DataStoreSpec.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                     Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<VertexAISearch.DataStoreSpec.Builder>

clearField

public VertexAISearch.DataStoreSpec.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<VertexAISearch.DataStoreSpec.Builder>

clearOneof

public VertexAISearch.DataStoreSpec.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<VertexAISearch.DataStoreSpec.Builder>

setRepeatedField

public VertexAISearch.DataStoreSpec.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                             int index,
                                                             Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<VertexAISearch.DataStoreSpec.Builder>

addRepeatedField

public VertexAISearch.DataStoreSpec.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                             Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<VertexAISearch.DataStoreSpec.Builder>

mergeFrom

public VertexAISearch.DataStoreSpec.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<VertexAISearch.DataStoreSpec.Builder>

mergeFrom

public VertexAISearch.DataStoreSpec.Builder mergeFrom(VertexAISearch.DataStoreSpec other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<VertexAISearch.DataStoreSpec.Builder>

mergeFrom

public VertexAISearch.DataStoreSpec.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<VertexAISearch.DataStoreSpec.Builder>

Throws:

IOException

getDataStore

public String getDataStore()

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

string data_store = 1;

Specified by:

getDataStore in interface VertexAISearch.DataStoreSpecOrBuilder

Returns:

The dataStore.

getDataStoreBytes

public com.google.protobuf.ByteString getDataStoreBytes()

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

string data_store = 1;

Specified by:

getDataStoreBytes in interface VertexAISearch.DataStoreSpecOrBuilder

Returns:

The bytes for dataStore.

setDataStore

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;

Parameters:

value - The dataStore to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

setDataStoreBytes

public VertexAISearch.DataStoreSpec.Builder setDataStoreBytes(com.google.protobuf.ByteString value)

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

string data_store = 1;

Parameters:

value - The bytes for dataStore to set.

Returns:

This builder for chaining.

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](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
 

string filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getFilter in interface VertexAISearch.DataStoreSpecOrBuilder

Returns:

The filter.

getFilterBytes

public com.google.protobuf.ByteString getFilterBytes()

 Optional. Filter specification to filter documents in the data store
 specified by data_store field. For more information on filtering, see
 [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
 

string filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getFilterBytes in interface VertexAISearch.DataStoreSpecOrBuilder

Returns:

The bytes for filter.

setFilter

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](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
 

string filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

value - The filter to set.

Returns:

This builder for chaining.

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](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
 

string filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns:

This builder for chaining.

setFilterBytes

public VertexAISearch.DataStoreSpec.Builder setFilterBytes(com.google.protobuf.ByteString value)

 Optional. Filter specification to filter documents in the data store
 specified by data_store field. For more information on filtering, see
 [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
 

string filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

value - The bytes for filter to set.

Returns:

This builder for chaining.

setUnknownFields

public final VertexAISearch.DataStoreSpec.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<VertexAISearch.DataStoreSpec.Builder>

mergeUnknownFields

public final VertexAISearch.DataStoreSpec.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<VertexAISearch.DataStoreSpec.Builder>