Class DataStoreTool.BoostSpecs (0.1.0)

public static final class DataStoreTool.BoostSpecs extends GeneratedMessage 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 Fields

DATA_STORES_FIELD_NUMBER

public static final int DATA_STORES_FIELD_NUMBER
Field Value
Type Description
int

SPEC_FIELD_NUMBER

public static final int SPEC_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DataStoreTool.BoostSpecs getDefaultInstance()
Returns
Type Description
DataStoreTool.BoostSpecs

getDescriptor()

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

newBuilder()

public static DataStoreTool.BoostSpecs.Builder newBuilder()
Returns
Type Description
DataStoreTool.BoostSpecs.Builder

newBuilder(DataStoreTool.BoostSpecs prototype)

public static DataStoreTool.BoostSpecs.Builder newBuilder(DataStoreTool.BoostSpecs prototype)
Parameter
Name Description
prototype DataStoreTool.BoostSpecs
Returns
Type Description
DataStoreTool.BoostSpecs.Builder

parseDelimitedFrom(InputStream input)

public static DataStoreTool.BoostSpecs parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DataStoreTool.BoostSpecs
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataStoreTool.BoostSpecs parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataStoreTool.BoostSpecs
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DataStoreTool.BoostSpecs parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DataStoreTool.BoostSpecs
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DataStoreTool.BoostSpecs parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataStoreTool.BoostSpecs
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DataStoreTool.BoostSpecs parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DataStoreTool.BoostSpecs
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DataStoreTool.BoostSpecs parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataStoreTool.BoostSpecs
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DataStoreTool.BoostSpecs parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DataStoreTool.BoostSpecs
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DataStoreTool.BoostSpecs parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataStoreTool.BoostSpecs
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DataStoreTool.BoostSpecs parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DataStoreTool.BoostSpecs
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataStoreTool.BoostSpecs parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataStoreTool.BoostSpecs
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DataStoreTool.BoostSpecs parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DataStoreTool.BoostSpecs
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DataStoreTool.BoostSpecs parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataStoreTool.BoostSpecs
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DataStoreTool.BoostSpecs> parser()
Returns
Type Description
Parser<BoostSpecs>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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

getParserForType()

public Parser<DataStoreTool.BoostSpecs> getParserForType()
Returns
Type Description
Parser<BoostSpecs>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
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

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>

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public DataStoreTool.BoostSpecs.Builder newBuilderForType()
Returns
Type Description
DataStoreTool.BoostSpecs.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected DataStoreTool.BoostSpecs.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DataStoreTool.BoostSpecs.Builder
Overrides

toBuilder()

public DataStoreTool.BoostSpecs.Builder toBuilder()
Returns
Type Description
DataStoreTool.BoostSpecs.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException