com.google.cloud.discoveryengine.v1

Class Control.BoostAction

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.cloud.discoveryengine.v1.Control.BoostAction

All Implemented Interfaces:

Control.BoostActionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

Control

public static final class Control.BoostAction
extends com.google.protobuf.GeneratedMessage
implements Control.BoostActionOrBuilder

 Adjusts order of products in returned list.
 

Protobuf type google.cloud.discoveryengine.v1.Control.BoostAction

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Control.BoostAction.BoostSpecCase
static class	Control.BoostAction.Builder Adjusts order of products in returned list.
static class	Control.BoostAction.InterpolationBoostSpec Specification for custom ranking based on customer specified attribute value.
static interface	Control.BoostAction.InterpolationBoostSpecOrBuilder

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

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

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

com.google.protobuf.AbstractMessage.BuilderParent

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	BOOST_FIELD_NUMBER
static int	DATA_STORE_FIELD_NUMBER
static int	FILTER_FIELD_NUMBER
static int	FIXED_BOOST_FIELD_NUMBER
static int	INTERPOLATION_BOOST_SPEC_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, 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)
float	getBoost() Deprecated. google.cloud.discoveryengine.v1.Control.BoostAction.boost is deprecated. See google/cloud/discoveryengine/v1/control.proto;l=187
Control.BoostAction.BoostSpecCase	getBoostSpecCase()
String	getDataStore() Required.
com.google.protobuf.ByteString	getDataStoreBytes() Required.
static Control.BoostAction	getDefaultInstance()
Control.BoostAction	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getFilter() Required.
com.google.protobuf.ByteString	getFilterBytes() Required.
float	getFixedBoost() Optional.
Control.BoostAction.InterpolationBoostSpec	getInterpolationBoostSpec() Optional.
Control.BoostAction.InterpolationBoostSpecOrBuilder	getInterpolationBoostSpecOrBuilder() Optional.
com.google.protobuf.Parser<Control.BoostAction>	getParserForType()
int	getSerializedSize()
boolean	hasFixedBoost() Optional.
int	hashCode()
boolean	hasInterpolationBoostSpec() Optional.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Control.BoostAction.Builder	newBuilder()
static Control.BoostAction.Builder	newBuilder(Control.BoostAction prototype)
Control.BoostAction.Builder	newBuilderForType()
protected Control.BoostAction.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static Control.BoostAction	parseDelimitedFrom(InputStream input)
static Control.BoostAction	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Control.BoostAction	parseFrom(byte[] data)
static Control.BoostAction	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Control.BoostAction	parseFrom(ByteBuffer data)
static Control.BoostAction	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Control.BoostAction	parseFrom(com.google.protobuf.ByteString data)
static Control.BoostAction	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Control.BoostAction	parseFrom(com.google.protobuf.CodedInputStream input)
static Control.BoostAction	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Control.BoostAction	parseFrom(InputStream input)
static Control.BoostAction	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Control.BoostAction>	parser()
Control.BoostAction.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

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, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

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

FIXED_BOOST_FIELD_NUMBER

public static final int FIXED_BOOST_FIELD_NUMBER

See Also:

Constant Field Values

INTERPOLATION_BOOST_SPEC_FIELD_NUMBER

public static final int INTERPOLATION_BOOST_SPEC_FIELD_NUMBER

See Also:

Constant Field Values

BOOST_FIELD_NUMBER

public static final int BOOST_FIELD_NUMBER

See Also:

Constant Field Values

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER

See Also:

Constant Field Values

DATA_STORE_FIELD_NUMBER

public static final int DATA_STORE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getDescriptor

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

getBoostSpecCase

public Control.BoostAction.BoostSpecCase getBoostSpecCase()

Specified by:

getBoostSpecCase in interface Control.BoostActionOrBuilder

hasFixedBoost

public boolean hasFixedBoost()

 Optional. Strength of the boost, which should be in [-1, 1]. Negative
 boost means demotion. Default is 0.0 (No-op).
 

float fixed_boost = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasFixedBoost in interface Control.BoostActionOrBuilder

Returns:

Whether the fixedBoost field is set.

getFixedBoost

