Interface DataStoreToolOrBuilder (0.3.0)

public interface DataStoreToolOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBoostSpecs(int index)

public abstract DataStoreTool.BoostSpecs getBoostSpecs(int index)

Optional. Boost specification to boost certain documents.

repeated .google.cloud.ces.v1beta.DataStoreTool.BoostSpecs boost_specs = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
DataStoreTool.BoostSpecs

getBoostSpecsCount()

public abstract int getBoostSpecsCount()

Optional. Boost specification to boost certain documents.

repeated .google.cloud.ces.v1beta.DataStoreTool.BoostSpecs boost_specs = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getBoostSpecsList()

public abstract List<DataStoreTool.BoostSpecs> getBoostSpecsList()

Optional. Boost specification to boost certain documents.

repeated .google.cloud.ces.v1beta.DataStoreTool.BoostSpecs boost_specs = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<BoostSpecs>

getBoostSpecsOrBuilder(int index)

public abstract DataStoreTool.BoostSpecsOrBuilder getBoostSpecsOrBuilder(int index)

Optional. Boost specification to boost certain documents.

repeated .google.cloud.ces.v1beta.DataStoreTool.BoostSpecs boost_specs = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
DataStoreTool.BoostSpecsOrBuilder

getBoostSpecsOrBuilderList()

public abstract List<? extends DataStoreTool.BoostSpecsOrBuilder> getBoostSpecsOrBuilderList()

Optional. Boost specification to boost certain documents.

repeated .google.cloud.ces.v1beta.DataStoreTool.BoostSpecs boost_specs = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.ces.v1beta.DataStoreTool.BoostSpecsOrBuilder>

getDataStoreSource()

public abstract DataStoreTool.DataStoreSource getDataStoreSource()

Optional. Search within a single specific DataStore.

.google.cloud.ces.v1beta.DataStoreTool.DataStoreSource data_store_source = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataStoreTool.DataStoreSource

The dataStoreSource.

getDataStoreSourceOrBuilder()

public abstract DataStoreTool.DataStoreSourceOrBuilder getDataStoreSourceOrBuilder()

Optional. Search within a single specific DataStore.

.google.cloud.ces.v1beta.DataStoreTool.DataStoreSource data_store_source = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataStoreTool.DataStoreSourceOrBuilder

getDescription()

public abstract String getDescription()

Optional. The tool description.

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

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Optional. The tool description.

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

Returns
Type Description
ByteString

The bytes for description.

getEngineSource()

public abstract DataStoreTool.EngineSource getEngineSource()

Optional. Search within an Engine (potentially across multiple DataStores).

.google.cloud.ces.v1beta.DataStoreTool.EngineSource engine_source = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataStoreTool.EngineSource

The engineSource.

getEngineSourceOrBuilder()

public abstract DataStoreTool.EngineSourceOrBuilder getEngineSourceOrBuilder()

Optional. Search within an Engine (potentially across multiple DataStores).

.google.cloud.ces.v1beta.DataStoreTool.EngineSource engine_source = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataStoreTool.EngineSourceOrBuilder

getFilterParameterBehavior()

public abstract DataStoreTool.FilterParameterBehavior getFilterParameterBehavior()

Optional. The filter parameter behavior.

.google.cloud.ces.v1beta.DataStoreTool.FilterParameterBehavior filter_parameter_behavior = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataStoreTool.FilterParameterBehavior

The filterParameterBehavior.

getFilterParameterBehaviorValue()

public abstract int getFilterParameterBehaviorValue()

Optional. The filter parameter behavior.

.google.cloud.ces.v1beta.DataStoreTool.FilterParameterBehavior filter_parameter_behavior = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for filterParameterBehavior.

getModalityConfigs(int index)

public abstract DataStoreTool.ModalityConfig getModalityConfigs(int index)

Optional. The modality configs for the data store.

repeated .google.cloud.ces.v1beta.DataStoreTool.ModalityConfig modality_configs = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
DataStoreTool.ModalityConfig

getModalityConfigsCount()

public abstract int getModalityConfigsCount()

Optional. The modality configs for the data store.

repeated .google.cloud.ces.v1beta.DataStoreTool.ModalityConfig modality_configs = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getModalityConfigsList()

public abstract List<DataStoreTool.ModalityConfig> getModalityConfigsList()

Optional. The modality configs for the data store.

repeated .google.cloud.ces.v1beta.DataStoreTool.ModalityConfig modality_configs = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<ModalityConfig>

getModalityConfigsOrBuilder(int index)

public abstract DataStoreTool.ModalityConfigOrBuilder getModalityConfigsOrBuilder(int index)

Optional. The modality configs for the data store.

repeated .google.cloud.ces.v1beta.DataStoreTool.ModalityConfig modality_configs = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
DataStoreTool.ModalityConfigOrBuilder

getModalityConfigsOrBuilderList()

public abstract List<? extends DataStoreTool.ModalityConfigOrBuilder> getModalityConfigsOrBuilderList()

Optional. The modality configs for the data store.

repeated .google.cloud.ces.v1beta.DataStoreTool.ModalityConfig modality_configs = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.ces.v1beta.DataStoreTool.ModalityConfigOrBuilder>

getName()

public abstract String getName()

Required. The data store tool name.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Required. The data store tool name.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for name.

getSearchSourceCase()

public abstract DataStoreTool.SearchSourceCase getSearchSourceCase()
Returns
Type Description
DataStoreTool.SearchSourceCase

hasDataStoreSource()

public abstract boolean hasDataStoreSource()

Optional. Search within a single specific DataStore.

.google.cloud.ces.v1beta.DataStoreTool.DataStoreSource data_store_source = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the dataStoreSource field is set.

hasEngineSource()

public abstract boolean hasEngineSource()

Optional. Search within an Engine (potentially across multiple DataStores).

.google.cloud.ces.v1beta.DataStoreTool.EngineSource engine_source = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the engineSource field is set.