Class Rule.OnewaySynonymsAction.Builder (2.15.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.v2beta.Rule.OnewaySynonymsAction

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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
NameDescription
valuesIterable<String>

The onewayTerms to add.

Returns
TypeDescription
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
NameDescription
valuesIterable<String>

The queryTerms to add.

Returns
TypeDescription
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
NameDescription
valuesIterable<String>

The synonyms to add.

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

The onewayTerms to add.

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

The bytes of the onewayTerms to add.

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

The queryTerms to add.

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

The bytes of the queryTerms to add.

Returns
TypeDescription
Rule.OnewaySynonymsAction.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Rule.OnewaySynonymsAction.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueString

The synonyms to add.

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

The bytes of the synonyms to add.

Returns
TypeDescription
Rule.OnewaySynonymsAction.Builder

This builder for chaining.

build()

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

buildPartial()

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

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearOnewayTerms()

public Rule.OnewaySynonymsAction.Builder clearOnewayTerms()

Will be [deprecated = true] post migration;

repeated string oneway_terms = 2;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
Rule.OnewaySynonymsAction.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getOnewayTerms(int index)

public String getOnewayTerms(int index)

Will be [deprecated = true] post migration;

repeated string oneway_terms = 2;

Parameter
NameDescription
indexint

The index of the element to return.

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

The index of the value to return.

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

The count of onewayTerms.

getOnewayTermsList()

public ProtocolStringList getOnewayTermsList()

Will be [deprecated = true] post migration;

repeated string oneway_terms = 2;

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

The index of the element to return.

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

The index of the value to return.

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

The index of the element to return.

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

The index of the value to return.

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

A list containing the synonyms.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(Rule.OnewaySynonymsAction other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

public Rule.OnewaySynonymsAction.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
indexint

The index to set the value at.

valueString

The onewayTerms to set.

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

The index to set the value at.

valueString

The queryTerms to set.

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

The index to set the value at.

valueString

The synonyms to set.

Returns
TypeDescription
Rule.OnewaySynonymsAction.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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