public static final class DataStoreTool.EngineSource.Builder extends GeneratedMessage.Builder<DataStoreTool.EngineSource.Builder> implements DataStoreTool.EngineSourceOrBuilderConfiguration for searching within an Engine, potentially targeting specific DataStores.
Protobuf type google.cloud.ces.v1.DataStoreTool.EngineSource
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > DataStoreTool.EngineSource.BuilderImplements
DataStoreTool.EngineSourceOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllDataStoreSources(Iterable<? extends DataStoreTool.DataStoreSource> values)
public DataStoreTool.EngineSource.Builder addAllDataStoreSources(Iterable<? extends DataStoreTool.DataStoreSource> values)Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.
repeated .google.cloud.ces.v1.DataStoreTool.DataStoreSource data_store_sources = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.ces.v1.DataStoreTool.DataStoreSource> |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.EngineSource.Builder |
|
addDataStoreSources(DataStoreTool.DataStoreSource value)
public DataStoreTool.EngineSource.Builder addDataStoreSources(DataStoreTool.DataStoreSource value)Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.
repeated .google.cloud.ces.v1.DataStoreTool.DataStoreSource data_store_sources = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
DataStoreTool.DataStoreSource |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.EngineSource.Builder |
|
addDataStoreSources(DataStoreTool.DataStoreSource.Builder builderForValue)
public DataStoreTool.EngineSource.Builder addDataStoreSources(DataStoreTool.DataStoreSource.Builder builderForValue)Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.
repeated .google.cloud.ces.v1.DataStoreTool.DataStoreSource data_store_sources = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
DataStoreTool.DataStoreSource.Builder |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.EngineSource.Builder |
|
addDataStoreSources(int index, DataStoreTool.DataStoreSource value)
public DataStoreTool.EngineSource.Builder addDataStoreSources(int index, DataStoreTool.DataStoreSource value)Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.
repeated .google.cloud.ces.v1.DataStoreTool.DataStoreSource data_store_sources = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
DataStoreTool.DataStoreSource |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.EngineSource.Builder |
|
addDataStoreSources(int index, DataStoreTool.DataStoreSource.Builder builderForValue)
public DataStoreTool.EngineSource.Builder addDataStoreSources(int index, DataStoreTool.DataStoreSource.Builder builderForValue)Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.
repeated .google.cloud.ces.v1.DataStoreTool.DataStoreSource data_store_sources = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
DataStoreTool.DataStoreSource.Builder |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.EngineSource.Builder |
|
addDataStoreSourcesBuilder()
public DataStoreTool.DataStoreSource.Builder addDataStoreSourcesBuilder()Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.
repeated .google.cloud.ces.v1.DataStoreTool.DataStoreSource data_store_sources = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.DataStoreSource.Builder |
|
addDataStoreSourcesBuilder(int index)
public DataStoreTool.DataStoreSource.Builder addDataStoreSourcesBuilder(int index)Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.
repeated .google.cloud.ces.v1.DataStoreTool.DataStoreSource data_store_sources = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.DataStoreSource.Builder |
|
build()
public DataStoreTool.EngineSource build()| Returns | |
|---|---|
| Type | Description |
DataStoreTool.EngineSource |
|
buildPartial()
public DataStoreTool.EngineSource buildPartial()| Returns | |
|---|---|
| Type | Description |
DataStoreTool.EngineSource |
|
clear()
public DataStoreTool.EngineSource.Builder clear()| Returns | |
|---|---|
| Type | Description |
DataStoreTool.EngineSource.Builder |
|
clearDataStoreSources()
public DataStoreTool.EngineSource.Builder clearDataStoreSources()Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.
repeated .google.cloud.ces.v1.DataStoreTool.DataStoreSource data_store_sources = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.EngineSource.Builder |
|
clearEngine()
public DataStoreTool.EngineSource.Builder clearEngine() Required. Full resource name of the Engine.
Format:
projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
string engine = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.EngineSource.Builder |
This builder for chaining. |
clearFilter()
public DataStoreTool.EngineSource.Builder clearFilter()Optional. A filter applied to the search across the Engine. Not relevant and not used if 'data_store_sources' is provided. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
string filter = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.EngineSource.Builder |
This builder for chaining. |
getDataStoreSources(int index)
public DataStoreTool.DataStoreSource getDataStoreSources(int index)Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.
repeated .google.cloud.ces.v1.DataStoreTool.DataStoreSource data_store_sources = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.DataStoreSource |
|
getDataStoreSourcesBuilder(int index)
public DataStoreTool.DataStoreSource.Builder getDataStoreSourcesBuilder(int index)Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.
repeated .google.cloud.ces.v1.DataStoreTool.DataStoreSource data_store_sources = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.DataStoreSource.Builder |
|
getDataStoreSourcesBuilderList()
public List<DataStoreTool.DataStoreSource.Builder> getDataStoreSourcesBuilderList()Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.
repeated .google.cloud.ces.v1.DataStoreTool.DataStoreSource data_store_sources = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getDataStoreSourcesCount()
public int getDataStoreSourcesCount()Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.
repeated .google.cloud.ces.v1.DataStoreTool.DataStoreSource data_store_sources = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getDataStoreSourcesList()
public List<DataStoreTool.DataStoreSource> getDataStoreSourcesList()Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.
repeated .google.cloud.ces.v1.DataStoreTool.DataStoreSource data_store_sources = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<DataStoreSource> |
|
getDataStoreSourcesOrBuilder(int index)
public DataStoreTool.DataStoreSourceOrBuilder getDataStoreSourcesOrBuilder(int index)Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.
repeated .google.cloud.ces.v1.DataStoreTool.DataStoreSource data_store_sources = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.DataStoreSourceOrBuilder |
|
getDataStoreSourcesOrBuilderList()
public List<? extends DataStoreTool.DataStoreSourceOrBuilder> getDataStoreSourcesOrBuilderList()Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.
repeated .google.cloud.ces.v1.DataStoreTool.DataStoreSource data_store_sources = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.ces.v1.DataStoreTool.DataStoreSourceOrBuilder> |
|
getDefaultInstanceForType()
public DataStoreTool.EngineSource getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
DataStoreTool.EngineSource |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getEngine()
public String getEngine() Required. Full resource name of the Engine.
Format:
projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
string engine = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The engine. |
getEngineBytes()
public ByteString getEngineBytes() Required. Full resource name of the Engine.
Format:
projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
string engine = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for engine. |
getFilter()
public String getFilter()Optional. A filter applied to the search across the Engine. Not relevant and not used if 'data_store_sources' is provided. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
string filter = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The filter. |
getFilterBytes()
public ByteString getFilterBytes()Optional. A filter applied to the search across the Engine. Not relevant and not used if 'data_store_sources' is provided. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
string filter = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for filter. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(DataStoreTool.EngineSource other)
public DataStoreTool.EngineSource.Builder mergeFrom(DataStoreTool.EngineSource other)| Parameter | |
|---|---|
| Name | Description |
other |
DataStoreTool.EngineSource |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.EngineSource.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public DataStoreTool.EngineSource.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.EngineSource.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public DataStoreTool.EngineSource.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.EngineSource.Builder |
|
removeDataStoreSources(int index)
public DataStoreTool.EngineSource.Builder removeDataStoreSources(int index)Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.
repeated .google.cloud.ces.v1.DataStoreTool.DataStoreSource data_store_sources = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.EngineSource.Builder |
|
setDataStoreSources(int index, DataStoreTool.DataStoreSource value)
public DataStoreTool.EngineSource.Builder setDataStoreSources(int index, DataStoreTool.DataStoreSource value)Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.
repeated .google.cloud.ces.v1.DataStoreTool.DataStoreSource data_store_sources = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
DataStoreTool.DataStoreSource |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.EngineSource.Builder |
|
setDataStoreSources(int index, DataStoreTool.DataStoreSource.Builder builderForValue)
public DataStoreTool.EngineSource.Builder setDataStoreSources(int index, DataStoreTool.DataStoreSource.Builder builderForValue)Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.
repeated .google.cloud.ces.v1.DataStoreTool.DataStoreSource data_store_sources = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
DataStoreTool.DataStoreSource.Builder |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.EngineSource.Builder |
|
setEngine(String value)
public DataStoreTool.EngineSource.Builder setEngine(String value) Required. Full resource name of the Engine.
Format:
projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
string engine = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe engine to set. |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.EngineSource.Builder |
This builder for chaining. |
setEngineBytes(ByteString value)
public DataStoreTool.EngineSource.Builder setEngineBytes(ByteString value) Required. Full resource name of the Engine.
Format:
projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
string engine = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for engine to set. |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.EngineSource.Builder |
This builder for chaining. |
setFilter(String value)
public DataStoreTool.EngineSource.Builder setFilter(String value)Optional. A filter applied to the search across the Engine. Not relevant and not used if 'data_store_sources' is provided. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
string filter = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe filter to set. |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.EngineSource.Builder |
This builder for chaining. |
setFilterBytes(ByteString value)
public DataStoreTool.EngineSource.Builder setFilterBytes(ByteString value)Optional. A filter applied to the search across the Engine. Not relevant and not used if 'data_store_sources' is provided. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
string filter = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for filter to set. |
| Returns | |
|---|---|
| Type | Description |
DataStoreTool.EngineSource.Builder |
This builder for chaining. |