Class Rule.ForceReturnFacetAction.Builder (2.57.0)

public static final class Rule.ForceReturnFacetAction.Builder extends GeneratedMessageV3.Builder<Rule.ForceReturnFacetAction.Builder> implements Rule.ForceReturnFacetActionOrBuilder

Force returns an attribute/facet in the request around a certain position or above.

Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both.
Action Inputs: attribute name, position
Action Result: Will force return a facet key around a certain position or above if the condition is satisfied.

Example: Suppose the query is "shoes", the Condition.query_terms is "shoes", the ForceReturnFacetAction.FacetPositionAdjustment.attribute_name is "size" and the ForceReturnFacetAction.FacetPositionAdjustment.position is 8.

Two cases: a) The facet key "size" is not already in the top 8 slots, then the facet "size" will appear at a position close to 8. b) The facet key "size" in among the top 8 positions in the request, then it will stay at its current rank.

Protobuf type google.cloud.retail.v2beta.Rule.ForceReturnFacetAction

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Rule.ForceReturnFacetAction.Builder

Implements

Rule.ForceReturnFacetActionOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addAllFacetPositionAdjustments(Iterable<? extends Rule.ForceReturnFacetAction.FacetPositionAdjustment> values)

public Rule.ForceReturnFacetAction.Builder addAllFacetPositionAdjustments(Iterable<? extends Rule.ForceReturnFacetAction.FacetPositionAdjustment> values)

Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here.

repeated .google.cloud.retail.v2beta.Rule.ForceReturnFacetAction.FacetPositionAdjustment facet_position_adjustments = 1;

Parameter
Name	Description
`values`	`Iterable<? extends com.google.cloud.retail.v2beta.Rule.ForceReturnFacetAction.FacetPositionAdjustment>`

Returns
Type	Description
`Rule.ForceReturnFacetAction.Builder`

addFacetPositionAdjustments(Rule.ForceReturnFacetAction.FacetPositionAdjustment value)

public Rule.ForceReturnFacetAction.Builder addFacetPositionAdjustments(Rule.ForceReturnFacetAction.FacetPositionAdjustment value)

Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here.

repeated .google.cloud.retail.v2beta.Rule.ForceReturnFacetAction.FacetPositionAdjustment facet_position_adjustments = 1;

Parameter
Name	Description
`value`	`Rule.ForceReturnFacetAction.FacetPositionAdjustment`

Returns
Type	Description
`Rule.ForceReturnFacetAction.Builder`

addFacetPositionAdjustments(Rule.ForceReturnFacetAction.FacetPositionAdjustment.Builder builderForValue)

public Rule.ForceReturnFacetAction.Builder addFacetPositionAdjustments(Rule.ForceReturnFacetAction.FacetPositionAdjustment.Builder builderForValue)

Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here.

repeated .google.cloud.retail.v2beta.Rule.ForceReturnFacetAction.FacetPositionAdjustment facet_position_adjustments = 1;

Parameter
Name	Description
`builderForValue`	`Rule.ForceReturnFacetAction.FacetPositionAdjustment.Builder`

Returns
Type	Description
`Rule.ForceReturnFacetAction.Builder`

addFacetPositionAdjustments(int index, Rule.ForceReturnFacetAction.FacetPositionAdjustment value)

public Rule.ForceReturnFacetAction.Builder addFacetPositionAdjustments(int index, Rule.ForceReturnFacetAction.FacetPositionAdjustment value)

Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here.

repeated .google.cloud.retail.v2beta.Rule.ForceReturnFacetAction.FacetPositionAdjustment facet_position_adjustments = 1;

Parameters
Name	Description
`index`	`int`
`value`	`Rule.ForceReturnFacetAction.FacetPositionAdjustment`

Returns
Type	Description
`Rule.ForceReturnFacetAction.Builder`

addFacetPositionAdjustments(int index, Rule.ForceReturnFacetAction.FacetPositionAdjustment.Builder builderForValue)

public Rule.ForceReturnFacetAction.Builder addFacetPositionAdjustments(int index, Rule.ForceReturnFacetAction.FacetPositionAdjustment.Builder builderForValue)

Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here.

