Class Rule.ForceReturnFacetAction (2.82.0)
2.89.0 (latest)
2.87.0
2.85.0
2.84.0
2.82.0
2.80.0
2.78.0
2.77.0
2.76.0
2.75.0
2.74.0
2.72.0
2.70.0
2.69.0
2.66.0
2.65.0
2.64.0
2.62.0
2.61.0
2.60.0
2.59.0
2.58.0
2.57.0
2.56.0
2.55.0
2.54.0
2.53.0
2.51.0
2.50.0
2.49.0
2.48.0
2.47.0
2.46.0
2.45.0
2.44.0
2.43.0
2.42.0
2.41.0
2.39.0
2.38.0
2.37.0
2.36.0
2.35.0
2.34.0
2.33.0
2.32.0
2.31.0
2.30.0
2.29.0
2.26.0
2.25.0
2.24.0
2.23.0
2.22.0
2.21.0
2.20.0
2.19.0
2.18.0
2.17.0
2.16.0
2.15.0
2.14.0
2.13.0
2.11.0
2.10.0
2.9.0
2.8.0
2.7.0
2.6.0
2.5.1
2.4.0
2.3.0
2.2.3
2.1.0
2.0.19
public static final class Rule . ForceReturnFacetAction extends GeneratedMessageV3 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.v2.Rule.ForceReturnFacetAction
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
FACET_POSITION_ADJUSTMENTS_FIELD_NUMBER
public static final int FACET_POSITION_ADJUSTMENTS_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static Rule . ForceReturnFacetAction getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static Rule . ForceReturnFacetAction . Builder newBuilder ()
newBuilder(Rule.ForceReturnFacetAction prototype)
public static Rule . ForceReturnFacetAction . Builder newBuilder ( Rule . ForceReturnFacetAction prototype )
public static Rule . ForceReturnFacetAction parseDelimitedFrom ( InputStream input )
public static Rule . ForceReturnFacetAction parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static Rule . ForceReturnFacetAction parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Rule . ForceReturnFacetAction parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static Rule . ForceReturnFacetAction parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Rule . ForceReturnFacetAction parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static Rule . ForceReturnFacetAction parseFrom ( CodedInputStream input )
public static Rule . ForceReturnFacetAction parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static Rule . ForceReturnFacetAction parseFrom ( InputStream input )
public static Rule . ForceReturnFacetAction parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static Rule . ForceReturnFacetAction parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Rule . ForceReturnFacetAction parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<Rule . ForceReturnFacetAction > parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public Rule . ForceReturnFacetAction getDefaultInstanceForType ()
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.v2.Rule.ForceReturnFacetAction.FacetPositionAdjustment facet_position_adjustments = 1;
Parameter
Name Description
indexint
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.v2.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.v2.Rule.ForceReturnFacetAction.FacetPositionAdjustment facet_position_adjustments = 1;
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.v2.Rule.ForceReturnFacetAction.FacetPositionAdjustment facet_position_adjustments = 1;
Parameter
Name Description
indexint
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.v2.Rule.ForceReturnFacetAction.FacetPositionAdjustment facet_position_adjustments = 1;
Returns
Type Description
List <? extends com.google.cloud.retail.v2.Rule.ForceReturnFacetAction.FacetPositionAdjustmentOrBuilder >
getParserForType()
public Parser<Rule . ForceReturnFacetAction > getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public Rule . ForceReturnFacetAction . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Rule . ForceReturnFacetAction . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public Rule . ForceReturnFacetAction . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-03-14 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-03-14 UTC."],[],[]]
