Class EntityMention (2.44.0)

public final class EntityMention extends GeneratedMessageV3 implements EntityMentionOrBuilder

Represents a mention for an entity in the text. Currently, proper noun mentions are supported.

Protobuf type google.cloud.language.v2.EntityMention

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > EntityMention

Static Fields

PROBABILITY_FIELD_NUMBER

public static final int PROBABILITY_FIELD_NUMBER
Field Value
Type Description
int

SENTIMENT_FIELD_NUMBER

public static final int SENTIMENT_FIELD_NUMBER
Field Value
Type Description
int

TEXT_FIELD_NUMBER

public static final int TEXT_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static EntityMention getDefaultInstance()
Returns
Type Description
EntityMention

getDescriptor()

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

newBuilder()

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

newBuilder(EntityMention prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public EntityMention getDefaultInstanceForType()
Returns
Type Description
EntityMention

getParserForType()

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

getProbability()

public float getProbability()

Probability score associated with the entity.

The score shows the probability of the entity mention being the entity type. The score is in (0, 1] range.

float probability = 4;

Returns
Type Description
float

The probability.

getSentiment()

public Sentiment getSentiment()

For calls to [AnalyzeEntitySentiment][] or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the sentiment expressed for this mention of the entity in the provided document.

.google.cloud.language.v2.Sentiment sentiment = 3;

Returns
Type Description
Sentiment

The sentiment.

getSentimentOrBuilder()

public SentimentOrBuilder getSentimentOrBuilder()

For calls to [AnalyzeEntitySentiment][] or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the sentiment expressed for this mention of the entity in the provided document.

.google.cloud.language.v2.Sentiment sentiment = 3;

Returns
Type Description
SentimentOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getText()

public TextSpan getText()

The mention text.

.google.cloud.language.v2.TextSpan text = 1;

Returns
Type Description
TextSpan

The text.

getTextOrBuilder()

public TextSpanOrBuilder getTextOrBuilder()

The mention text.

.google.cloud.language.v2.TextSpan text = 1;

Returns
Type Description
TextSpanOrBuilder

getType()

public EntityMention.Type getType()

The type of the entity mention.

.google.cloud.language.v2.EntityMention.Type type = 2;

Returns
Type Description
EntityMention.Type

The type.

getTypeValue()

public int getTypeValue()

The type of the entity mention.

.google.cloud.language.v2.EntityMention.Type type = 2;

Returns
Type Description
int

The enum numeric value on the wire for type.

hasSentiment()

public boolean hasSentiment()

For calls to [AnalyzeEntitySentiment][] or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the sentiment expressed for this mention of the entity in the provided document.

.google.cloud.language.v2.Sentiment sentiment = 3;

Returns
Type Description
boolean

Whether the sentiment field is set.

hasText()

public boolean hasText()

The mention text.

.google.cloud.language.v2.TextSpan text = 1;

Returns
Type Description
boolean

Whether the text field is set.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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