Class Rule.ReplacementAction.Builder (2.32.0)

Version 2.32.0

• 2.55.0 (latest)
• 2.54.0
• 2.53.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.1
• 2.4.0
• 2.3.0
• 2.2.3
• 2.1.0
• 2.0.19

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

Implements

Rule.ReplacementActionOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public Rule.ReplacementAction.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
Rule.ReplacementAction.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public Rule.ReplacementAction.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
Rule.ReplacementAction.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public Rule.ReplacementAction getDefaultInstanceForType()

Returns
Type	Description
Rule.ReplacementAction

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Rule.ReplacementAction.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Rule.ReplacementAction.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)