Class Rule.ReplacementAction.Builder (2.10.0) 

public static final class Rule.ReplacementAction.Builder extends GeneratedMessageV3.Builder<Rule.ReplacementAction.Builder> implements Rule.ReplacementActionOrBuilder

Replaces a term in the query. Multiple replacement candidates can be specified. All query_terms will be replaced with the replacement term. Example: Replace "gShoe" with "google shoe".

Protobuf type google.cloud.retail.v2.Rule.ReplacementAction

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Rule.ReplacementAction.Builder

Static Methods

getDescriptor()

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

Methods

addAllQueryTerms(Iterable<String> values)

public Rule.ReplacementAction.Builder addAllQueryTerms(Iterable<String> values)

Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.

repeated string query_terms = 2;

Parameter
Name Description
values Iterable<String>

The queryTerms to add.
Returns
Type Description
Rule.ReplacementAction.Builder

This builder for chaining.

addQueryTerms(String value)

public Rule.ReplacementAction.Builder addQueryTerms(String value)

Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.

repeated string query_terms = 2;

Parameter
Name Description
value String

The queryTerms to add.
Returns
Type Description
Rule.ReplacementAction.Builder

This builder for chaining.

addQueryTermsBytes(ByteString value)

public Rule.ReplacementAction.Builder addQueryTermsBytes(ByteString value)

Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.

repeated string query_terms = 2;

Parameter
Name Description
value ByteString

The bytes of the queryTerms to add.
Returns
Type Description
Rule.ReplacementAction.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Rule.ReplacementAction.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Rule.ReplacementAction.Builder
Overrides

build()

public Rule.ReplacementAction build()
Returns
Type Description
Rule.ReplacementAction

buildPartial()

public Rule.ReplacementAction buildPartial()
Returns
Type Description
Rule.ReplacementAction

clear()

public Rule.ReplacementAction.Builder clear()
Returns
Type Description
Rule.ReplacementAction.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public Rule.ReplacementAction.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Rule.ReplacementAction.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public Rule.ReplacementAction.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Rule.ReplacementAction.Builder
Overrides

clearQueryTerms()

public Rule.ReplacementAction.Builder clearQueryTerms()

Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.

repeated string query_terms = 2;

Returns
Type Description
Rule.ReplacementAction.Builder

This builder for chaining.

clearReplacementTerm()

public Rule.ReplacementAction.Builder clearReplacementTerm()

Term that will be used for replacement.

string replacement_term = 3;

Returns
Type Description
Rule.ReplacementAction.Builder

This builder for chaining.

clearTerm()

public Rule.ReplacementAction.Builder clearTerm()

Will be [deprecated = true] post migration;

string term = 1;

Returns
Type Description
Rule.ReplacementAction.Builder

This builder for chaining.

clone()

public Rule.ReplacementAction.Builder clone()
Returns
Type Description
Rule.ReplacementAction.Builder
Overrides

getDefaultInstanceForType()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getQueryTerms(int index)

public String getQueryTerms(int index)

Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.

repeated string query_terms = 2;

Parameter
Name Description
index int

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

The queryTerms at the given index.

getQueryTermsBytes(int index)

public ByteString getQueryTermsBytes(int index)

Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.

repeated string query_terms = 2;

Parameter
Name Description
index int

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

The bytes of the queryTerms at the given index.

getQueryTermsCount()

public int getQueryTermsCount()

Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.

repeated string query_terms = 2;

Returns
Type Description
int

The count of queryTerms.

getQueryTermsList()

public ProtocolStringList getQueryTermsList()

Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.

repeated string query_terms = 2;

Returns
Type Description
ProtocolStringList

A list containing the queryTerms.

getReplacementTerm()

public String getReplacementTerm()

Term that will be used for replacement.

string replacement_term = 3;

Returns
Type Description
String

The replacementTerm.

getReplacementTermBytes()

public ByteString getReplacementTermBytes()

Term that will be used for replacement.

string replacement_term = 3;

Returns
Type Description
ByteString

The bytes for replacementTerm.

getTerm()

public String getTerm()

Will be [deprecated = true] post migration;

string term = 1;

Returns
Type Description
String

The term.

getTermBytes()

public ByteString getTermBytes()

Will be [deprecated = true] post migration;

string term = 1;

Returns
Type Description
ByteString

The bytes for term.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Rule.ReplacementAction other)

public Rule.ReplacementAction.Builder mergeFrom(Rule.ReplacementAction other)
Parameter
Name Description
other Rule.ReplacementAction
Returns
Type Description
Rule.ReplacementAction.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Rule.ReplacementAction.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Rule.ReplacementAction.Builder
Overrides Exceptions
Type Description
IOException

mergeFrom(Message other)

public Rule.ReplacementAction.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Rule.ReplacementAction.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Rule.ReplacementAction.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Rule.ReplacementAction.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public Rule.ReplacementAction.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Rule.ReplacementAction.Builder
Overrides

setQueryTerms(int index, String value)

public Rule.ReplacementAction.Builder setQueryTerms(int index, String value)

Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.

repeated string query_terms = 2;

Parameters
Name Description
index int

The index to set the value at.
value String

The queryTerms to set.
Returns
Type Description
Rule.ReplacementAction.Builder

This builder for chaining.

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

public Rule.ReplacementAction.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Rule.ReplacementAction.Builder
Overrides

setReplacementTerm(String value)

public Rule.ReplacementAction.Builder setReplacementTerm(String value)

Term that will be used for replacement.

string replacement_term = 3;

Parameter
Name Description
value String

The replacementTerm to set.
Returns
Type Description
Rule.ReplacementAction.Builder

This builder for chaining.

setReplacementTermBytes(ByteString value)

public Rule.ReplacementAction.Builder setReplacementTermBytes(ByteString value)

Term that will be used for replacement.

string replacement_term = 3;

Parameter
Name Description
value ByteString

The bytes for replacementTerm to set.
Returns
Type Description
Rule.ReplacementAction.Builder

This builder for chaining.

setTerm(String value)

public Rule.ReplacementAction.Builder setTerm(String value)

Will be [deprecated = true] post migration;

string term = 1;

Parameter
Name Description
value String

The term to set.
Returns
Type Description
Rule.ReplacementAction.Builder

This builder for chaining.

setTermBytes(ByteString value)

public Rule.ReplacementAction.Builder setTermBytes(ByteString value)

Will be [deprecated = true] post migration;

string term = 1;

Parameter
Name Description
value ByteString

The bytes for term to set.
Returns
Type Description
Rule.ReplacementAction.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Rule.ReplacementAction.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Rule.ReplacementAction.Builder
Overrides