public float getFixedBoost()

 Optional. Strength of the boost, which should be in [-1, 1]. Negative
 boost means demotion. Default is 0.0 (No-op).
 

float fixed_boost = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getFixedBoost in interface Control.BoostActionOrBuilder

Returns:

The fixedBoost.

hasInterpolationBoostSpec

public boolean hasInterpolationBoostSpec()

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

.google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec interpolation_boost_spec = 5 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasInterpolationBoostSpec in interface Control.BoostActionOrBuilder

Returns:

Whether the interpolationBoostSpec field is set.

getInterpolationBoostSpec

public Control.BoostAction.InterpolationBoostSpec getInterpolationBoostSpec()

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

.google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec interpolation_boost_spec = 5 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getInterpolationBoostSpec in interface Control.BoostActionOrBuilder

Returns:

The interpolationBoostSpec.

getInterpolationBoostSpecOrBuilder

public Control.BoostAction.InterpolationBoostSpecOrBuilder getInterpolationBoostSpecOrBuilder()

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

.google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec interpolation_boost_spec = 5 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getInterpolationBoostSpecOrBuilder in interface Control.BoostActionOrBuilder

getBoost

@Deprecated
public float getBoost()

Deprecated. google.cloud.discoveryengine.v1.Control.BoostAction.boost is deprecated. See google/cloud/discoveryengine/v1/control.proto;l=187

 Strength of the boost, which should be in [-1, 1]. Negative
 boost means demotion. Default is 0.0 (No-op).
 

float boost = 1 [deprecated = true];

Specified by:

getBoost in interface Control.BoostActionOrBuilder

Returns:

The boost.

getFilter

public String getFilter()

 Required. Specifies which products to apply the boost to.

 If no filter is provided all products will be boosted (No-op).
 Syntax documentation:
 https://cloud.google.com/retail/docs/filter-and-order
 Maximum length is 5000 characters.
 Otherwise an INVALID ARGUMENT error is thrown.
 

string filter = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getFilter in interface Control.BoostActionOrBuilder

Returns:

The filter.

getFilterBytes

public com.google.protobuf.ByteString getFilterBytes()

 Required. Specifies which products to apply the boost to.

 If no filter is provided all products will be boosted (No-op).
 Syntax documentation:
 https://cloud.google.com/retail/docs/filter-and-order
 Maximum length is 5000 characters.
 Otherwise an INVALID ARGUMENT error is thrown.
 

string filter = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getFilterBytes in interface Control.BoostActionOrBuilder

Returns:

The bytes for filter.

getDataStore

public String getDataStore()

 Required. Specifies which data store's documents can be boosted by this
 control. Full data store name e.g.
 projects/123/locations/global/collections/default_collection/dataStores/default_data_store
 

string data_store = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:

getDataStore in interface Control.BoostActionOrBuilder

Returns:

The dataStore.

getDataStoreBytes

public com.google.protobuf.ByteString getDataStoreBytes()

 Required. Specifies which data store's documents can be boosted by this
 control. Full data store name e.g.
 projects/123/locations/global/collections/default_collection/dataStores/default_data_store
 

string data_store = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:

getDataStoreBytes in interface Control.BoostActionOrBuilder

Returns:

The bytes for dataStore.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

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.GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

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 Control.BoostAction parseFrom(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Control.BoostAction parseFrom(com.google.protobuf.ByteString data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Control.BoostAction parseFrom(byte[] data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Control.BoostAction parseFrom(InputStream input)
                                     throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static Control.BoostAction parseDelimitedFrom(InputStream input)
                                              throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static Control.BoostAction parseFrom(com.google.protobuf.CodedInputStream input)
                                     throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public Control.BoostAction.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Control.BoostAction.Builder newBuilder()

newBuilder

public static Control.BoostAction.Builder newBuilder(Control.BoostAction prototype)

toBuilder

public Control.BoostAction.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Control.BoostAction.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static Control.BoostAction getDefaultInstance()

parser

public static com.google.protobuf.Parser<Control.BoostAction> parser()

getParserForType

public com.google.protobuf.Parser<Control.BoostAction> 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.GeneratedMessage

getDefaultInstanceForType

public Control.BoostAction getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder