Class DataStoreTool.BoostSpec.ConditionBoostSpec (0.1.0)

public static final class DataStoreTool.BoostSpec.ConditionBoostSpec extends GeneratedMessage implements DataStoreTool.BoostSpec.ConditionBoostSpecOrBuilder

Boost specification for a condition.

Protobuf type google.cloud.ces.v1.DataStoreTool.BoostSpec.ConditionBoostSpec

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > DataStoreTool.BoostSpec.ConditionBoostSpec

Implements

DataStoreTool.BoostSpec.ConditionBoostSpecOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

BOOST_CONTROL_SPEC_FIELD_NUMBER

public static final int BOOST_CONTROL_SPEC_FIELD_NUMBER

Field Value
Type	Description
int

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 DataStoreTool.BoostSpec.ConditionBoostSpec getDefaultInstance()

Returns
Type	Description
DataStoreTool.BoostSpec.ConditionBoostSpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static DataStoreTool.BoostSpec.ConditionBoostSpec.Builder newBuilder()

Returns
Type	Description
DataStoreTool.BoostSpec.ConditionBoostSpec.Builder

newBuilder(DataStoreTool.BoostSpec.ConditionBoostSpec prototype)

public static DataStoreTool.BoostSpec.ConditionBoostSpec.Builder newBuilder(DataStoreTool.BoostSpec.ConditionBoostSpec prototype)

Parameter
Name	Description
prototype	DataStoreTool.BoostSpec.ConditionBoostSpec

Returns
Type	Description
DataStoreTool.BoostSpec.ConditionBoostSpec.Builder

parseDelimitedFrom(InputStream input)

public static DataStoreTool.BoostSpec.ConditionBoostSpec parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
DataStoreTool.BoostSpec.ConditionBoostSpec

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataStoreTool.BoostSpec.ConditionBoostSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DataStoreTool.BoostSpec.ConditionBoostSpec

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static DataStoreTool.BoostSpec.ConditionBoostSpec parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
DataStoreTool.BoostSpec.ConditionBoostSpec

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DataStoreTool.BoostSpec.ConditionBoostSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DataStoreTool.BoostSpec.ConditionBoostSpec

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DataStoreTool.BoostSpec.ConditionBoostSpec parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
DataStoreTool.BoostSpec.ConditionBoostSpec

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DataStoreTool.BoostSpec.ConditionBoostSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DataStoreTool.BoostSpec.ConditionBoostSpec

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DataStoreTool.BoostSpec.ConditionBoostSpec parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
DataStoreTool.BoostSpec.ConditionBoostSpec

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DataStoreTool.BoostSpec.ConditionBoostSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DataStoreTool.BoostSpec.ConditionBoostSpec

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static DataStoreTool.BoostSpec.ConditionBoostSpec parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
DataStoreTool.BoostSpec.ConditionBoostSpec

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataStoreTool.BoostSpec.ConditionBoostSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DataStoreTool.BoostSpec.ConditionBoostSpec

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static DataStoreTool.BoostSpec.ConditionBoostSpec parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
DataStoreTool.BoostSpec.ConditionBoostSpec

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DataStoreTool.BoostSpec.ConditionBoostSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DataStoreTool.BoostSpec.ConditionBoostSpec

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<DataStoreTool.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

Overrides

AbstractMessage.equals(Object other)

getBoost()

public float getBoost()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
float	The boost.

getBoostControlSpec()

public DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec getBoostControlSpec()

Optional. Complex specification for custom ranking based on customer defined attribute value.

.google.cloud.ces.v1.DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec	The boostControlSpec.

getBoostControlSpecOrBuilder()

public DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder getBoostControlSpecOrBuilder()

Optional. Complex specification for custom ranking based on customer defined attribute value.

.google.cloud.ces.v1.DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpecOrBuilder

getCondition()

public String getCondition()

Required. 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 or fr: (lang_code: ANY("en", "fr"))

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

Returns
Type	Description
String	The condition.

getConditionBytes()

public ByteString getConditionBytes()

Required. 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 or fr: (lang_code: ANY("en", "fr"))

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

Returns
Type	Description
ByteString	The bytes for condition.

getDefaultInstanceForType()

public DataStoreTool.BoostSpec.ConditionBoostSpec getDefaultInstanceForType()

Returns
Type	Description
DataStoreTool.BoostSpec.ConditionBoostSpec

getParserForType()

public Parser<DataStoreTool.BoostSpec.ConditionBoostSpec> getParserForType()

Returns
Type	Description
Parser<ConditionBoostSpec>

Overrides

GeneratedMessage.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

hasBoostControlSpec()

public boolean hasBoostControlSpec()

Optional. Complex specification for custom ranking based on customer defined attribute value.

.google.cloud.ces.v1.DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec boost_control_spec = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the boostControlSpec field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public DataStoreTool.BoostSpec.ConditionBoostSpec.Builder newBuilderForType()

Returns
Type	Description
DataStoreTool.BoostSpec.ConditionBoostSpec.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected DataStoreTool.BoostSpec.ConditionBoostSpec.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
DataStoreTool.BoostSpec.ConditionBoostSpec.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public DataStoreTool.BoostSpec.ConditionBoostSpec.Builder toBuilder()

Returns
Type	Description
DataStoreTool.BoostSpec.ConditionBoostSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException