Class Entity (2.13.0)

public final class Entity extends GeneratedMessageV3 implements EntityOrBuilder

Represents a phrase in the text that is a known entity, such as a person, an organization, or location. The API associates information, such as salience and mentions, with entities.

Protobuf type google.cloud.language.v1beta2.Entity

Implements

EntityOrBuilder

Static Fields

MENTIONS_FIELD_NUMBER

public static final int MENTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

SALIENCE_FIELD_NUMBER

public static final int SALIENCE_FIELD_NUMBER
Field Value
TypeDescription
int

SENTIMENT_FIELD_NUMBER

public static final int SENTIMENT_FIELD_NUMBER
Field Value
TypeDescription
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Entity getDefaultInstance()
Returns
TypeDescription
Entity

getDescriptor()

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

newBuilder()

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

newBuilder(Entity prototype)

public static Entity.Builder newBuilder(Entity prototype)
Parameter
NameDescription
prototypeEntity
Returns
TypeDescription
Entity.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsMetadata(String key)

public boolean containsMetadata(String key)

Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (wikipedia_url) and Knowledge Graph MID (mid), if they are available. For the metadata associated with other entity types, see the Type table below.

map<string, string> metadata = 3;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

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

getDefaultInstanceForType()

public Entity getDefaultInstanceForType()
Returns
TypeDescription
Entity

getMentions(int index)

public EntityMention getMentions(int index)

The mentions of this entity in the input document. The API currently supports proper noun mentions.

repeated .google.cloud.language.v1beta2.EntityMention mentions = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
EntityMention

getMentionsCount()

public int getMentionsCount()

The mentions of this entity in the input document. The API currently supports proper noun mentions.

repeated .google.cloud.language.v1beta2.EntityMention mentions = 5;

Returns
TypeDescription
int

getMentionsList()

public List<EntityMention> getMentionsList()

The mentions of this entity in the input document. The API currently supports proper noun mentions.

repeated .google.cloud.language.v1beta2.EntityMention mentions = 5;

Returns
TypeDescription
List<EntityMention>

getMentionsOrBuilder(int index)

public EntityMentionOrBuilder getMentionsOrBuilder(int index)

The mentions of this entity in the input document. The API currently supports proper noun mentions.

repeated .google.cloud.language.v1beta2.EntityMention mentions = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
EntityMentionOrBuilder

getMentionsOrBuilderList()

public List<? extends EntityMentionOrBuilder> getMentionsOrBuilderList()

The mentions of this entity in the input document. The API currently supports proper noun mentions.

repeated .google.cloud.language.v1beta2.EntityMention mentions = 5;

Returns
TypeDescription
List<? extends com.google.cloud.language.v1beta2.EntityMentionOrBuilder>

getMetadata()

public Map<String,String> getMetadata()

Use #getMetadataMap() instead.

Returns
TypeDescription
Map<String,String>

getMetadataCount()

public int getMetadataCount()

Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (wikipedia_url) and Knowledge Graph MID (mid), if they are available. For the metadata associated with other entity types, see the Type table below.

map<string, string> metadata = 3;

Returns
TypeDescription
int

getMetadataMap()

public Map<String,String> getMetadataMap()

Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (wikipedia_url) and Knowledge Graph MID (mid), if they are available. For the metadata associated with other entity types, see the Type table below.

map<string, string> metadata = 3;

Returns
TypeDescription
Map<String,String>

getMetadataOrDefault(String key, String defaultValue)

public String getMetadataOrDefault(String key, String defaultValue)

Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (wikipedia_url) and Knowledge Graph MID (mid), if they are available. For the metadata associated with other entity types, see the Type table below.

map<string, string> metadata = 3;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getMetadataOrThrow(String key)

public String getMetadataOrThrow(String key)

Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (wikipedia_url) and Knowledge Graph MID (mid), if they are available. For the metadata associated with other entity types, see the Type table below.

map<string, string> metadata = 3;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getName()

public String getName()

The representative name for the entity.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

The representative name for the entity.

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

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

getSalience()

public float getSalience()

The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.

float salience = 4;

Returns
TypeDescription
float

The salience.

getSentiment()

public Sentiment getSentiment()

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

.google.cloud.language.v1beta2.Sentiment sentiment = 6;

Returns
TypeDescription
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 aggregate sentiment expressed for this entity in the provided document.

.google.cloud.language.v1beta2.Sentiment sentiment = 6;

Returns
TypeDescription
SentimentOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getType()

public Entity.Type getType()

The entity type.

.google.cloud.language.v1beta2.Entity.Type type = 2;

Returns
TypeDescription
Entity.Type

The type.

getTypeValue()

public int getTypeValue()

The entity type.

.google.cloud.language.v1beta2.Entity.Type type = 2;

Returns
TypeDescription
int

The enum numeric value on the wire for type.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasSentiment()

public boolean hasSentiment()

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

.google.cloud.language.v1beta2.Sentiment sentiment = 6;

Returns
TypeDescription
boolean

Whether the sentiment field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Entity.Builder newBuilderForType()
Returns
TypeDescription
Entity.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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