- 0.51.0 (latest)
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public static final class AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec extends GeneratedMessageV3 implements AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpecOrBuilder
Boost applies to suggestions which match a condition.
Protobuf type
google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpecStatic Fields
BOOST_FIELD_NUMBER
public static final int BOOST_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
CONDITION_FIELD_NUMBER
public static final int CONDITION_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
Static Methods
getDefaultInstance()
public static AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec getDefaultInstance()
Returns | |
---|---|
Type | Description |
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder newBuilder()
Returns | |
---|---|
Type | Description |
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder |
newBuilder(AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec prototype)
public static AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder newBuilder(AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec prototype)
Parameter | |
---|---|
Name | Description |
prototype |
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec |
Returns | |
---|---|
Type | Description |
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder |
parseDelimitedFrom(InputStream input)
public static AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data |
byte[] |
Returns | |
---|---|
Type | Description |
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data |
ByteString |
Returns | |
---|---|
Type | Description |
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input |
CodedInputStream |
Returns | |
---|---|
Type | Description |
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data |
ByteBuffer |
Returns | |
---|---|
Type | Description |
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec> parser()
Returns | |
---|---|
Type | Description |
Parser<ConditionBoostSpec> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj |
Object |
Returns | |
---|---|
Type | Description |
boolean |
getBoost()
public float getBoost()
Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0.
Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion.
Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown.
Setting to 0.0 means no boost applied. The boosting condition is ignored.
float boost = 2;
Returns | |
---|---|
Type | Description |
float |
The boost. |
getCondition()
public String getCondition()
An expression which specifies a boost condition. The syntax is the same as filter expression syntax. Currently, the only supported condition is a list of BCP-47 lang codes.
Example:
- To boost suggestions in languages
en
orfr
:(lang_code: ANY("en", "fr"))
string condition = 1;
Returns | |
---|---|
Type | Description |
String |
The condition. |
getConditionBytes()
public ByteString getConditionBytes()
An expression which specifies a boost condition. The syntax is the same as filter expression syntax. Currently, the only supported condition is a list of BCP-47 lang codes.
Example:
- To boost suggestions in languages
en
orfr
:(lang_code: ANY("en", "fr"))
string condition = 1;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for condition. |
getDefaultInstanceForType()
public AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec |
getParserForType()
public Parser<AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<ConditionBoostSpec> |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent |
BuilderParent |
Returns | |
---|---|
Type | Description |
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused |
UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder toBuilder()
Returns | |
---|---|
Type | Description |
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output |
CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |