Class Rule.Builder (2.78.0)

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

A rule is a condition-action pair

A condition defines when a rule is to be triggered.
An action specifies what occurs on that trigger. Currently rules only work for controls with SOLUTION_TYPE_SEARCH.

Protobuf type google.cloud.retail.v2beta.Rule

Inheritance

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

Implements

RuleOrBuilder

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

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

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

Returns
Type	Description
`Rule.Builder`

Overrides

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

build()

public Rule build()

Returns
Type	Description
`Rule`

buildPartial()

public Rule buildPartial()

Returns
Type	Description
`Rule`

clear()

public Rule.Builder clear()

Returns
Type	Description
`Rule.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAction()

public Rule.Builder clearAction()

Returns
Type	Description
`Rule.Builder`

clearBoostAction()

public Rule.Builder clearBoostAction()

A boost action.

.google.cloud.retail.v2beta.Rule.BoostAction boost_action = 2;

Returns
Type	Description
`Rule.Builder`

clearCondition()

public Rule.Builder clearCondition()

Required. The condition that triggers the rule. If the condition is empty, the rule will always apply.

.google.cloud.retail.v2beta.Condition condition = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`Rule.Builder`

clearDoNotAssociateAction()

public Rule.Builder clearDoNotAssociateAction()

Prevents term from being associated with other terms.

.google.cloud.retail.v2beta.Rule.DoNotAssociateAction do_not_associate_action = 7;

Returns
Type	Description
`Rule.Builder`

clearField(Descriptors.FieldDescriptor field)

public Rule.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`Rule.Builder`

Overrides

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

clearFilterAction()

public Rule.Builder clearFilterAction()

Filters results.

.google.cloud.retail.v2beta.Rule.FilterAction filter_action = 10;

Returns
Type	Description
`Rule.Builder`

clearForceReturnFacetAction()

public Rule.Builder clearForceReturnFacetAction()

Force returns an attribute as a facet in the request.

.google.cloud.retail.v2beta.Rule.ForceReturnFacetAction force_return_facet_action = 12;

Returns
Type	Description
`Rule.Builder`

clearIgnoreAction()

public Rule.Builder clearIgnoreAction()

Ignores specific terms from query during search.

.google.cloud.retail.v2beta.Rule.IgnoreAction ignore_action = 9;

Returns
Type	Description
`Rule.Builder`

clearOneof(Descriptors.OneofDescriptor oneof)

public Rule.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`Rule.Builder`

Overrides

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

clearOnewaySynonymsAction()

public Rule.Builder clearOnewaySynonymsAction()

Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.

.google.cloud.retail.v2beta.Rule.OnewaySynonymsAction oneway_synonyms_action = 6;

Returns
Type	Description
`Rule.Builder`

clearPinAction()

public Rule.Builder clearPinAction()

Pins one or more specified products to a specific position in the results.

.google.cloud.retail.v2beta.Rule.PinAction pin_action = 14;

Returns
Type	Description
`Rule.Builder`

clearRedirectAction()

public Rule.Builder clearRedirectAction()

Redirects a shopper to a specific page.

.google.cloud.retail.v2beta.Rule.RedirectAction redirect_action = 3;

Returns
Type	Description
`Rule.Builder`

clearRemoveFacetAction()

public Rule.Builder clearRemoveFacetAction()

Remove an attribute as a facet in the request (if present).

.google.cloud.retail.v2beta.Rule.RemoveFacetAction remove_facet_action = 13;

Returns
Type	Description
`Rule.Builder`

clearReplacementAction()

public Rule.Builder clearReplacementAction()

Replaces specific terms in the query.

.google.cloud.retail.v2beta.Rule.ReplacementAction replacement_action = 8;

Returns
Type	Description
`Rule.Builder`

clearTwowaySynonymsAction()

public Rule.Builder clearTwowaySynonymsAction()

Treats a set of terms as synonyms of one another.

.google.cloud.retail.v2beta.Rule.TwowaySynonymsAction twoway_synonyms_action = 11;

Returns
Type	Description
`Rule.Builder`

clone()

public Rule.Builder clone()

Returns
Type	Description
`Rule.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getActionCase()

public Rule.ActionCase getActionCase()

Returns
Type	Description
`Rule.ActionCase`

getBoostAction()

