- 0.59.0 (latest)
- 0.58.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public static final class Control.BoostAction.Builder extends GeneratedMessageV3.Builder<Control.BoostAction.Builder> implements Control.BoostActionOrBuilderAdjusts order of products in returned list.
Protobuf type google.cloud.discoveryengine.v1.Control.BoostAction
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Control.BoostAction.BuilderImplements
Control.BoostActionOrBuilderStatic 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 |
|
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 |
|
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 | |
|---|---|
| Type | Description |
Control.BoostAction.Builder |
This builder for chaining. |
clearBoostSpec()
public Control.BoostAction.Builder clearBoostSpec()| Returns | |
|---|---|
| Type | Description |
Control.BoostAction.Builder |
|
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 |
|
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. |
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 | |
|---|---|
| Type | Description |
Control.BoostAction.Builder |
This builder for chaining. |
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];
| Returns | |
|---|---|
| Type | Description |
Control.BoostAction.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public Control.BoostAction.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Control.BoostAction.Builder |
|
clone()
public Control.BoostAction.Builder clone()| Returns | |
|---|---|
| Type | Description |
Control.BoostAction.Builder |
|
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];
| Returns | |
|---|---|
| Type | Description |
float |
The boost. |
getBoostSpecCase()
public Control.BoostAction.BoostSpecCase getBoostSpecCase()| Returns | |
|---|---|
| Type | Description |
Control.BoostAction.BoostSpecCase |
|
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 |
|
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. |
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];
| Returns | |
|---|---|
| Type | Description |
float |
The fixedBoost. |
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];
| Returns | |
|---|---|
| Type | Description |
Control.BoostAction.InterpolationBoostSpec |
The interpolationBoostSpec. |
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];
| Returns | |
|---|---|
| Type | Description |
Control.BoostAction.InterpolationBoostSpec.Builder |
|
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];
| Returns | |
|---|---|
| Type | Description |
Control.BoostAction.InterpolationBoostSpecOrBuilder |
|
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];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the fixedBoost field is set. |
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];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the interpolationBoostSpec field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
| 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 |
|
mergeInterpolationBoostSpec(Control.BoostAction.InterpolationBoostSpec value)
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];
| Parameter | |
|---|---|
| Name | Description |
value |
Control.BoostAction.InterpolationBoostSpec |
| Returns | |
|---|---|
| Type | Description |
Control.BoostAction.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Control.BoostAction.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Control.BoostAction.Builder |
|
setBoost(float value) (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];
| Parameter | |
|---|---|
| Name | Description |
value |
floatThe 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 |
StringThe 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 |
ByteStringThe 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 |
|
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 |
StringThe 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 |
ByteStringThe bytes for filter to set. |
| Returns | |
|---|---|
| Type | Description |
Control.BoostAction.Builder |
This builder for chaining. |
setFixedBoost(float value)
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];
| Parameter | |
|---|---|
| Name | Description |
value |
floatThe fixedBoost to set. |
| Returns | |
|---|---|
| Type | Description |
Control.BoostAction.Builder |
This builder for chaining. |
setInterpolationBoostSpec(Control.BoostAction.InterpolationBoostSpec value)
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];
| Parameter | |
|---|---|
| Name | Description |
value |
Control.BoostAction.InterpolationBoostSpec |
| Returns | |
|---|---|
| Type | Description |
Control.BoostAction.Builder |
|
setInterpolationBoostSpec(Control.BoostAction.InterpolationBoostSpec.Builder builderForValue)
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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Control.BoostAction.InterpolationBoostSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
Control.BoostAction.Builder |
|
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 |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final Control.BoostAction.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Control.BoostAction.Builder |
|