com.google.cloud.discoveryengine.v1

Class Control.BoostAction.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessage.Builder<Control.BoostAction.Builder>

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

All Implemented Interfaces:

Control.BoostActionOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

Control.BoostAction

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

 Adjusts order of products in returned list.
 

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

Method Summary

Modifier and Type	Method and Description
Control.BoostAction	build()
Control.BoostAction	buildPartial()
Control.BoostAction.Builder	clear()
Control.BoostAction.Builder	clearBoost() Deprecated. google.cloud.discoveryengine.v1.Control.BoostAction.boost is deprecated. See google/cloud/discoveryengine/v1/control.proto;l=187
Control.BoostAction.Builder	clearBoostSpec()
Control.BoostAction.Builder	clearDataStore() Required.
Control.BoostAction.Builder	clearFilter() Required.
Control.BoostAction.Builder	clearFixedBoost() Optional.
Control.BoostAction.Builder	clearInterpolationBoostSpec() Optional.
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.
Control.BoostAction	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getFilter() Required.
com.google.protobuf.ByteString	getFilterBytes() Required.
float	getFixedBoost() Optional.
Control.BoostAction.InterpolationBoostSpec	getInterpolationBoostSpec() Optional.
Control.BoostAction.InterpolationBoostSpec.Builder	getInterpolationBoostSpecBuilder() Optional.
Control.BoostAction.InterpolationBoostSpecOrBuilder	getInterpolationBoostSpecOrBuilder() Optional.
boolean	hasFixedBoost() Optional.
boolean	hasInterpolationBoostSpec() Optional.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
Control.BoostAction.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Control.BoostAction.Builder	mergeFrom(Control.BoostAction other)
Control.BoostAction.Builder	mergeFrom(com.google.protobuf.Message other)
Control.BoostAction.Builder	mergeInterpolationBoostSpec(Control.BoostAction.InterpolationBoostSpec value) Optional.
Control.BoostAction.Builder	setBoost(float value) Deprecated. google.cloud.discoveryengine.v1.Control.BoostAction.boost is deprecated. See google/cloud/discoveryengine/v1/control.proto;l=187
Control.BoostAction.Builder	setDataStore(String value) Required.
Control.BoostAction.Builder	setDataStoreBytes(com.google.protobuf.ByteString value) Required.
Control.BoostAction.Builder	setFilter(String value) Required.
Control.BoostAction.Builder	setFilterBytes(com.google.protobuf.ByteString value) Required.
Control.BoostAction.Builder	setFixedBoost(float value) Optional.
Control.BoostAction.Builder	setInterpolationBoostSpec(Control.BoostAction.InterpolationBoostSpec.Builder builderForValue) Optional.
Control.BoostAction.Builder	setInterpolationBoostSpec(Control.BoostAction.InterpolationBoostSpec value) Optional.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

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.Builder<Control.BoostAction.Builder>

clear

public Control.BoostAction.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<Control.BoostAction.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Control.BoostAction.Builder>

getDefaultInstanceForType

public Control.BoostAction getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Control.BoostAction build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Control.BoostAction buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public Control.BoostAction.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Control.BoostAction.Builder>

mergeFrom

public Control.BoostAction.Builder mergeFrom(Control.BoostAction other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Control.BoostAction.Builder>

mergeFrom

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

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Control.BoostAction.Builder>

Throws:

IOException

getBoostSpecCase

public Control.BoostAction.BoostSpecCase getBoostSpecCase()

Specified by:

getBoostSpecCase in interface Control.BoostActionOrBuilder

clearBoostSpec

public Control.BoostAction.Builder clearBoostSpec()

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.

setFixedBoost

public Control.BoostAction.Builder setFixedBoost(float value)

 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];

Parameters:

value - The fixedBoost to set.

Returns:

This builder for chaining.

clearFixedBoost

public Control.BoostAction.Builder clearFixedBoost()

 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];

Returns:

This builder for chaining.

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.

setInterpolationBoostSpec

public Control.BoostAction.Builder setInterpolationBoostSpec(Control.BoostAction.InterpolationBoostSpec value)

 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];

setInterpolationBoostSpec

public Control.BoostAction.Builder setInterpolationBoostSpec(Control.BoostAction.InterpolationBoostSpec.Builder builderForValue)

 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];

mergeInterpolationBoostSpec

public Control.BoostAction.Builder mergeInterpolationBoostSpec(Control.BoostAction.InterpolationBoostSpec value)

 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];

clearInterpolationBoostSpec

public Control.BoostAction.Builder clearInterpolationBoostSpec()

 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];

getInterpolationBoostSpecBuilder

public Control.BoostAction.InterpolationBoostSpec.Builder getInterpolationBoostSpecBuilder()

 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];

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.

setBoost

@Deprecated
public Control.BoostAction.Builder setBoost(float value)

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];

Parameters:

value - The boost to set.

Returns:

This builder for chaining.

clearBoost

@Deprecated
public Control.BoostAction.Builder clearBoost()

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];

Returns:

This builder for chaining.

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.

setFilter

public Control.BoostAction.Builder setFilter(String value)

 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];

Parameters:

value - The filter to set.

Returns:

This builder for chaining.

clearFilter

public Control.BoostAction.Builder clearFilter()

 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];

Returns:

This builder for chaining.

setFilterBytes

public Control.BoostAction.Builder setFilterBytes(com.google.protobuf.ByteString value)

 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];

Parameters:

value - The bytes for filter to set.

Returns:

This builder for chaining.

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.

setDataStore

public Control.BoostAction.Builder setDataStore(String value)

 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) = { ... }

Parameters:

value - The dataStore to set.

Returns:

This builder for chaining.

clearDataStore

public Control.BoostAction.Builder clearDataStore()

 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) = { ... }

Returns:

This builder for chaining.

setDataStoreBytes

public Control.BoostAction.Builder setDataStoreBytes(com.google.protobuf.ByteString value)

 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) = { ... }

Parameters:

value - The bytes for dataStore to set.

Returns:

This builder for chaining.