Class Rule.IgnoreAction (2.3.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

Static Fields

IGNORE_TERMS_FIELD_NUMBER

public static final int IGNORE_TERMS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Rule.IgnoreAction getDefaultInstance()
Returns
TypeDescription
Rule.IgnoreAction

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Rule.IgnoreAction.Builder newBuilder()
Returns
TypeDescription
Rule.IgnoreAction.Builder

newBuilder(Rule.IgnoreAction prototype)

public static Rule.IgnoreAction.Builder newBuilder(Rule.IgnoreAction prototype)
Parameter
NameDescription
prototypeRule.IgnoreAction
Returns
TypeDescription
Rule.IgnoreAction.Builder

parseDelimitedFrom(InputStream input)

public static Rule.IgnoreAction parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Rule.IgnoreAction
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Rule.IgnoreAction parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Rule.IgnoreAction
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Rule.IgnoreAction parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Rule.IgnoreAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Rule.IgnoreAction parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Rule.IgnoreAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Rule.IgnoreAction parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Rule.IgnoreAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Rule.IgnoreAction parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Rule.IgnoreAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Rule.IgnoreAction parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Rule.IgnoreAction
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Rule.IgnoreAction parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Rule.IgnoreAction
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Rule.IgnoreAction parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Rule.IgnoreAction
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Rule.IgnoreAction parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Rule.IgnoreAction
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Rule.IgnoreAction parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Rule.IgnoreAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Rule.IgnoreAction parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Rule.IgnoreAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public Rule.IgnoreAction getDefaultInstanceForType()
Returns
TypeDescription
Rule.IgnoreAction

getIgnoreTerms(int index)

public String getIgnoreTerms(int index)

Terms to ignore in the search query.

repeated string ignore_terms = 1;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
int

The count of ignoreTerms.

getIgnoreTermsList()

public ProtocolStringList getIgnoreTermsList()

Terms to ignore in the search query.

repeated string ignore_terms = 1;

Returns
TypeDescription
ProtocolStringList

A list containing the ignoreTerms.

getParserForType()

public Parser<Rule.IgnoreAction> getParserForType()
Returns
TypeDescription
Parser<IgnoreAction>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Rule.IgnoreAction.Builder newBuilderForType()
Returns
TypeDescription
Rule.IgnoreAction.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Rule.IgnoreAction.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Rule.IgnoreAction.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Rule.IgnoreAction.Builder toBuilder()
Returns
TypeDescription
Rule.IgnoreAction.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException