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

Static Fields

ONEWAY_TERMS_FIELD_NUMBER

public static final int ONEWAY_TERMS_FIELD_NUMBER
Field Value
TypeDescription
int

QUERY_TERMS_FIELD_NUMBER

public static final int QUERY_TERMS_FIELD_NUMBER
Field Value
TypeDescription
int

SYNONYMS_FIELD_NUMBER

public static final int SYNONYMS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Rule.OnewaySynonymsAction getDefaultInstance()
Returns
TypeDescription
Rule.OnewaySynonymsAction

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Rule.OnewaySynonymsAction.Builder newBuilder()
Returns
TypeDescription
Rule.OnewaySynonymsAction.Builder

newBuilder(Rule.OnewaySynonymsAction prototype)

public static Rule.OnewaySynonymsAction.Builder newBuilder(Rule.OnewaySynonymsAction prototype)
Parameter
NameDescription
prototypeRule.OnewaySynonymsAction
Returns
TypeDescription
Rule.OnewaySynonymsAction.Builder

parseDelimitedFrom(InputStream input)

public static Rule.OnewaySynonymsAction parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Rule.OnewaySynonymsAction
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Rule.OnewaySynonymsAction parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Rule.OnewaySynonymsAction
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Rule.OnewaySynonymsAction parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Rule.OnewaySynonymsAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Rule.OnewaySynonymsAction parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Rule.OnewaySynonymsAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Rule.OnewaySynonymsAction parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Rule.OnewaySynonymsAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Rule.OnewaySynonymsAction parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Rule.OnewaySynonymsAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Rule.OnewaySynonymsAction parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Rule.OnewaySynonymsAction
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Rule.OnewaySynonymsAction parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Rule.OnewaySynonymsAction
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Rule.OnewaySynonymsAction parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Rule.OnewaySynonymsAction
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Rule.OnewaySynonymsAction parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Rule.OnewaySynonymsAction
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Rule.OnewaySynonymsAction parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Rule.OnewaySynonymsAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Rule.OnewaySynonymsAction parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Rule.OnewaySynonymsAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

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

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.

getParserForType()

public Parser<Rule.OnewaySynonymsAction> getParserForType()
Returns
TypeDescription
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
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.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Rule.OnewaySynonymsAction.Builder newBuilderForType()
Returns
TypeDescription
Rule.OnewaySynonymsAction.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Rule.OnewaySynonymsAction.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Rule.OnewaySynonymsAction.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Rule.OnewaySynonymsAction.Builder toBuilder()
Returns
TypeDescription
Rule.OnewaySynonymsAction.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException