Interface RuleOrBuilder (2.55.0)

Version latest

• 2.55.0 (latest)
• 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 interface RuleOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getActionCase()

public abstract Rule.ActionCase getActionCase()

Returns
Type	Description
Rule.ActionCase

getBoostAction()

public abstract Rule.BoostAction getBoostAction()

A boost action.

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

Returns
Type	Description
Rule.BoostAction	The boostAction.

getBoostActionOrBuilder()

public abstract Rule.BoostActionOrBuilder getBoostActionOrBuilder()

A boost action.

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

Returns
Type	Description
Rule.BoostActionOrBuilder

getCondition()

public abstract Condition getCondition()

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

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

Returns
Type	Description
Condition	The condition.

getConditionOrBuilder()

public abstract ConditionOrBuilder getConditionOrBuilder()

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

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

Returns
Type	Description
ConditionOrBuilder

getDoNotAssociateAction()

public abstract Rule.DoNotAssociateAction getDoNotAssociateAction()

Prevents term from being associated with other terms.

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

Returns
Type	Description
Rule.DoNotAssociateAction	The doNotAssociateAction.

getDoNotAssociateActionOrBuilder()

public abstract Rule.DoNotAssociateActionOrBuilder getDoNotAssociateActionOrBuilder()

Prevents term from being associated with other terms.

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

Returns
Type	Description
Rule.DoNotAssociateActionOrBuilder

getFilterAction()

public abstract Rule.FilterAction getFilterAction()

Filters results.

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

Returns
Type	Description
Rule.FilterAction	The filterAction.

getFilterActionOrBuilder()

public abstract Rule.FilterActionOrBuilder getFilterActionOrBuilder()

Filters results.

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

Returns
Type	Description
Rule.FilterActionOrBuilder

getForceReturnFacetAction()

public abstract Rule.ForceReturnFacetAction getForceReturnFacetAction()

Force returns an attribute as a facet in the request.

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

Returns
Type	Description
Rule.ForceReturnFacetAction	The forceReturnFacetAction.

getForceReturnFacetActionOrBuilder()

public abstract Rule.ForceReturnFacetActionOrBuilder getForceReturnFacetActionOrBuilder()

Force returns an attribute as a facet in the request.

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

Returns
Type	Description
Rule.ForceReturnFacetActionOrBuilder

getIgnoreAction()

public abstract Rule.IgnoreAction getIgnoreAction()

Ignores specific terms from query during search.

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

Returns
Type	Description
Rule.IgnoreAction	The ignoreAction.

getIgnoreActionOrBuilder()

public abstract Rule.IgnoreActionOrBuilder getIgnoreActionOrBuilder()

Ignores specific terms from query during search.

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

Returns
Type	Description
Rule.IgnoreActionOrBuilder

getOnewaySynonymsAction()

public abstract 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.v2.Rule.OnewaySynonymsAction oneway_synonyms_action = 6;

Returns
Type	Description
Rule.OnewaySynonymsAction	The onewaySynonymsAction.

getOnewaySynonymsActionOrBuilder()

public abstract 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.v2.Rule.OnewaySynonymsAction oneway_synonyms_action = 6;

Returns
Type	Description
Rule.OnewaySynonymsActionOrBuilder

getRedirectAction()

public abstract Rule.RedirectAction getRedirectAction()

Redirects a shopper to a specific page.

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

Returns
Type	Description
Rule.RedirectAction	The redirectAction.

getRedirectActionOrBuilder()

public abstract Rule.RedirectActionOrBuilder getRedirectActionOrBuilder()

Redirects a shopper to a specific page.

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

Returns
Type	Description
Rule.RedirectActionOrBuilder

getRemoveFacetAction()

public abstract Rule.RemoveFacetAction getRemoveFacetAction()

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

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

Returns
Type	Description
Rule.RemoveFacetAction	The removeFacetAction.

getRemoveFacetActionOrBuilder()

public abstract Rule.RemoveFacetActionOrBuilder getRemoveFacetActionOrBuilder()

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

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

Returns
Type	Description
Rule.RemoveFacetActionOrBuilder

getReplacementAction()

public abstract Rule.ReplacementAction getReplacementAction()

Replaces specific terms in the query.

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

Returns
Type	Description
Rule.ReplacementAction	The replacementAction.

getReplacementActionOrBuilder()

public abstract Rule.ReplacementActionOrBuilder getReplacementActionOrBuilder()

Replaces specific terms in the query.

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

Returns
Type	Description
Rule.ReplacementActionOrBuilder

getTwowaySynonymsAction()

public abstract Rule.TwowaySynonymsAction getTwowaySynonymsAction()

Treats a set of terms as synonyms of one another.

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

Returns
Type	Description
Rule.TwowaySynonymsAction	The twowaySynonymsAction.

getTwowaySynonymsActionOrBuilder()

public abstract Rule.TwowaySynonymsActionOrBuilder getTwowaySynonymsActionOrBuilder()

Treats a set of terms as synonyms of one another.

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

Returns
Type	Description
Rule.TwowaySynonymsActionOrBuilder

hasBoostAction()

public abstract boolean hasBoostAction()

A boost action.

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

Returns
Type	Description
boolean	Whether the boostAction field is set.

hasCondition()

public abstract boolean hasCondition()

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

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

Returns
Type	Description
boolean	Whether the condition field is set.

hasDoNotAssociateAction()

public abstract boolean hasDoNotAssociateAction()

Prevents term from being associated with other terms.

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

Returns
Type	Description
boolean	Whether the doNotAssociateAction field is set.

hasFilterAction()

public abstract boolean hasFilterAction()

Filters results.

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

Returns
Type	Description
boolean	Whether the filterAction field is set.

hasForceReturnFacetAction()

public abstract boolean hasForceReturnFacetAction()

Force returns an attribute as a facet in the request.

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

Returns
Type	Description
boolean	Whether the forceReturnFacetAction field is set.

hasIgnoreAction()

public abstract boolean hasIgnoreAction()

Ignores specific terms from query during search.

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

Returns
Type	Description
boolean	Whether the ignoreAction field is set.

hasOnewaySynonymsAction()

public abstract 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.v2.Rule.OnewaySynonymsAction oneway_synonyms_action = 6;

Returns
Type	Description
boolean	Whether the onewaySynonymsAction field is set.

hasRedirectAction()

public abstract boolean hasRedirectAction()

Redirects a shopper to a specific page.

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

Returns
Type	Description
boolean	Whether the redirectAction field is set.

hasRemoveFacetAction()

public abstract boolean hasRemoveFacetAction()

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

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

Returns
Type	Description
boolean	Whether the removeFacetAction field is set.

hasReplacementAction()

public abstract boolean hasReplacementAction()

Replaces specific terms in the query.

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

Returns
Type	Description
boolean	Whether the replacementAction field is set.

hasTwowaySynonymsAction()

public abstract boolean hasTwowaySynonymsAction()

Treats a set of terms as synonyms of one another.

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

Returns
Type	Description
boolean	Whether the twowaySynonymsAction field is set.