public static final class AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec extends GeneratedMessage implements AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpecOrBuilderBoost applies to suggestions which match a condition.
Protobuf type
google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > 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
enorfr:(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
enorfr:(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 GeneratedMessage.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(AbstractMessage.BuilderParent parent)
protected AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder newBuilderForType(AbstractMessage.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec.Builder |
|
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 |
|