public Rule.BoostAction getBoostAction()

A boost action.

.google.cloud.retail.v2beta.Rule.BoostAction boost_action = 2;

Returns
Type	Description
`Rule.BoostAction`	The boostAction.

getBoostActionBuilder()

public Rule.BoostAction.Builder getBoostActionBuilder()

A boost action.

.google.cloud.retail.v2beta.Rule.BoostAction boost_action = 2;

Returns
Type	Description
`Rule.BoostAction.Builder`

getBoostActionOrBuilder()

public Rule.BoostActionOrBuilder getBoostActionOrBuilder()

A boost action.

.google.cloud.retail.v2beta.Rule.BoostAction boost_action = 2;

Returns
Type	Description
`Rule.BoostActionOrBuilder`

getCondition()

public Condition getCondition()

Required. The condition that triggers the rule. If the condition is empty, the rule will always apply.

.google.cloud.retail.v2beta.Condition condition = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`Condition`	The condition.

getConditionBuilder()

public Condition.Builder getConditionBuilder()

Required. The condition that triggers the rule. If the condition is empty, the rule will always apply.

.google.cloud.retail.v2beta.Condition condition = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`Condition.Builder`

getConditionOrBuilder()

public ConditionOrBuilder getConditionOrBuilder()

Required. The condition that triggers the rule. If the condition is empty, the rule will always apply.

.google.cloud.retail.v2beta.Condition condition = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`ConditionOrBuilder`

getDefaultInstanceForType()

public Rule getDefaultInstanceForType()

Returns
Type	Description
`Rule`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDoNotAssociateAction()

public Rule.DoNotAssociateAction getDoNotAssociateAction()

Prevents term from being associated with other terms.

.google.cloud.retail.v2beta.Rule.DoNotAssociateAction do_not_associate_action = 7;

Returns
Type	Description
`Rule.DoNotAssociateAction`	The doNotAssociateAction.

getDoNotAssociateActionBuilder()

public Rule.DoNotAssociateAction.Builder getDoNotAssociateActionBuilder()

Prevents term from being associated with other terms.

.google.cloud.retail.v2beta.Rule.DoNotAssociateAction do_not_associate_action = 7;

Returns
Type	Description
`Rule.DoNotAssociateAction.Builder`

getDoNotAssociateActionOrBuilder()

public Rule.DoNotAssociateActionOrBuilder getDoNotAssociateActionOrBuilder()

Prevents term from being associated with other terms.

.google.cloud.retail.v2beta.Rule.DoNotAssociateAction do_not_associate_action = 7;

Returns
Type	Description
`Rule.DoNotAssociateActionOrBuilder`

getFilterAction()

public Rule.FilterAction getFilterAction()

Filters results.

.google.cloud.retail.v2beta.Rule.FilterAction filter_action = 10;

Returns
Type	Description
`Rule.FilterAction`	The filterAction.

getFilterActionBuilder()

public Rule.FilterAction.Builder getFilterActionBuilder()

Filters results.

.google.cloud.retail.v2beta.Rule.FilterAction filter_action = 10;

Returns
Type	Description
`Rule.FilterAction.Builder`

getFilterActionOrBuilder()

public Rule.FilterActionOrBuilder getFilterActionOrBuilder()

Filters results.

.google.cloud.retail.v2beta.Rule.FilterAction filter_action = 10;

Returns
Type	Description
`Rule.FilterActionOrBuilder`

getForceReturnFacetAction()

public Rule.ForceReturnFacetAction getForceReturnFacetAction()

Force returns an attribute as a facet in the request.

.google.cloud.retail.v2beta.Rule.ForceReturnFacetAction force_return_facet_action = 12;

Returns
Type	Description
`Rule.ForceReturnFacetAction`	The forceReturnFacetAction.

getForceReturnFacetActionBuilder()

public Rule.ForceReturnFacetAction.Builder getForceReturnFacetActionBuilder()

Force returns an attribute as a facet in the request.

.google.cloud.retail.v2beta.Rule.ForceReturnFacetAction force_return_facet_action = 12;

Returns
Type	Description
`Rule.ForceReturnFacetAction.Builder`

getForceReturnFacetActionOrBuilder()

public Rule.ForceReturnFacetActionOrBuilder getForceReturnFacetActionOrBuilder()

Force returns an attribute as a facet in the request.

.google.cloud.retail.v2beta.Rule.ForceReturnFacetAction force_return_facet_action = 12;

Returns
Type	Description
`Rule.ForceReturnFacetActionOrBuilder`

getIgnoreAction()

public Rule.IgnoreAction getIgnoreAction()

Ignores specific terms from query during search.

.google.cloud.retail.v2beta.Rule.IgnoreAction ignore_action = 9;

Returns
Type	Description
`Rule.IgnoreAction`	The ignoreAction.

getIgnoreActionBuilder()

public Rule.IgnoreAction.Builder getIgnoreActionBuilder()

Ignores specific terms from query during search.

.google.cloud.retail.v2beta.Rule.IgnoreAction ignore_action = 9;

Returns
Type	Description
`Rule.IgnoreAction.Builder`

getIgnoreActionOrBuilder()

public Rule.IgnoreActionOrBuilder getIgnoreActionOrBuilder()

Ignores specific terms from query during search.

.google.cloud.retail.v2beta.Rule.IgnoreAction ignore_action = 9;

Returns
Type	Description
`Rule.IgnoreActionOrBuilder`

getOnewaySynonymsAction()

public Rule.OnewaySynonymsAction getOnewaySynonymsAction()

Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.

.google.cloud.retail.v2beta.Rule.OnewaySynonymsAction oneway_synonyms_action = 6;

Returns
Type	Description
`Rule.OnewaySynonymsAction`	The onewaySynonymsAction.

getOnewaySynonymsActionBuilder()

public Rule.OnewaySynonymsAction.Builder getOnewaySynonymsActionBuilder()

Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.

.google.cloud.retail.v2beta.Rule.OnewaySynonymsAction oneway_synonyms_action = 6;

Returns
Type	Description
`Rule.OnewaySynonymsAction.Builder`

getOnewaySynonymsActionOrBuilder()

public Rule.OnewaySynonymsActionOrBuilder getOnewaySynonymsActionOrBuilder()

Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.

.google.cloud.retail.v2beta.Rule.OnewaySynonymsAction oneway_synonyms_action = 6;

Returns
Type	Description
`Rule.OnewaySynonymsActionOrBuilder`

getPinAction()

public Rule.PinAction getPinAction()

Pins one or more specified products to a specific position in the results.

.google.cloud.retail.v2beta.Rule.PinAction pin_action = 14;

Returns
Type	Description
`Rule.PinAction`	The pinAction.

getPinActionBuilder()

public Rule.PinAction.Builder getPinActionBuilder()

Pins one or more specified products to a specific position in the results.

.google.cloud.retail.v2beta.Rule.PinAction pin_action = 14;

Returns
Type	Description
`Rule.PinAction.Builder`

getPinActionOrBuilder()

public Rule.PinActionOrBuilder getPinActionOrBuilder()

Pins one or more specified products to a specific position in the results.

.google.cloud.retail.v2beta.Rule.PinAction pin_action = 14;

Returns
Type	Description
`Rule.PinActionOrBuilder`

getRedirectAction()

public Rule.RedirectAction getRedirectAction()

Redirects a shopper to a specific page.

.google.cloud.retail.v2beta.Rule.RedirectAction redirect_action = 3;

Returns
Type	Description
`Rule.RedirectAction`	The redirectAction.

getRedirectActionBuilder()

public Rule.RedirectAction.Builder getRedirectActionBuilder()

Redirects a shopper to a specific page.

.google.cloud.retail.v2beta.Rule.RedirectAction redirect_action = 3;

Returns
Type	Description
`Rule.RedirectAction.Builder`

getRedirectActionOrBuilder()

public Rule.RedirectActionOrBuilder getRedirectActionOrBuilder()

Redirects a shopper to a specific page.

.google.cloud.retail.v2beta.Rule.RedirectAction redirect_action = 3;

Returns
Type	Description
`Rule.RedirectActionOrBuilder`

getRemoveFacetAction()

public Rule.RemoveFacetAction getRemoveFacetAction()

Remove an attribute as a facet in the request (if present).

.google.cloud.retail.v2beta.Rule.RemoveFacetAction remove_facet_action = 13;

Returns
Type	Description
`Rule.RemoveFacetAction`	The removeFacetAction.

getRemoveFacetActionBuilder()

public Rule.RemoveFacetAction.Builder getRemoveFacetActionBuilder()

Remove an attribute as a facet in the request (if present).

.google.cloud.retail.v2beta.Rule.RemoveFacetAction remove_facet_action = 13;

Returns
Type	Description
`Rule.RemoveFacetAction.Builder`

getRemoveFacetActionOrBuilder()

public Rule.RemoveFacetActionOrBuilder getRemoveFacetActionOrBuilder()

Remove an attribute as a facet in the request (if present).

.google.cloud.retail.v2beta.Rule.RemoveFacetAction remove_facet_action = 13;

Returns
Type	Description
`Rule.RemoveFacetActionOrBuilder`

getReplacementAction()

public Rule.ReplacementAction getReplacementAction()

Replaces specific terms in the query.

.google.cloud.retail.v2beta.Rule.ReplacementAction replacement_action = 8;

Returns
Type	Description
`Rule.ReplacementAction`	The replacementAction.

getReplacementActionBuilder()

public Rule.ReplacementAction.Builder getReplacementActionBuilder()

Replaces specific terms in the query.

.google.cloud.retail.v2beta.Rule.ReplacementAction replacement_action = 8;

Returns
Type	Description
`Rule.ReplacementAction.Builder`

getReplacementActionOrBuilder()

public Rule.ReplacementActionOrBuilder getReplacementActionOrBuilder()

Replaces specific terms in the query.

.google.cloud.retail.v2beta.Rule.ReplacementAction replacement_action = 8;

Returns
Type	Description
`Rule.ReplacementActionOrBuilder`

getTwowaySynonymsAction()

public Rule.TwowaySynonymsAction getTwowaySynonymsAction()

Treats a set of terms as synonyms of one another.

.google.cloud.retail.v2beta.Rule.TwowaySynonymsAction twoway_synonyms_action = 11;

Returns
Type	Description
`Rule.TwowaySynonymsAction`	The twowaySynonymsAction.

getTwowaySynonymsActionBuilder()

public Rule.TwowaySynonymsAction.Builder getTwowaySynonymsActionBuilder()

Treats a set of terms as synonyms of one another.

.google.cloud.retail.v2beta.Rule.TwowaySynonymsAction twoway_synonyms_action = 11;

Returns
Type	Description
`Rule.TwowaySynonymsAction.Builder`

getTwowaySynonymsActionOrBuilder()

public Rule.TwowaySynonymsActionOrBuilder getTwowaySynonymsActionOrBuilder()

Treats a set of terms as synonyms of one another.

.google.cloud.retail.v2beta.Rule.TwowaySynonymsAction twoway_synonyms_action = 11;

Returns
Type	Description
`Rule.TwowaySynonymsActionOrBuilder`

hasBoostAction()

public boolean hasBoostAction()

A boost action.

.google.cloud.retail.v2beta.Rule.BoostAction boost_action = 2;

Returns
Type	Description
`boolean`	Whether the boostAction field is set.

hasCondition()

public boolean hasCondition()

Required. The condition that triggers the rule. If the condition is empty, the rule will always apply.

.google.cloud.retail.v2beta.Condition condition = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`boolean`	Whether the condition field is set.

hasDoNotAssociateAction()

public boolean hasDoNotAssociateAction()

Prevents term from being associated with other terms.

.google.cloud.retail.v2beta.Rule.DoNotAssociateAction do_not_associate_action = 7;

Returns
Type	Description
`boolean`	Whether the doNotAssociateAction field is set.

hasFilterAction()

public boolean hasFilterAction()

Filters results.

.google.cloud.retail.v2beta.Rule.FilterAction filter_action = 10;

Returns
Type	Description
`boolean`	Whether the filterAction field is set.

hasForceReturnFacetAction()

public boolean hasForceReturnFacetAction()

Force returns an attribute as a facet in the request.

.google.cloud.retail.v2beta.Rule.ForceReturnFacetAction force_return_facet_action = 12;

Returns
Type	Description
`boolean`	Whether the forceReturnFacetAction field is set.

hasIgnoreAction()

public boolean hasIgnoreAction()

Ignores specific terms from query during search.

.google.cloud.retail.v2beta.Rule.IgnoreAction ignore_action = 9;

Returns
Type	Description
`boolean`	Whether the ignoreAction field is set.

