com.google.cloud.retail.v2

Class SearchRequest.BoostSpec

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.retail.v2.SearchRequest.BoostSpec

All Implemented Interfaces:

SearchRequest.BoostSpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

SearchRequest

public static final class SearchRequest.BoostSpec
extends com.google.protobuf.GeneratedMessageV3
implements SearchRequest.BoostSpecOrBuilder

 Boost specification to boost certain items.
 

Protobuf type google.cloud.retail.v2.SearchRequest.BoostSpec

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchRequest.BoostSpec.Builder Boost specification to boost certain items.
static class	SearchRequest.BoostSpec.ConditionBoostSpec Boost applies to products which match a condition.
static interface	SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONDITION_BOOST_SPECS_FIELD_NUMBER
static int	SKIP_BOOST_SPEC_VALIDATION_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
SearchRequest.BoostSpec.ConditionBoostSpec	getConditionBoostSpecs(int index) Condition boost specifications.
int	getConditionBoostSpecsCount() Condition boost specifications.
List<SearchRequest.BoostSpec.ConditionBoostSpec>	getConditionBoostSpecsList() Condition boost specifications.
SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder	getConditionBoostSpecsOrBuilder(int index) Condition boost specifications.
List<? extends SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder>	getConditionBoostSpecsOrBuilderList() Condition boost specifications.
static SearchRequest.BoostSpec	getDefaultInstance()
SearchRequest.BoostSpec	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<SearchRequest.BoostSpec>	getParserForType()
int	getSerializedSize()
boolean	getSkipBoostSpecValidation() Whether to skip boostspec validation.
int	hashCode()
boolean	hasSkipBoostSpecValidation() Whether to skip boostspec validation.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static SearchRequest.BoostSpec.Builder	newBuilder()
static SearchRequest.BoostSpec.Builder	newBuilder(SearchRequest.BoostSpec prototype)
SearchRequest.BoostSpec.Builder	newBuilderForType()
protected SearchRequest.BoostSpec.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static SearchRequest.BoostSpec	parseDelimitedFrom(InputStream input)
static SearchRequest.BoostSpec	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.BoostSpec	parseFrom(byte[] data)
static SearchRequest.BoostSpec	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.BoostSpec	parseFrom(ByteBuffer data)
static SearchRequest.BoostSpec	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.BoostSpec	parseFrom(com.google.protobuf.ByteString data)
static SearchRequest.BoostSpec	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.BoostSpec	parseFrom(com.google.protobuf.CodedInputStream input)
static SearchRequest.BoostSpec	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.BoostSpec	parseFrom(InputStream input)
static SearchRequest.BoostSpec	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<SearchRequest.BoostSpec>	parser()
SearchRequest.BoostSpec.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

CONDITION_BOOST_SPECS_FIELD_NUMBER

public static final int CONDITION_BOOST_SPECS_FIELD_NUMBER

See Also:

Constant Field Values

SKIP_BOOST_SPEC_VALIDATION_FIELD_NUMBER

public static final int SKIP_BOOST_SPEC_VALIDATION_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getConditionBoostSpecsList

public List<SearchRequest.BoostSpec.ConditionBoostSpec> getConditionBoostSpecsList()

 Condition boost specifications. If a product 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.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec condition_boost_specs = 1;

Specified by:

getConditionBoostSpecsList in interface SearchRequest.BoostSpecOrBuilder

getConditionBoostSpecsOrBuilderList

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

 Condition boost specifications. If a product 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.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec condition_boost_specs = 1;

Specified by:

getConditionBoostSpecsOrBuilderList in interface SearchRequest.BoostSpecOrBuilder

getConditionBoostSpecsCount

public int getConditionBoostSpecsCount()

 Condition boost specifications. If a product 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.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec condition_boost_specs = 1;

Specified by:

getConditionBoostSpecsCount in interface SearchRequest.BoostSpecOrBuilder

getConditionBoostSpecs

public SearchRequest.BoostSpec.ConditionBoostSpec getConditionBoostSpecs(int index)

 Condition boost specifications. If a product 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.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec condition_boost_specs = 1;

Specified by:

getConditionBoostSpecs in interface SearchRequest.BoostSpecOrBuilder

getConditionBoostSpecsOrBuilder

public SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder getConditionBoostSpecsOrBuilder(int index)

 Condition boost specifications. If a product 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.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec condition_boost_specs = 1;

Specified by:

getConditionBoostSpecsOrBuilder in interface SearchRequest.BoostSpecOrBuilder

hasSkipBoostSpecValidation

public boolean hasSkipBoostSpecValidation()

 Whether to skip boostspec validation. If this field is set to true,
 invalid
 [BoostSpec.condition_boost_specs][google.cloud.retail.v2.SearchRequest.BoostSpec.condition_boost_specs]
 will be ignored and valid
 [BoostSpec.condition_boost_specs][google.cloud.retail.v2.SearchRequest.BoostSpec.condition_boost_specs]
 will still be applied.
 

optional bool skip_boost_spec_validation = 2;

Specified by:

hasSkipBoostSpecValidation in interface SearchRequest.BoostSpecOrBuilder

Returns:

Whether the skipBoostSpecValidation field is set.

getSkipBoostSpecValidation

public boolean getSkipBoostSpecValidation()

 Whether to skip boostspec validation. If this field is set to true,
 invalid
 [BoostSpec.condition_boost_specs][google.cloud.retail.v2.SearchRequest.BoostSpec.condition_boost_specs]
 will be ignored and valid
 [BoostSpec.condition_boost_specs][google.cloud.retail.v2.SearchRequest.BoostSpec.condition_boost_specs]
 will still be applied.
 

optional bool skip_boost_spec_validation = 2;

Specified by:

getSkipBoostSpecValidation in interface SearchRequest.BoostSpecOrBuilder

Returns:

The skipBoostSpecValidation.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static SearchRequest.BoostSpec parseFrom(ByteBuffer data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.BoostSpec parseFrom(ByteBuffer data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.BoostSpec parseFrom(com.google.protobuf.ByteString data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.BoostSpec parseFrom(com.google.protobuf.ByteString data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.BoostSpec parseFrom(byte[] data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.BoostSpec parseFrom(byte[] data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.BoostSpec parseFrom(InputStream input)
                                         throws IOException

Throws:

IOException

parseFrom

public static SearchRequest.BoostSpec parseFrom(InputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static SearchRequest.BoostSpec parseDelimitedFrom(InputStream input)
                                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static SearchRequest.BoostSpec parseDelimitedFrom(InputStream input,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws IOException

Throws:

IOException

parseFrom

public static SearchRequest.BoostSpec parseFrom(com.google.protobuf.CodedInputStream input)
                                         throws IOException

Throws:

IOException

parseFrom

public static SearchRequest.BoostSpec parseFrom(com.google.protobuf.CodedInputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

newBuilderForType

public SearchRequest.BoostSpec.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static SearchRequest.BoostSpec.Builder newBuilder()

newBuilder

public static SearchRequest.BoostSpec.Builder newBuilder(SearchRequest.BoostSpec prototype)

toBuilder

public SearchRequest.BoostSpec.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected SearchRequest.BoostSpec.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static SearchRequest.BoostSpec getDefaultInstance()

parser

public static com.google.protobuf.Parser<SearchRequest.BoostSpec> parser()

getParserForType

public com.google.protobuf.Parser<SearchRequest.BoostSpec> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public SearchRequest.BoostSpec getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder