Send feedback
Class Rule.ForceReturnFacetAction (2.55.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.55.0 keyboard_arrow_down
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
Send feedback
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 2025-01-27 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-27 UTC."],[],[]]
