Class Rule.ForceReturnFacetAction (2.49.0) 

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.v2alpha.Rule.ForceReturnFacetAction

Inheritance

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

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()
Returns
Type Description
Rule.ForceReturnFacetAction

getDescriptor()

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

newBuilder()

public static Rule.ForceReturnFacetAction.Builder newBuilder()
Returns
Type Description
Rule.ForceReturnFacetAction.Builder

newBuilder(Rule.ForceReturnFacetAction prototype)

public static Rule.ForceReturnFacetAction.Builder newBuilder(Rule.ForceReturnFacetAction prototype)
Parameter
Name Description
prototype Rule.ForceReturnFacetAction
Returns
Type Description
Rule.ForceReturnFacetAction.Builder

parseDelimitedFrom(InputStream input)

public static Rule.ForceReturnFacetAction parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Rule.ForceReturnFacetAction
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Rule.ForceReturnFacetAction parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Rule.ForceReturnFacetAction
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Rule.ForceReturnFacetAction parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Rule.ForceReturnFacetAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Rule.ForceReturnFacetAction parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Rule.ForceReturnFacetAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Rule.ForceReturnFacetAction parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Rule.ForceReturnFacetAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Rule.ForceReturnFacetAction parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Rule.ForceReturnFacetAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Rule.ForceReturnFacetAction parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Rule.ForceReturnFacetAction
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Rule.ForceReturnFacetAction parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Rule.ForceReturnFacetAction
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Rule.ForceReturnFacetAction parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Rule.ForceReturnFacetAction
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Rule.ForceReturnFacetAction parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Rule.ForceReturnFacetAction
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Rule.ForceReturnFacetAction parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Rule.ForceReturnFacetAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Rule.ForceReturnFacetAction parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Rule.ForceReturnFacetAction
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Rule.ForceReturnFacetAction> parser()
Returns
Type Description
Parser<ForceReturnFacetAction>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Rule.ForceReturnFacetAction getDefaultInstanceForType()
Returns
Type Description
Rule.ForceReturnFacetAction

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 3 instances here.

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

Parameter
Name Description
index int
Returns
Type Description
Rule.ForceReturnFacetAction.FacetPositionAdjustment

getFacetPositionAdjustmentsCount()

public int getFacetPositionAdjustmentsCount()

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

repeated .google.cloud.retail.v2alpha.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 3 instances here.

repeated .google.cloud.retail.v2alpha.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 3 instances here.

repeated .google.cloud.retail.v2alpha.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 3 instances here.

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

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

getParserForType()

public Parser<Rule.ForceReturnFacetAction> getParserForType()
Returns
Type Description
Parser<ForceReturnFacetAction>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Rule.ForceReturnFacetAction.Builder newBuilderForType()
Returns
Type Description
Rule.ForceReturnFacetAction.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Rule.ForceReturnFacetAction.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Rule.ForceReturnFacetAction.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Rule.ForceReturnFacetAction.Builder toBuilder()
Returns
Type Description
Rule.ForceReturnFacetAction.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException