Class Rule.IgnoreAction (2.54.0) 

public static final class Rule.IgnoreAction extends GeneratedMessageV3 implements Rule.IgnoreActionOrBuilder

Prevents a term in the query from being used in search. Example: Don't search for "shoddy".

Protobuf type google.cloud.retail.v2beta.Rule.IgnoreAction

Inheritance

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

Static Fields

IGNORE_TERMS_FIELD_NUMBER

public static final int IGNORE_TERMS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

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

getDescriptor()

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

newBuilder()

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

newBuilder(Rule.IgnoreAction prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

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

getIgnoreTerms(int index)

public String getIgnoreTerms(int index)

Terms to ignore in the search query.

repeated string ignore_terms = 1;

Parameter
Name Description
index int

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

The ignoreTerms at the given index.

getIgnoreTermsBytes(int index)

public ByteString getIgnoreTermsBytes(int index)

Terms to ignore in the search query.

repeated string ignore_terms = 1;

Parameter
Name Description
index int

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

The bytes of the ignoreTerms at the given index.

getIgnoreTermsCount()

public int getIgnoreTermsCount()

Terms to ignore in the search query.

repeated string ignore_terms = 1;

Returns
Type Description
int

The count of ignoreTerms.

getIgnoreTermsList()

public ProtocolStringList getIgnoreTermsList()

Terms to ignore in the search query.

repeated string ignore_terms = 1;

Returns
Type Description
ProtocolStringList

A list containing the ignoreTerms.

getParserForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

writeTo(CodedOutputStream output)

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