Class Rule.RemoveFacetAction (2.55.0) 

public static final class Rule.RemoveFacetAction extends GeneratedMessageV3 implements Rule.RemoveFacetActionOrBuilder

Removes an attribute/facet in the request if is present.

  • 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 Input: attribute name

  • Action Result: Will remove the attribute (as a facet) from the request if it is present.

    Example: Suppose the query is "shoes", the Condition.query_terms is "shoes" and the attribute name "size", then facet key "size" will be removed from the request (if it is present).

Protobuf type google.cloud.retail.v2alpha.Rule.RemoveFacetAction

Inheritance

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

Static Fields

ATTRIBUTE_NAMES_FIELD_NUMBER

public static final int ATTRIBUTE_NAMES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Rule.RemoveFacetAction getDefaultInstance()
Returns
Type Description
Rule.RemoveFacetAction

getDescriptor()

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

newBuilder()

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

newBuilder(Rule.RemoveFacetAction prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAttributeNames(int index)

public String getAttributeNames(int index)

The attribute names (i.e. facet keys) to remove from the dynamic facets (if present in the request). There can't be more 3 attribute names. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters.

repeated string attribute_names = 1;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The attributeNames at the given index.

getAttributeNamesBytes(int index)

public ByteString getAttributeNamesBytes(int index)

The attribute names (i.e. facet keys) to remove from the dynamic facets (if present in the request). There can't be more 3 attribute names. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters.

repeated string attribute_names = 1;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the attributeNames at the given index.

getAttributeNamesCount()

public int getAttributeNamesCount()

The attribute names (i.e. facet keys) to remove from the dynamic facets (if present in the request). There can't be more 3 attribute names. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters.

repeated string attribute_names = 1;

Returns
Type Description
int

The count of attributeNames.

getAttributeNamesList()

public ProtocolStringList getAttributeNamesList()

The attribute names (i.e. facet keys) to remove from the dynamic facets (if present in the request). There can't be more 3 attribute names. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters.

repeated string attribute_names = 1;

Returns
Type Description
ProtocolStringList

A list containing the attributeNames.

getDefaultInstanceForType()

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

getParserForType()

public Parser<Rule.RemoveFacetAction> getParserForType()
Returns
Type Description
Parser<RemoveFacetAction>
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.RemoveFacetAction.Builder newBuilderForType()
Returns
Type Description
Rule.RemoveFacetAction.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Rule.RemoveFacetAction.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Rule.RemoveFacetAction.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.RemoveFacetAction.Builder toBuilder()
Returns
Type Description
Rule.RemoveFacetAction.Builder

writeTo(CodedOutputStream output)

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