Class DataStoreTool.BoostSpecs.Builder (0.1.0)

public static final class DataStoreTool.BoostSpecs.Builder extends GeneratedMessage.Builder<DataStoreTool.BoostSpecs.Builder> implements DataStoreTool.BoostSpecsOrBuilder

Boost specifications to boost certain documents. For more information, please refer to https://cloud.google.com/generative-ai-app-builder/docs/boosting.

Protobuf type google.cloud.ces.v1.DataStoreTool.BoostSpecs

Static Methods

getDescriptor()

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

Methods

addAllDataStores(Iterable<String> values)

public DataStoreTool.BoostSpecs.Builder addAllDataStores(Iterable<String> values)

Required. The Data Store where the boosting configuration is applied. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.

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

Parameter
Name Description
values Iterable<String>

The dataStores to add.

Returns
Type Description
DataStoreTool.BoostSpecs.Builder

This builder for chaining.

addAllSpec(Iterable<? extends DataStoreTool.BoostSpec> values)

public DataStoreTool.BoostSpecs.Builder addAllSpec(Iterable<? extends DataStoreTool.BoostSpec> values)

Required. A list of boosting specifications.

repeated .google.cloud.ces.v1.DataStoreTool.BoostSpec spec = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
values Iterable<? extends com.google.cloud.ces.v1.DataStoreTool.BoostSpec>
Returns
Type Description
DataStoreTool.BoostSpecs.Builder

addDataStores(String value)

public DataStoreTool.BoostSpecs.Builder addDataStores(String value)

Required. The Data Store where the boosting configuration is applied. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.

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

Parameter
Name Description
value String

The dataStores to add.

Returns
Type Description
DataStoreTool.BoostSpecs.Builder

This builder for chaining.

addDataStoresBytes(ByteString value)

public DataStoreTool.BoostSpecs.Builder addDataStoresBytes(ByteString value)

Required. The Data Store where the boosting configuration is applied. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.

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

Parameter
Name Description
value ByteString

The bytes of the dataStores to add.

Returns
Type Description
DataStoreTool.BoostSpecs.Builder

This builder for chaining.

addSpec(DataStoreTool.BoostSpec value)

public DataStoreTool.BoostSpecs.Builder addSpec(DataStoreTool.BoostSpec value)

Required. A list of boosting specifications.

repeated .google.cloud.ces.v1.DataStoreTool.BoostSpec spec = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value DataStoreTool.BoostSpec
Returns
Type Description
DataStoreTool.BoostSpecs.Builder

addSpec(DataStoreTool.BoostSpec.Builder builderForValue)

public DataStoreTool.BoostSpecs.Builder addSpec(DataStoreTool.BoostSpec.Builder builderForValue)

Required. A list of boosting specifications.

repeated .google.cloud.ces.v1.DataStoreTool.BoostSpec spec = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue DataStoreTool.BoostSpec.Builder
Returns
Type Description
DataStoreTool.BoostSpecs.Builder

addSpec(int index, DataStoreTool.BoostSpec value)

public DataStoreTool.BoostSpecs.Builder addSpec(int index, DataStoreTool.BoostSpec value)

Required. A list of boosting specifications.

repeated .google.cloud.ces.v1.DataStoreTool.BoostSpec spec = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
value DataStoreTool.BoostSpec
Returns
Type Description
DataStoreTool.BoostSpecs.Builder

addSpec(int index, DataStoreTool.BoostSpec.Builder builderForValue)

public DataStoreTool.BoostSpecs.Builder addSpec(int index, DataStoreTool.BoostSpec.Builder builderForValue)

Required. A list of boosting specifications.

repeated .google.cloud.ces.v1.DataStoreTool.BoostSpec spec = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
builderForValue DataStoreTool.BoostSpec.Builder
Returns
Type Description
DataStoreTool.BoostSpecs.Builder

addSpecBuilder()

public DataStoreTool.BoostSpec.Builder addSpecBuilder()

Required. A list of boosting specifications.

repeated .google.cloud.ces.v1.DataStoreTool.BoostSpec spec = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DataStoreTool.BoostSpec.Builder

addSpecBuilder(int index)

public DataStoreTool.BoostSpec.Builder addSpecBuilder(int index)

Required. A list of boosting specifications.

repeated .google.cloud.ces.v1.DataStoreTool.BoostSpec spec = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
DataStoreTool.BoostSpec.Builder

build()

public DataStoreTool.BoostSpecs build()
Returns
Type Description
DataStoreTool.BoostSpecs

buildPartial()

public DataStoreTool.BoostSpecs buildPartial()
Returns
Type Description
DataStoreTool.BoostSpecs

clear()

public DataStoreTool.BoostSpecs.Builder clear()
Returns
Type Description
DataStoreTool.BoostSpecs.Builder
Overrides

clearDataStores()

public DataStoreTool.BoostSpecs.Builder clearDataStores()

Required. The Data Store where the boosting configuration is applied. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.

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