repeated .google.cloud.retail.v2beta.Rule.ForceReturnFacetAction.FacetPositionAdjustment facet_position_adjustments = 1;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`Rule.ForceReturnFacetAction.FacetPositionAdjustment.Builder`

Returns
Type	Description
`Rule.ForceReturnFacetAction.Builder`

addFacetPositionAdjustmentsBuilder()

public Rule.ForceReturnFacetAction.FacetPositionAdjustment.Builder addFacetPositionAdjustmentsBuilder()

Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here.

repeated .google.cloud.retail.v2beta.Rule.ForceReturnFacetAction.FacetPositionAdjustment facet_position_adjustments = 1;

Returns
Type	Description
`Rule.ForceReturnFacetAction.FacetPositionAdjustment.Builder`

addFacetPositionAdjustmentsBuilder(int index)

public Rule.ForceReturnFacetAction.FacetPositionAdjustment.Builder addFacetPositionAdjustmentsBuilder(int index)

Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here.

repeated .google.cloud.retail.v2beta.Rule.ForceReturnFacetAction.FacetPositionAdjustment facet_position_adjustments = 1;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Rule.ForceReturnFacetAction.FacetPositionAdjustment.Builder`

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Rule.ForceReturnFacetAction.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`Rule.ForceReturnFacetAction.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public Rule.ForceReturnFacetAction build()

Returns
Type	Description
`Rule.ForceReturnFacetAction`

buildPartial()

public Rule.ForceReturnFacetAction buildPartial()

Returns
Type	Description
`Rule.ForceReturnFacetAction`

clear()

public Rule.ForceReturnFacetAction.Builder clear()

Returns
Type	Description
`Rule.ForceReturnFacetAction.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearFacetPositionAdjustments()

public Rule.ForceReturnFacetAction.Builder clearFacetPositionAdjustments()

Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here.

repeated .google.cloud.retail.v2beta.Rule.ForceReturnFacetAction.FacetPositionAdjustment facet_position_adjustments = 1;

Returns
Type	Description
`Rule.ForceReturnFacetAction.Builder`

clearField(Descriptors.FieldDescriptor field)

public Rule.ForceReturnFacetAction.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`Rule.ForceReturnFacetAction.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public Rule.ForceReturnFacetAction.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`Rule.ForceReturnFacetAction.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clone()

public Rule.ForceReturnFacetAction.Builder clone()

Returns
Type	Description
`Rule.ForceReturnFacetAction.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public Rule.ForceReturnFacetAction getDefaultInstanceForType()

Returns
Type	Description
`Rule.ForceReturnFacetAction`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getFacetPositionAdjustments(int index)

public Rule.ForceReturnFacetAction.FacetPositionAdjustment getFacetPositionAdjustments(int index)

Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here.

repeated .google.cloud.retail.v2beta.Rule.ForceReturnFacetAction.FacetPositionAdjustment facet_position_adjustments = 1;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Rule.ForceReturnFacetAction.FacetPositionAdjustment`

getFacetPositionAdjustmentsBuilder(int index)

public Rule.ForceReturnFacetAction.FacetPositionAdjustment.Builder getFacetPositionAdjustmentsBuilder(int index)

Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here.

repeated .google.cloud.retail.v2beta.Rule.ForceReturnFacetAction.FacetPositionAdjustment facet_position_adjustments = 1;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Rule.ForceReturnFacetAction.FacetPositionAdjustment.Builder`

getFacetPositionAdjustmentsBuilderList()

public List<Rule.ForceReturnFacetAction.FacetPositionAdjustment.Builder> getFacetPositionAdjustmentsBuilderList()

Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here.

repeated .google.cloud.retail.v2beta.Rule.ForceReturnFacetAction.FacetPositionAdjustment facet_position_adjustments = 1;

Returns
Type	Description
`List<Builder>`

getFacetPositionAdjustmentsCount()

public int getFacetPositionAdjustmentsCount()

Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here.

repeated .google.cloud.retail.v2beta.Rule.ForceReturnFacetAction.FacetPositionAdjustment facet_position_adjustments = 1;

