Class BoostSpec (0.48.0)

public final class BoostSpec extends GeneratedMessageV3 implements BoostSpecOrBuilder

Boost specification to boost certain documents. A copy of google.cloud.discoveryengine.v1main.BoostSpec, field documentation is available at https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec

Protobuf type google.cloud.dialogflow.cx.v3.BoostSpec

Implements

BoostSpecOrBuilder

Static Fields

CONDITION_BOOST_SPECS_FIELD_NUMBER

public static final int CONDITION_BOOST_SPECS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BoostSpec getDefaultInstance()
Returns
Type Description
BoostSpec

getDescriptor()

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

newBuilder()

public static BoostSpec.Builder newBuilder()
Returns
Type Description
BoostSpec.Builder

newBuilder(BoostSpec prototype)

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

parseDelimitedFrom(InputStream input)

public static BoostSpec parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BoostSpec
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static BoostSpec parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
BoostSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static BoostSpec parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
BoostSpec
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static BoostSpec parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BoostSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static BoostSpec parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
BoostSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<BoostSpec> parser()
Returns
Type Description
Parser<BoostSpec>

Methods

equals(Object obj)

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

getConditionBoostSpecs(int index)

public BoostSpec.ConditionBoostSpec getConditionBoostSpecs(int index)

Optional. Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.

repeated .google.cloud.dialogflow.cx.v3.BoostSpec.ConditionBoostSpec condition_boost_specs = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
BoostSpec.ConditionBoostSpec

getConditionBoostSpecsCount()

public int getConditionBoostSpecsCount()

Optional. Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.

repeated .google.cloud.dialogflow.cx.v3.BoostSpec.ConditionBoostSpec condition_boost_specs = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getConditionBoostSpecsList()

public List<BoostSpec.ConditionBoostSpec> getConditionBoostSpecsList()

Optional. Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.

repeated .google.cloud.dialogflow.cx.v3.BoostSpec.ConditionBoostSpec condition_boost_specs = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<ConditionBoostSpec>

getConditionBoostSpecsOrBuilder(int index)

public BoostSpec.ConditionBoostSpecOrBuilder getConditionBoostSpecsOrBuilder(int index)

Optional. Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.

repeated .google.cloud.dialogflow.cx.v3.BoostSpec.ConditionBoostSpec condition_boost_specs = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
BoostSpec.ConditionBoostSpecOrBuilder

getConditionBoostSpecsOrBuilderList()

public List<? extends BoostSpec.ConditionBoostSpecOrBuilder> getConditionBoostSpecsOrBuilderList()

Optional. Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.

repeated .google.cloud.dialogflow.cx.v3.BoostSpec.ConditionBoostSpec condition_boost_specs = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.dialogflow.cx.v3.BoostSpec.ConditionBoostSpecOrBuilder>

getDefaultInstanceForType()

public BoostSpec getDefaultInstanceForType()
Returns
Type Description
BoostSpec

getParserForType()

public Parser<BoostSpec> getParserForType()
Returns
Type Description
Parser<BoostSpec>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public BoostSpec.Builder newBuilderForType()
Returns
Type Description
BoostSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BoostSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
BoostSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public BoostSpec.Builder toBuilder()
Returns
Type Description
BoostSpec.Builder

writeTo(CodedOutputStream output)

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