hasOnewaySynonymsAction()

public boolean hasOnewaySynonymsAction()

Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.

.google.cloud.retail.v2beta.Rule.OnewaySynonymsAction oneway_synonyms_action = 6;

Returns
Type	Description
`boolean`	Whether the onewaySynonymsAction field is set.

hasPinAction()

public boolean hasPinAction()

Pins one or more specified products to a specific position in the results.

.google.cloud.retail.v2beta.Rule.PinAction pin_action = 14;

Returns
Type	Description
`boolean`	Whether the pinAction field is set.

hasRedirectAction()

public boolean hasRedirectAction()

Redirects a shopper to a specific page.

.google.cloud.retail.v2beta.Rule.RedirectAction redirect_action = 3;

Returns
Type	Description
`boolean`	Whether the redirectAction field is set.

hasRemoveFacetAction()

public boolean hasRemoveFacetAction()

Remove an attribute as a facet in the request (if present).

.google.cloud.retail.v2beta.Rule.RemoveFacetAction remove_facet_action = 13;

Returns
Type	Description
`boolean`	Whether the removeFacetAction field is set.

hasReplacementAction()

public boolean hasReplacementAction()

Replaces specific terms in the query.

.google.cloud.retail.v2beta.Rule.ReplacementAction replacement_action = 8;

Returns
Type	Description
`boolean`	Whether the replacementAction field is set.

hasTwowaySynonymsAction()

public boolean hasTwowaySynonymsAction()

Treats a set of terms as synonyms of one another.

.google.cloud.retail.v2beta.Rule.TwowaySynonymsAction twoway_synonyms_action = 11;

Returns
Type	Description
`boolean`	Whether the twowaySynonymsAction field is set.

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()

mergeBoostAction(Rule.BoostAction value)

public Rule.Builder mergeBoostAction(Rule.BoostAction value)

A boost action.

.google.cloud.retail.v2beta.Rule.BoostAction boost_action = 2;

Parameter
Name	Description
`value`	`Rule.BoostAction`

Returns
Type	Description
`Rule.Builder`

mergeCondition(Condition value)

public Rule.Builder mergeCondition(Condition value)

Required. The condition that triggers the rule. If the condition is empty, the rule will always apply.

.google.cloud.retail.v2beta.Condition condition = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`value`	`Condition`

Returns
Type	Description
`Rule.Builder`

mergeDoNotAssociateAction(Rule.DoNotAssociateAction value)

public Rule.Builder mergeDoNotAssociateAction(Rule.DoNotAssociateAction value)

Prevents term from being associated with other terms.

.google.cloud.retail.v2beta.Rule.DoNotAssociateAction do_not_associate_action = 7;

Parameter
Name	Description
`value`	`Rule.DoNotAssociateAction`

Returns
Type	Description
`Rule.Builder`

mergeFilterAction(Rule.FilterAction value)

public Rule.Builder mergeFilterAction(Rule.FilterAction value)

Filters results.

.google.cloud.retail.v2beta.Rule.FilterAction filter_action = 10;

Parameter
Name	Description
`value`	`Rule.FilterAction`

Returns
Type	Description
`Rule.Builder`

mergeForceReturnFacetAction(Rule.ForceReturnFacetAction value)

public Rule.Builder mergeForceReturnFacetAction(Rule.ForceReturnFacetAction value)

Force returns an attribute as a facet in the request.

.google.cloud.retail.v2beta.Rule.ForceReturnFacetAction force_return_facet_action = 12;

Parameter
Name	Description
`value`	`Rule.ForceReturnFacetAction`

Returns
Type	Description
`Rule.Builder`

mergeFrom(Rule other)

public Rule.Builder mergeFrom(Rule other)

Parameter
Name	Description
`other`	`Rule`

