Class SynonymSet (0.28.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
TypeDescription
int

NAME_FIELD_NUMBER

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

getDescriptor()

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

newBuilder()

public static SynonymSet.Builder newBuilder()
Returns
TypeDescription
SynonymSet.Builder

newBuilder(SynonymSet prototype)

public static SynonymSet.Builder newBuilder(SynonymSet prototype)
Parameter
NameDescription
prototypeSynonymSet
Returns
TypeDescription
SynonymSet.Builder

parseDelimitedFrom(InputStream input)

public static SynonymSet parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SynonymSet
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static SynonymSet parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SynonymSet
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static SynonymSet parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SynonymSet
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static SynonymSet parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SynonymSet
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static SynonymSet parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SynonymSet
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<SynonymSet> parser()
Returns
TypeDescription
Parser<SynonymSet>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for context.

getDefaultInstanceForType()

public SynonymSet getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<SynonymSet> getParserForType()
Returns
TypeDescription
Parser<SynonymSet>
Overrides

getSerializedSize()

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

getSynonymsCount()

public int getSynonymsCount()

List of Synonyms for the context.

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

Returns
TypeDescription
int

getSynonymsList()

public List<SynonymSet.Synonym> getSynonymsList()

List of Synonyms for the context.

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

Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.cloud.contentwarehouse.v1.SynonymSet.SynonymOrBuilder>

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public SynonymSet.Builder toBuilder()
Returns
TypeDescription
SynonymSet.Builder

writeTo(CodedOutputStream output)

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