Class SynonymSet (0.38.0)

public final class SynonymSet extends GeneratedMessageV3 implements SynonymSetOrBuilder

Represents a list of synonyms for a given context. For example a context "sales" could contain: Synonym 1: sale, invoice, bill, order Synonym 2: money, credit, finance, payment Synonym 3: shipping, freight, transport Each SynonymSets should be disjoint

Protobuf type google.cloud.contentwarehouse.v1.SynonymSet

Implements

SynonymSetOrBuilder

Static Fields

CONTEXT_FIELD_NUMBER

public static final int CONTEXT_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_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 SynonymSet getDefaultInstance()
Returns
Type Description
SynonymSet

getDescriptor()

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

newBuilder()

public static SynonymSet.Builder newBuilder()
Returns
Type Description
SynonymSet.Builder

newBuilder(SynonymSet prototype)

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

parseDelimitedFrom(InputStream input)

public static SynonymSet parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SynonymSet
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static SynonymSet parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SynonymSet
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static SynonymSet parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SynonymSet
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static SynonymSet parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SynonymSet
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static SynonymSet parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SynonymSet
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<SynonymSet> parser()
Returns
Type Description
Parser<SynonymSet>

Methods

equals(Object obj)

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

getContext()

public String getContext()

This is a freeform field. Example contexts can be "sales," "engineering," "real estate," "accounting," etc. The context can be supplied during search requests.

string context = 2;

Returns
Type Description
String

The context.

getContextBytes()

public ByteString getContextBytes()

This is a freeform field. Example contexts can be "sales," "engineering," "real estate," "accounting," etc. The context can be supplied during search requests.

string context = 2;

Returns
Type Description
ByteString

The bytes for context.

getDefaultInstanceForType()

public SynonymSet getDefaultInstanceForType()
Returns
Type Description
SynonymSet

getName()

public String getName()

The resource name of the SynonymSet This is mandatory for google.api.resource. Format: projects/{project_number}/locations/{location}/synonymSets/{context}.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The resource name of the SynonymSet This is mandatory for google.api.resource. Format: projects/{project_number}/locations/{location}/synonymSets/{context}.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<SynonymSet> getParserForType()
Returns
Type Description
Parser<SynonymSet>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSynonyms(int index)

public SynonymSet.Synonym getSynonyms(int index)

List of Synonyms for the context.

repeated .google.cloud.contentwarehouse.v1.SynonymSet.Synonym synonyms = 3;

Parameter
Name Description
index int
Returns
Type Description
SynonymSet.Synonym

getSynonymsCount()

public int getSynonymsCount()

List of Synonyms for the context.

repeated .google.cloud.contentwarehouse.v1.SynonymSet.Synonym synonyms = 3;

Returns
Type Description
int

getSynonymsList()

public List<SynonymSet.Synonym> getSynonymsList()

List of Synonyms for the context.

repeated .google.cloud.contentwarehouse.v1.SynonymSet.Synonym synonyms = 3;

Returns
Type Description
List<Synonym>

getSynonymsOrBuilder(int index)

public SynonymSet.SynonymOrBuilder getSynonymsOrBuilder(int index)

List of Synonyms for the context.

repeated .google.cloud.contentwarehouse.v1.SynonymSet.Synonym synonyms = 3;

Parameter
Name Description
index int
Returns
Type Description
SynonymSet.SynonymOrBuilder

getSynonymsOrBuilderList()

public List<? extends SynonymSet.SynonymOrBuilder> getSynonymsOrBuilderList()

List of Synonyms for the context.

repeated .google.cloud.contentwarehouse.v1.SynonymSet.Synonym synonyms = 3;

Returns
Type Description
List<? extends com.google.cloud.contentwarehouse.v1.SynonymSet.SynonymOrBuilder>

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 SynonymSet.Builder newBuilderForType()
Returns
Type Description
SynonymSet.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public SynonymSet.Builder toBuilder()
Returns
Type Description
SynonymSet.Builder

writeTo(CodedOutputStream output)

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