Returns
Type	Description
`int`

getFacetPositionAdjustmentsList()

public List<Rule.ForceReturnFacetAction.FacetPositionAdjustment> getFacetPositionAdjustmentsList()

Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here.

repeated .google.cloud.retail.v2beta.Rule.ForceReturnFacetAction.FacetPositionAdjustment facet_position_adjustments = 1;

Returns
Type	Description
`List<FacetPositionAdjustment>`

getFacetPositionAdjustmentsOrBuilder(int index)

public Rule.ForceReturnFacetAction.FacetPositionAdjustmentOrBuilder getFacetPositionAdjustmentsOrBuilder(int index)

Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here.

repeated .google.cloud.retail.v2beta.Rule.ForceReturnFacetAction.FacetPositionAdjustment facet_position_adjustments = 1;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Rule.ForceReturnFacetAction.FacetPositionAdjustmentOrBuilder`

getFacetPositionAdjustmentsOrBuilderList()

public List<? extends Rule.ForceReturnFacetAction.FacetPositionAdjustmentOrBuilder> getFacetPositionAdjustmentsOrBuilderList()

Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here.

repeated .google.cloud.retail.v2beta.Rule.ForceReturnFacetAction.FacetPositionAdjustment facet_position_adjustments = 1;

Returns
Type	Description
`List<? extends com.google.cloud.retail.v2beta.Rule.ForceReturnFacetAction.FacetPositionAdjustmentOrBuilder>`

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(Rule.ForceReturnFacetAction other)

public Rule.ForceReturnFacetAction.Builder mergeFrom(Rule.ForceReturnFacetAction other)

Parameter
Name	Description
`other`	`Rule.ForceReturnFacetAction`

Returns
Type	Description
`Rule.ForceReturnFacetAction.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Rule.ForceReturnFacetAction.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Rule.ForceReturnFacetAction.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public Rule.ForceReturnFacetAction.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`Rule.ForceReturnFacetAction.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Rule.ForceReturnFacetAction.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`Rule.ForceReturnFacetAction.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeFacetPositionAdjustments(int index)

public Rule.ForceReturnFacetAction.Builder removeFacetPositionAdjustments(int index)

Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here.

repeated .google.cloud.retail.v2beta.Rule.ForceReturnFacetAction.FacetPositionAdjustment facet_position_adjustments = 1;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Rule.ForceReturnFacetAction.Builder`

setFacetPositionAdjustments(int index, Rule.ForceReturnFacetAction.FacetPositionAdjustment value)

public Rule.ForceReturnFacetAction.Builder setFacetPositionAdjustments(int index, Rule.ForceReturnFacetAction.FacetPositionAdjustment value)

Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here.

repeated .google.cloud.retail.v2beta.Rule.ForceReturnFacetAction.FacetPositionAdjustment facet_position_adjustments = 1;

Parameters
Name	Description
`index`	`int`
`value`	`Rule.ForceReturnFacetAction.FacetPositionAdjustment`

Returns
Type	Description
`Rule.ForceReturnFacetAction.Builder`

setFacetPositionAdjustments(int index, Rule.ForceReturnFacetAction.FacetPositionAdjustment.Builder builderForValue)

public Rule.ForceReturnFacetAction.Builder setFacetPositionAdjustments(int index, Rule.ForceReturnFacetAction.FacetPositionAdjustment.Builder builderForValue)

Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here.

repeated .google.cloud.retail.v2beta.Rule.ForceReturnFacetAction.FacetPositionAdjustment facet_position_adjustments = 1;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`Rule.ForceReturnFacetAction.FacetPositionAdjustment.Builder`

Returns
Type	Description
`Rule.ForceReturnFacetAction.Builder`

setField(Descriptors.FieldDescriptor field, Object value)

public Rule.ForceReturnFacetAction.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`Rule.ForceReturnFacetAction.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

public Rule.ForceReturnFacetAction.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`Rule.ForceReturnFacetAction.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final Rule.ForceReturnFacetAction.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`Rule.ForceReturnFacetAction.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)