Returns
Type	Description
`Rule.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

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

Returns
Type	Description
`Rule.Builder`

Overrides

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

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public Rule.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`Rule.Builder`

Overrides

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

mergeIgnoreAction(Rule.IgnoreAction value)

public Rule.Builder mergeIgnoreAction(Rule.IgnoreAction value)

Ignores specific terms from query during search.

.google.cloud.retail.v2beta.Rule.IgnoreAction ignore_action = 9;

Parameter
Name	Description
`value`	`Rule.IgnoreAction`

Returns
Type	Description
`Rule.Builder`

mergeOnewaySynonymsAction(Rule.OnewaySynonymsAction value)

public Rule.Builder mergeOnewaySynonymsAction(Rule.OnewaySynonymsAction value)

Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.

.google.cloud.retail.v2beta.Rule.OnewaySynonymsAction oneway_synonyms_action = 6;

Parameter
Name	Description
`value`	`Rule.OnewaySynonymsAction`

Returns
Type	Description
`Rule.Builder`

mergePinAction(Rule.PinAction value)

public Rule.Builder mergePinAction(Rule.PinAction value)

Pins one or more specified products to a specific position in the results.

.google.cloud.retail.v2beta.Rule.PinAction pin_action = 14;

Parameter
Name	Description
`value`	`Rule.PinAction`

Returns
Type	Description
`Rule.Builder`

mergeRedirectAction(Rule.RedirectAction value)

public Rule.Builder mergeRedirectAction(Rule.RedirectAction value)

Redirects a shopper to a specific page.

.google.cloud.retail.v2beta.Rule.RedirectAction redirect_action = 3;

Parameter
Name	Description
`value`	`Rule.RedirectAction`

Returns
Type	Description
`Rule.Builder`

mergeRemoveFacetAction(Rule.RemoveFacetAction value)

public Rule.Builder mergeRemoveFacetAction(Rule.RemoveFacetAction value)

Remove an attribute as a facet in the request (if present).

.google.cloud.retail.v2beta.Rule.RemoveFacetAction remove_facet_action = 13;

Parameter
Name	Description
`value`	`Rule.RemoveFacetAction`

Returns
Type	Description
`Rule.Builder`

mergeReplacementAction(Rule.ReplacementAction value)

public Rule.Builder mergeReplacementAction(Rule.ReplacementAction value)

Replaces specific terms in the query.

.google.cloud.retail.v2beta.Rule.ReplacementAction replacement_action = 8;

Parameter
Name	Description
`value`	`Rule.ReplacementAction`

Returns
Type	Description
`Rule.Builder`

mergeTwowaySynonymsAction(Rule.TwowaySynonymsAction value)

public Rule.Builder mergeTwowaySynonymsAction(Rule.TwowaySynonymsAction value)

Treats a set of terms as synonyms of one another.

.google.cloud.retail.v2beta.Rule.TwowaySynonymsAction twoway_synonyms_action = 11;

Parameter
Name	Description
`value`	`Rule.TwowaySynonymsAction`

Returns
Type	Description
`Rule.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Rule.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`Rule.Builder`

Overrides

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

setBoostAction(Rule.BoostAction value)

public Rule.Builder setBoostAction(Rule.BoostAction value)

A boost action.

.google.cloud.retail.v2beta.Rule.BoostAction boost_action = 2;

Parameter
Name	Description
`value`	`Rule.BoostAction`

Returns
Type	Description
`Rule.Builder`

setBoostAction(Rule.BoostAction.Builder builderForValue)

public Rule.Builder setBoostAction(Rule.BoostAction.Builder builderForValue)

A boost action.

.google.cloud.retail.v2beta.Rule.BoostAction boost_action = 2;

Parameter
Name	Description
`builderForValue`	`Rule.BoostAction.Builder`

Returns
Type	Description
`Rule.Builder`

setCondition(Condition value)

public Rule.Builder setCondition(Condition value)

Required. The condition that triggers the rule. If the condition is empty, the rule will always apply.

.google.cloud.retail.v2beta.Condition condition = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`value`	`Condition`

Returns
Type	Description
`Rule.Builder`

setCondition(Condition.Builder builderForValue)

public Rule.Builder setCondition(Condition.Builder builderForValue)

Required. The condition that triggers the rule. If the condition is empty, the rule will always apply.

.google.cloud.retail.v2beta.Condition condition = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`builderForValue`	`Condition.Builder`

Returns
Type	Description
`Rule.Builder`

setDoNotAssociateAction(Rule.DoNotAssociateAction value)

public Rule.Builder setDoNotAssociateAction(Rule.DoNotAssociateAction value)

Prevents term from being associated with other terms.

.google.cloud.retail.v2beta.Rule.DoNotAssociateAction do_not_associate_action = 7;

Parameter
Name	Description
`value`	`Rule.DoNotAssociateAction`

