Class Control.BoostAction.Builder (0.41.0)

public static final class Control.BoostAction.Builder extends GeneratedMessageV3.Builder<Control.BoostAction.Builder> implements Control.BoostActionOrBuilder

Adjusts order of products in returned list.

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Control.BoostAction.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Control.BoostAction.Builder
Overrides

build()

public Control.BoostAction build()
Returns
Type Description
Control.BoostAction

buildPartial()

public Control.BoostAction buildPartial()
Returns
Type Description
Control.BoostAction

clear()

public Control.BoostAction.Builder clear()
Returns
Type Description
Control.BoostAction.Builder
Overrides

clearBoost()

public Control.BoostAction.Builder clearBoost()

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

float boost = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Control.BoostAction.Builder

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Control.BoostAction.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Control.BoostAction.Builder
Overrides

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Control.BoostAction.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Control.BoostAction.Builder
Overrides

clone()

public Control.BoostAction.Builder clone()
Returns
Type Description
Control.BoostAction.Builder
Overrides

getBoost()

public float getBoost()

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

float boost = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
float

The boost.

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

Returns
Type Description
String

The dataStore.

getDataStoreBytes()

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

Returns
Type Description
ByteString

The bytes for dataStore.

getDefaultInstanceForType()

public Control.BoostAction getDefaultInstanceForType()
Returns
Type Description
Control.BoostAction

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

Returns
Type Description
String

The filter.

getFilterBytes()

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

Returns
Type Description
ByteString

The bytes for filter.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Control.BoostAction other)

public Control.BoostAction.Builder mergeFrom(Control.BoostAction other)
Parameter
Name Description
other Control.BoostAction
Returns
Type Description
Control.BoostAction.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Control.BoostAction.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Control.BoostAction.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Control.BoostAction.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Control.BoostAction.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Control.BoostAction.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Control.BoostAction.Builder
Overrides

setBoost(float value)

public Control.BoostAction.Builder setBoost(float value)

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

float boost = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value float

The boost to set.

Returns
Type Description
Control.BoostAction.Builder

This builder for chaining.

setDataStore(String value)

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

Parameter
Name Description
value String

The dataStore to set.

Returns
Type Description
Control.BoostAction.Builder

This builder for chaining.

setDataStoreBytes(ByteString value)

public Control.BoostAction.Builder setDataStoreBytes(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) = { ... }

Parameter
Name Description
value ByteString

The bytes for dataStore to set.

Returns
Type Description
Control.BoostAction.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Control.BoostAction.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Control.BoostAction.Builder
Overrides

setFilter(String value)

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

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
Control.BoostAction.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public Control.BoostAction.Builder setFilterBytes(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];

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
Control.BoostAction.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Control.BoostAction.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Control.BoostAction.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Control.BoostAction.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Control.BoostAction.Builder
Overrides