Returns
Type Description
DataStoreTool.BoostSpecs.Builder

This builder for chaining.

clearSpec()

public DataStoreTool.BoostSpecs.Builder clearSpec()

Required. A list of boosting specifications.

repeated .google.cloud.ces.v1.DataStoreTool.BoostSpec spec = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DataStoreTool.BoostSpecs.Builder

getDataStores(int index)

public String getDataStores(int index)

Required. The Data Store where the boosting configuration is applied. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.

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

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The dataStores at the given index.

getDataStoresBytes(int index)

public ByteString getDataStoresBytes(int index)

Required. The Data Store where the boosting configuration is applied. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.

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

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the dataStores at the given index.

getDataStoresCount()

public int getDataStoresCount()

Required. The Data Store where the boosting configuration is applied. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.

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

Returns
Type Description
int

The count of dataStores.

getDataStoresList()

public ProtocolStringList getDataStoresList()

Required. The Data Store where the boosting configuration is applied. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.

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

Returns
Type Description
ProtocolStringList

A list containing the dataStores.

getDefaultInstanceForType()

public DataStoreTool.BoostSpecs getDefaultInstanceForType()
Returns
Type Description
DataStoreTool.BoostSpecs

getDescriptorForType()

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

getSpec(int index)

public DataStoreTool.BoostSpec getSpec(int index)

Required. A list of boosting specifications.

repeated .google.cloud.ces.v1.DataStoreTool.BoostSpec spec = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
DataStoreTool.BoostSpec

getSpecBuilder(int index)

public DataStoreTool.BoostSpec.Builder getSpecBuilder(int index)

Required. A list of boosting specifications.

repeated .google.cloud.ces.v1.DataStoreTool.BoostSpec spec = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
DataStoreTool.BoostSpec.Builder

getSpecBuilderList()

public List<DataStoreTool.BoostSpec.Builder> getSpecBuilderList()

Required. A list of boosting specifications.

repeated .google.cloud.ces.v1.DataStoreTool.BoostSpec spec = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Builder>

getSpecCount()

public int getSpecCount()

Required. A list of boosting specifications.

repeated .google.cloud.ces.v1.DataStoreTool.BoostSpec spec = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getSpecList()

public List<DataStoreTool.BoostSpec> getSpecList()

Required. A list of boosting specifications.

repeated .google.cloud.ces.v1.DataStoreTool.BoostSpec spec = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<BoostSpec>

getSpecOrBuilder(int index)

public DataStoreTool.BoostSpecOrBuilder getSpecOrBuilder(int index)

Required. A list of boosting specifications.

repeated .google.cloud.ces.v1.DataStoreTool.BoostSpec spec = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
DataStoreTool.BoostSpecOrBuilder

getSpecOrBuilderList()

public List<? extends DataStoreTool.BoostSpecOrBuilder> getSpecOrBuilderList()

Required. A list of boosting specifications.

repeated .google.cloud.ces.v1.DataStoreTool.BoostSpec spec = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<? extends com.google.cloud.ces.v1.DataStoreTool.BoostSpecOrBuilder>

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(DataStoreTool.BoostSpecs other)

public DataStoreTool.BoostSpecs.Builder mergeFrom(DataStoreTool.BoostSpecs other)
Parameter
Name Description
other DataStoreTool.BoostSpecs
Returns
Type Description
DataStoreTool.BoostSpecs.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

public DataStoreTool.BoostSpecs.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
DataStoreTool.BoostSpecs.Builder
Overrides

removeSpec(int index)

public DataStoreTool.BoostSpecs.Builder removeSpec(int index)

Required. A list of boosting specifications.

repeated .google.cloud.ces.v1.DataStoreTool.BoostSpec spec = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
DataStoreTool.BoostSpecs.Builder

setDataStores(int index, String value)

public DataStoreTool.BoostSpecs.Builder setDataStores(int index, String value)

Required. The Data Store where the boosting configuration is applied. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.

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

Parameters
Name Description
index int

The index to set the value at.

value String

The dataStores to set.

Returns
Type Description
DataStoreTool.BoostSpecs.Builder

This builder for chaining.

setSpec(int index, DataStoreTool.BoostSpec value)

public DataStoreTool.BoostSpecs.Builder setSpec(int index, DataStoreTool.BoostSpec value)

Required. A list of boosting specifications.

repeated .google.cloud.ces.v1.DataStoreTool.BoostSpec spec = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
value DataStoreTool.BoostSpec
Returns
Type Description
DataStoreTool.BoostSpecs.Builder

setSpec(int index, DataStoreTool.BoostSpec.Builder builderForValue)

public DataStoreTool.BoostSpecs.Builder setSpec(int index, DataStoreTool.BoostSpec.Builder builderForValue)

Required. A list of boosting specifications.

repeated .google.cloud.ces.v1.DataStoreTool.BoostSpec spec = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
builderForValue DataStoreTool.BoostSpec.Builder
Returns
Type Description
DataStoreTool.BoostSpecs.Builder