Returns
Type	Description
`Rule.Builder`

setDoNotAssociateAction(Rule.DoNotAssociateAction.Builder builderForValue)

public Rule.Builder setDoNotAssociateAction(Rule.DoNotAssociateAction.Builder builderForValue)

Prevents term from being associated with other terms.

.google.cloud.retail.v2beta.Rule.DoNotAssociateAction do_not_associate_action = 7;

Parameter
Name	Description
`builderForValue`	`Rule.DoNotAssociateAction.Builder`

Returns
Type	Description
`Rule.Builder`

setField(Descriptors.FieldDescriptor field, Object value)

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

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

Returns
Type	Description
`Rule.Builder`

Overrides

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

setFilterAction(Rule.FilterAction value)

public Rule.Builder setFilterAction(Rule.FilterAction value)

Filters results.

.google.cloud.retail.v2beta.Rule.FilterAction filter_action = 10;

Parameter
Name	Description
`value`	`Rule.FilterAction`

Returns
Type	Description
`Rule.Builder`

setFilterAction(Rule.FilterAction.Builder builderForValue)

public Rule.Builder setFilterAction(Rule.FilterAction.Builder builderForValue)

Filters results.

.google.cloud.retail.v2beta.Rule.FilterAction filter_action = 10;

Parameter
Name	Description
`builderForValue`	`Rule.FilterAction.Builder`

Returns
Type	Description
`Rule.Builder`

setForceReturnFacetAction(Rule.ForceReturnFacetAction value)

public Rule.Builder setForceReturnFacetAction(Rule.ForceReturnFacetAction value)

Force returns an attribute as a facet in the request.

.google.cloud.retail.v2beta.Rule.ForceReturnFacetAction force_return_facet_action = 12;

Parameter
Name	Description
`value`	`Rule.ForceReturnFacetAction`

Returns
Type	Description
`Rule.Builder`

setForceReturnFacetAction(Rule.ForceReturnFacetAction.Builder builderForValue)

public Rule.Builder setForceReturnFacetAction(Rule.ForceReturnFacetAction.Builder builderForValue)

Force returns an attribute as a facet in the request.

.google.cloud.retail.v2beta.Rule.ForceReturnFacetAction force_return_facet_action = 12;

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

Returns
Type	Description
`Rule.Builder`

setIgnoreAction(Rule.IgnoreAction value)

public Rule.Builder setIgnoreAction(Rule.IgnoreAction value)

Ignores specific terms from query during search.

.google.cloud.retail.v2beta.Rule.IgnoreAction ignore_action = 9;

Parameter
Name	Description
`value`	`Rule.IgnoreAction`

Returns
Type	Description
`Rule.Builder`

setIgnoreAction(Rule.IgnoreAction.Builder builderForValue)

public Rule.Builder setIgnoreAction(Rule.IgnoreAction.Builder builderForValue)

Ignores specific terms from query during search.

.google.cloud.retail.v2beta.Rule.IgnoreAction ignore_action = 9;

Parameter
Name	Description
`builderForValue`	`Rule.IgnoreAction.Builder`

Returns
Type	Description
`Rule.Builder`

setOnewaySynonymsAction(Rule.OnewaySynonymsAction value)

public Rule.Builder setOnewaySynonymsAction(Rule.OnewaySynonymsAction value)

Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.

.google.cloud.retail.v2beta.Rule.OnewaySynonymsAction oneway_synonyms_action = 6;

Parameter
Name	Description
`value`	`Rule.OnewaySynonymsAction`

Returns
Type	Description
`Rule.Builder`

setOnewaySynonymsAction(Rule.OnewaySynonymsAction.Builder builderForValue)

public Rule.Builder setOnewaySynonymsAction(Rule.OnewaySynonymsAction.Builder builderForValue)

Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.

.google.cloud.retail.v2beta.Rule.OnewaySynonymsAction oneway_synonyms_action = 6;

Parameter
Name	Description
`builderForValue`	`Rule.OnewaySynonymsAction.Builder`

Returns
Type	Description
`Rule.Builder`

setPinAction(Rule.PinAction value)

public Rule.Builder setPinAction(Rule.PinAction value)

Pins one or more specified products to a specific position in the results.

.google.cloud.retail.v2beta.Rule.PinAction pin_action = 14;

