Class Rule.IgnoreAction.Builder (2.14.0)

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

Static Methods

getDescriptor()

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

Methods

addAllIgnoreTerms(Iterable<String> values)

public Rule.IgnoreAction.Builder addAllIgnoreTerms(Iterable<String> values)

Terms to ignore in the search query.

repeated string ignore_terms = 1;

Parameter
NameDescription
valuesIterable<String>

The ignoreTerms to add.

Returns
TypeDescription
Rule.IgnoreAction.Builder

This builder for chaining.

addIgnoreTerms(String value)

public Rule.IgnoreAction.Builder addIgnoreTerms(String value)

Terms to ignore in the search query.

repeated string ignore_terms = 1;

Parameter
NameDescription
valueString

The ignoreTerms to add.

Returns
TypeDescription
Rule.IgnoreAction.Builder

This builder for chaining.

addIgnoreTermsBytes(ByteString value)

public Rule.IgnoreAction.Builder addIgnoreTermsBytes(ByteString value)

Terms to ignore in the search query.

repeated string ignore_terms = 1;

Parameter
NameDescription
valueByteString

The bytes of the ignoreTerms to add.

Returns
TypeDescription
Rule.IgnoreAction.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Rule.IgnoreAction.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Rule.IgnoreAction.Builder
Overrides

build()

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

buildPartial()

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

clear()

public Rule.IgnoreAction.Builder clear()
Returns
TypeDescription
Rule.IgnoreAction.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public Rule.IgnoreAction.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Rule.IgnoreAction.Builder
Overrides

clearIgnoreTerms()

public Rule.IgnoreAction.Builder clearIgnoreTerms()

Terms to ignore in the search query.

repeated string ignore_terms = 1;

Returns
TypeDescription
Rule.IgnoreAction.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Rule.IgnoreAction.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Rule.IgnoreAction.Builder
Overrides

clone()

public Rule.IgnoreAction.Builder clone()
Returns
TypeDescription
Rule.IgnoreAction.Builder
Overrides

getDefaultInstanceForType()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(Rule.IgnoreAction other)

public Rule.IgnoreAction.Builder mergeFrom(Rule.IgnoreAction other)
Parameter
NameDescription
otherRule.IgnoreAction
Returns
TypeDescription
Rule.IgnoreAction.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Rule.IgnoreAction.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Rule.IgnoreAction.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Rule.IgnoreAction.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Rule.IgnoreAction.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Rule.IgnoreAction.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Rule.IgnoreAction.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public Rule.IgnoreAction.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Rule.IgnoreAction.Builder
Overrides

setIgnoreTerms(int index, String value)

public Rule.IgnoreAction.Builder setIgnoreTerms(int index, String value)

Terms to ignore in the search query.

repeated string ignore_terms = 1;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The ignoreTerms to set.

Returns
TypeDescription
Rule.IgnoreAction.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Rule.IgnoreAction.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Rule.IgnoreAction.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Rule.IgnoreAction.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Rule.IgnoreAction.Builder
Overrides