Class Rule.OnewaySynonymsAction.Builder (2.44.0)

public static final class Rule.OnewaySynonymsAction.Builder extends GeneratedMessageV3.Builder<Rule.OnewaySynonymsAction.Builder> implements Rule.OnewaySynonymsActionOrBuilder

Maps a set of terms to a set of synonyms. Set of synonyms will be treated as synonyms of each query term only. query_terms will not be treated as synonyms of each other. Example: "sneakers" will use a synonym of "shoes". "shoes" will not use a synonym of "sneakers".

Protobuf type google.cloud.retail.v2alpha.Rule.OnewaySynonymsAction

Static Methods

getDescriptor()

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

Methods

addAllOnewayTerms(Iterable<String> values)

public Rule.OnewaySynonymsAction.Builder addAllOnewayTerms(Iterable<String> values)

Will be [deprecated = true] post migration;

repeated string oneway_terms = 2;

Parameter
Name Description
values Iterable<String>

The onewayTerms to add.

Returns
Type Description
Rule.OnewaySynonymsAction.Builder

This builder for chaining.

addAllQueryTerms(Iterable<String> values)

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

Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.

repeated string query_terms = 3;

Parameter
Name Description
values Iterable<String>

The queryTerms to add.

Returns
Type Description
Rule.OnewaySynonymsAction.Builder

This builder for chaining.

addAllSynonyms(Iterable<String> values)

public Rule.OnewaySynonymsAction.Builder addAllSynonyms(Iterable<String> values)

Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.

repeated string synonyms = 4;

Parameter
Name Description
values Iterable<String>

The synonyms to add.

Returns
Type Description
Rule.OnewaySynonymsAction.Builder

This builder for chaining.

addOnewayTerms(String value)

public Rule.OnewaySynonymsAction.Builder addOnewayTerms(String value)

Will be [deprecated = true] post migration;

repeated string oneway_terms = 2;

Parameter
Name Description
value String

The onewayTerms to add.

Returns
Type Description
Rule.OnewaySynonymsAction.Builder

This builder for chaining.

addOnewayTermsBytes(ByteString value)

public Rule.OnewaySynonymsAction.Builder addOnewayTermsBytes(ByteString value)

Will be [deprecated = true] post migration;

repeated string oneway_terms = 2;

Parameter
Name Description
value ByteString

The bytes of the onewayTerms to add.

Returns
Type Description
Rule.OnewaySynonymsAction.Builder

This builder for chaining.

addQueryTerms(String value)

public Rule.OnewaySynonymsAction.Builder addQueryTerms(String value)

Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.

repeated string query_terms = 3;

Parameter
Name Description
value String

The queryTerms to add.

Returns
Type Description
Rule.OnewaySynonymsAction.Builder

This builder for chaining.

addQueryTermsBytes(ByteString value)

public Rule.OnewaySynonymsAction.Builder addQueryTermsBytes(ByteString value)

Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.

repeated string query_terms = 3;

Parameter
Name Description
value ByteString

The bytes of the queryTerms to add.

Returns
Type Description
Rule.OnewaySynonymsAction.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

addSynonyms(String value)

public Rule.OnewaySynonymsAction.Builder addSynonyms(String value)

Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.

repeated string synonyms = 4;

Parameter
Name Description
value String

The synonyms to add.

Returns
Type Description
Rule.OnewaySynonymsAction.Builder

This builder for chaining.

addSynonymsBytes(ByteString value)

public Rule.OnewaySynonymsAction.Builder addSynonymsBytes(ByteString value)

Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.

repeated string synonyms = 4;

Parameter
Name Description
value ByteString

The bytes of the synonyms to add.

Returns
Type Description
Rule.OnewaySynonymsAction.Builder

This builder for chaining.

build()

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

buildPartial()

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

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearOnewayTerms()

public Rule.OnewaySynonymsAction.Builder clearOnewayTerms()

Will be [deprecated = true] post migration;

repeated string oneway_terms = 2;

Returns
Type Description
Rule.OnewaySynonymsAction.Builder

This builder for chaining.

clearQueryTerms()

public Rule.OnewaySynonymsAction.Builder clearQueryTerms()

Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.

repeated string query_terms = 3;

Returns
Type Description
Rule.OnewaySynonymsAction.Builder

This builder for chaining.

clearSynonyms()

public Rule.OnewaySynonymsAction.Builder clearSynonyms()

Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.

repeated string synonyms = 4;

Returns
Type Description
Rule.OnewaySynonymsAction.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

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

getDescriptorForType()

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

getOnewayTerms(int index)

public String getOnewayTerms(int index)

Will be [deprecated = true] post migration;

repeated string oneway_terms = 2;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The onewayTerms at the given index.

getOnewayTermsBytes(int index)

public ByteString getOnewayTermsBytes(int index)

Will be [deprecated = true] post migration;

repeated string oneway_terms = 2;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the onewayTerms at the given index.

getOnewayTermsCount()

public int getOnewayTermsCount()

Will be [deprecated = true] post migration;

repeated string oneway_terms = 2;

Returns
Type Description
int

The count of onewayTerms.

getOnewayTermsList()

public ProtocolStringList getOnewayTermsList()

Will be [deprecated = true] post migration;

repeated string oneway_terms = 2;

Returns
Type Description
ProtocolStringList

A list containing the onewayTerms.

getQueryTerms(int index)

public String getQueryTerms(int index)

Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.

repeated string query_terms = 3;

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 treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.

repeated string query_terms = 3;

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 treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.

repeated string query_terms = 3;

Returns
Type Description
int

The count of queryTerms.

getQueryTermsList()

public ProtocolStringList getQueryTermsList()

Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.

repeated string query_terms = 3;

Returns
Type Description
ProtocolStringList

A list containing the queryTerms.

getSynonyms(int index)

public String getSynonyms(int index)

Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.

repeated string synonyms = 4;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The synonyms at the given index.

getSynonymsBytes(int index)

public ByteString getSynonymsBytes(int index)

Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.

repeated string synonyms = 4;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the synonyms at the given index.

getSynonymsCount()

public int getSynonymsCount()

Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.

repeated string synonyms = 4;

Returns
Type Description
int

The count of synonyms.

getSynonymsList()

public ProtocolStringList getSynonymsList()

Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.

repeated string synonyms = 4;

Returns
Type Description
ProtocolStringList

A list containing the synonyms.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Rule.OnewaySynonymsAction other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setOnewayTerms(int index, String value)

public Rule.OnewaySynonymsAction.Builder setOnewayTerms(int index, String value)

Will be [deprecated = true] post migration;

repeated string oneway_terms = 2;

Parameters
Name Description
index int

The index to set the value at.

value String

The onewayTerms to set.

Returns
Type Description
Rule.OnewaySynonymsAction.Builder

This builder for chaining.

setQueryTerms(int index, String value)

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

Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.

repeated string query_terms = 3;

Parameters
Name Description
index int

The index to set the value at.

value String

The queryTerms to set.

Returns
Type Description
Rule.OnewaySynonymsAction.Builder

This builder for chaining.

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

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

setSynonyms(int index, String value)

public Rule.OnewaySynonymsAction.Builder setSynonyms(int index, String value)

Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.

repeated string synonyms = 4;

Parameters
Name Description
index int

The index to set the value at.

value String

The synonyms to set.

Returns
Type Description
Rule.OnewaySynonymsAction.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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