Class Rule.OnewaySynonymsAction (2.46.0)

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

Static Fields

ONEWAY_TERMS_FIELD_NUMBER

public static final int ONEWAY_TERMS_FIELD_NUMBER
Field Value
Type Description
int

QUERY_TERMS_FIELD_NUMBER

public static final int QUERY_TERMS_FIELD_NUMBER
Field Value
Type Description
int

SYNONYMS_FIELD_NUMBER

public static final int SYNONYMS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Rule.OnewaySynonymsAction getDefaultInstance()
Returns
Type Description
Rule.OnewaySynonymsAction

getDescriptor()

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

newBuilder()

public static Rule.OnewaySynonymsAction.Builder newBuilder()
Returns
Type Description
Rule.OnewaySynonymsAction.Builder

newBuilder(Rule.OnewaySynonymsAction prototype)

public static Rule.OnewaySynonymsAction.Builder newBuilder(Rule.OnewaySynonymsAction prototype)
Parameter
Name Description
prototype Rule.OnewaySynonymsAction
Returns
Type Description
Rule.OnewaySynonymsAction.Builder

parseDelimitedFrom(InputStream input)

public static Rule.OnewaySynonymsAction parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Rule.OnewaySynonymsAction
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Rule.OnewaySynonymsAction parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Rule.OnewaySynonymsAction
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Rule.OnewaySynonymsAction parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Rule.OnewaySynonymsAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Rule.OnewaySynonymsAction parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Rule.OnewaySynonymsAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Rule.OnewaySynonymsAction parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Rule.OnewaySynonymsAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Rule.OnewaySynonymsAction parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Rule.OnewaySynonymsAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Rule.OnewaySynonymsAction parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Rule.OnewaySynonymsAction
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Rule.OnewaySynonymsAction parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Rule.OnewaySynonymsAction
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Rule.OnewaySynonymsAction parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Rule.OnewaySynonymsAction
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Rule.OnewaySynonymsAction parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Rule.OnewaySynonymsAction
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Rule.OnewaySynonymsAction parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Rule.OnewaySynonymsAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Rule.OnewaySynonymsAction parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Rule.OnewaySynonymsAction
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Rule.OnewaySynonymsAction> parser()
Returns
Type Description
Parser<OnewaySynonymsAction>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

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

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.

getParserForType()

public Parser<Rule.OnewaySynonymsAction> getParserForType()
Returns
Type Description
Parser<OnewaySynonymsAction>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Rule.OnewaySynonymsAction.Builder newBuilderForType()
Returns
Type Description
Rule.OnewaySynonymsAction.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Rule.OnewaySynonymsAction.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Rule.OnewaySynonymsAction.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Rule.OnewaySynonymsAction.Builder toBuilder()
Returns
Type Description
Rule.OnewaySynonymsAction.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException