Class Rule (2.56.0)

public final class Rule extends GeneratedMessageV3 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.v2.Rule

Inheritance

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

Implements

RuleOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

BOOST_ACTION_FIELD_NUMBER

public static final int BOOST_ACTION_FIELD_NUMBER

Field Value
Type	Description
`int`

CONDITION_FIELD_NUMBER

public static final int CONDITION_FIELD_NUMBER

Field Value
Type	Description
`int`

DO_NOT_ASSOCIATE_ACTION_FIELD_NUMBER

public static final int DO_NOT_ASSOCIATE_ACTION_FIELD_NUMBER

Field Value
Type	Description
`int`

FILTER_ACTION_FIELD_NUMBER

public static final int FILTER_ACTION_FIELD_NUMBER

Field Value
Type	Description
`int`

FORCE_RETURN_FACET_ACTION_FIELD_NUMBER

public static final int FORCE_RETURN_FACET_ACTION_FIELD_NUMBER

Field Value
Type	Description
`int`

IGNORE_ACTION_FIELD_NUMBER

public static final int IGNORE_ACTION_FIELD_NUMBER

Field Value
Type	Description
`int`

ONEWAY_SYNONYMS_ACTION_FIELD_NUMBER

public static final int ONEWAY_SYNONYMS_ACTION_FIELD_NUMBER

Field Value
Type	Description
`int`

REDIRECT_ACTION_FIELD_NUMBER

public static final int REDIRECT_ACTION_FIELD_NUMBER

Field Value
Type	Description
`int`

REMOVE_FACET_ACTION_FIELD_NUMBER

public static final int REMOVE_FACET_ACTION_FIELD_NUMBER

Field Value
Type	Description
`int`

REPLACEMENT_ACTION_FIELD_NUMBER

public static final int REPLACEMENT_ACTION_FIELD_NUMBER

Field Value
Type	Description
`int`

TWOWAY_SYNONYMS_ACTION_FIELD_NUMBER

public static final int TWOWAY_SYNONYMS_ACTION_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static Rule getDefaultInstance()

Returns
Type	Description
`Rule`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static Rule.Builder newBuilder()

Returns
Type	Description
`Rule.Builder`

newBuilder(Rule prototype)

public static Rule.Builder newBuilder(Rule prototype)

Parameter
Name	Description
`prototype`	`Rule`

Returns
Type	Description
`Rule.Builder`

parseDelimitedFrom(InputStream input)

public static Rule parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`Rule`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Rule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Rule`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static Rule parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`Rule`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Rule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Rule`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static Rule parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`Rule`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Rule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Rule`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static Rule parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`Rule`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Rule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Returns
Type	Description
`Rule`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static Rule parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`Rule`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Rule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Rule`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static Rule parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`Rule`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Rule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Rule`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<Rule> parser()

Returns
Type	Description
`Parser<Rule>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getActionCase()

public Rule.ActionCase getActionCase()

Returns
Type	Description
`Rule.ActionCase`

getBoostAction()

public Rule.BoostAction getBoostAction()

A boost action.

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

Returns
Type	Description
`Rule.BoostAction`	The boostAction.

getBoostActionOrBuilder()

public Rule.BoostActionOrBuilder getBoostActionOrBuilder()

A boost action.

.google.cloud.retail.v2.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.v2.Condition condition = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`Condition`	The condition.

getConditionOrBuilder()

public 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`

getDefaultInstanceForType()

public Rule getDefaultInstanceForType()

Returns
Type	Description
`Rule`

getDoNotAssociateAction()

public 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 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 Rule.FilterAction getFilterAction()

Filters results.

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

Returns
Type	Description
`Rule.FilterAction`	The filterAction.

getFilterActionOrBuilder()

public Rule.FilterActionOrBuilder getFilterActionOrBuilder()

Filters results.

.google.cloud.retail.v2.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.v2.Rule.ForceReturnFacetAction force_return_facet_action = 12;

Returns
Type	Description
`Rule.ForceReturnFacetAction`	The forceReturnFacetAction.

getForceReturnFacetActionOrBuilder()

public 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 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 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 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 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`

getParserForType()

public Parser<Rule> getParserForType()

Returns
Type	Description
`Parser<Rule>`

Overrides

GeneratedMessageV3.getParserForType()

getRedirectAction()

public 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 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 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 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 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 Rule.ReplacementActionOrBuilder getReplacementActionOrBuilder()

Replaces specific terms in the query.

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

Returns
Type	Description
`Rule.ReplacementActionOrBuilder`

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

getTwowaySynonymsAction()

public 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 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 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 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 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 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 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 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 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 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 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 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 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.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public Rule.Builder newBuilderForType()

Returns
Type	Description
`Rule.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Rule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`Rule.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Rule.Builder toBuilder()

Returns
Type	Description
`Rule.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`