Parameter
Name	Description
`value`	`Rule.PinAction`

Returns
Type	Description
`Rule.Builder`

setPinAction(Rule.PinAction.Builder builderForValue)

public Rule.Builder setPinAction(Rule.PinAction.Builder builderForValue)

Pins one or more specified products to a specific position in the results.

.google.cloud.retail.v2beta.Rule.PinAction pin_action = 14;

Parameter
Name	Description
`builderForValue`	`Rule.PinAction.Builder`

Returns
Type	Description
`Rule.Builder`

setRedirectAction(Rule.RedirectAction value)

public Rule.Builder setRedirectAction(Rule.RedirectAction value)

Redirects a shopper to a specific page.

.google.cloud.retail.v2beta.Rule.RedirectAction redirect_action = 3;

Parameter
Name	Description
`value`	`Rule.RedirectAction`

Returns
Type	Description
`Rule.Builder`

setRedirectAction(Rule.RedirectAction.Builder builderForValue)

public Rule.Builder setRedirectAction(Rule.RedirectAction.Builder builderForValue)

Redirects a shopper to a specific page.

.google.cloud.retail.v2beta.Rule.RedirectAction redirect_action = 3;

Parameter
Name	Description
`builderForValue`	`Rule.RedirectAction.Builder`

Returns
Type	Description
`Rule.Builder`

setRemoveFacetAction(Rule.RemoveFacetAction value)

public Rule.Builder setRemoveFacetAction(Rule.RemoveFacetAction value)

Remove an attribute as a facet in the request (if present).

.google.cloud.retail.v2beta.Rule.RemoveFacetAction remove_facet_action = 13;

Parameter
Name	Description
`value`	`Rule.RemoveFacetAction`

Returns
Type	Description
`Rule.Builder`

setRemoveFacetAction(Rule.RemoveFacetAction.Builder builderForValue)

public Rule.Builder setRemoveFacetAction(Rule.RemoveFacetAction.Builder builderForValue)

Remove an attribute as a facet in the request (if present).

.google.cloud.retail.v2beta.Rule.RemoveFacetAction remove_facet_action = 13;

Parameter
Name	Description
`builderForValue`	`Rule.RemoveFacetAction.Builder`

Returns
Type	Description
`Rule.Builder`

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

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

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

Returns
Type	Description
`Rule.Builder`

Overrides

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

setReplacementAction(Rule.ReplacementAction value)

public Rule.Builder setReplacementAction(Rule.ReplacementAction value)

Replaces specific terms in the query.

.google.cloud.retail.v2beta.Rule.ReplacementAction replacement_action = 8;

Parameter
Name	Description
`value`	`Rule.ReplacementAction`

Returns
Type	Description
`Rule.Builder`

setReplacementAction(Rule.ReplacementAction.Builder builderForValue)

public Rule.Builder setReplacementAction(Rule.ReplacementAction.Builder builderForValue)

Replaces specific terms in the query.

.google.cloud.retail.v2beta.Rule.ReplacementAction replacement_action = 8;

Parameter
Name	Description
`builderForValue`	`Rule.ReplacementAction.Builder`

Returns
Type	Description
`Rule.Builder`

setTwowaySynonymsAction(Rule.TwowaySynonymsAction value)

public Rule.Builder setTwowaySynonymsAction(Rule.TwowaySynonymsAction value)

Treats a set of terms as synonyms of one another.

.google.cloud.retail.v2beta.Rule.TwowaySynonymsAction twoway_synonyms_action = 11;

Parameter
Name	Description
`value`	`Rule.TwowaySynonymsAction`

Returns
Type	Description
`Rule.Builder`

setTwowaySynonymsAction(Rule.TwowaySynonymsAction.Builder builderForValue)

public Rule.Builder setTwowaySynonymsAction(Rule.TwowaySynonymsAction.Builder builderForValue)

Treats a set of terms as synonyms of one another.

.google.cloud.retail.v2beta.Rule.TwowaySynonymsAction twoway_synonyms_action = 11;

Parameter
Name	Description
`builderForValue`	`Rule.TwowaySynonymsAction.Builder`

Returns
Type	Description
`Rule.Builder`

setUnknownFields(UnknownFieldSet unknownFields)

public final Rule.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`Rule.Builder`

Overrides

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