com.google.cloud.language.v1

Class Entity

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.language.v1.Entity

All Implemented Interfaces:

EntityOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable

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.v1.Entity

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Entity.Builder Represents a phrase in the text that is a known entity, such as a person, an organization, or location.
static class	Entity.Type The type of the entity.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	MENTIONS_FIELD_NUMBER
static int	METADATA_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	SALIENCE_FIELD_NUMBER
static int	SENTIMENT_FIELD_NUMBER
static int	TYPE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	containsMetadata(String key) Metadata associated with the entity.
boolean	equals(Object obj)
static Entity	getDefaultInstance()
Entity	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
EntityMention	getMentions(int index) The mentions of this entity in the input document.
int	getMentionsCount() The mentions of this entity in the input document.
List<EntityMention>	getMentionsList() The mentions of this entity in the input document.
EntityMentionOrBuilder	getMentionsOrBuilder(int index) The mentions of this entity in the input document.
List<? extends EntityMentionOrBuilder>	getMentionsOrBuilderList() The mentions of this entity in the input document.
Map<String,String>	getMetadata() Deprecated.
int	getMetadataCount() Metadata associated with the entity.
Map<String,String>	getMetadataMap() Metadata associated with the entity.
String	getMetadataOrDefault(String key, String defaultValue) Metadata associated with the entity.
String	getMetadataOrThrow(String key) Metadata associated with the entity.
String	getName() The representative name for the entity.
ByteString	getNameBytes() The representative name for the entity.
Parser<Entity>	getParserForType()
float	getSalience() The salience score associated with the entity in the [0, 1.0] range.
Sentiment	getSentiment() For calls to [AnalyzeEntitySentiment][] or if [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1.AnnotateTextRequest.Features.extract_entity_sentiment] is set to true, this field will contain the aggregate sentiment expressed for this entity in the provided document.
SentimentOrBuilder	getSentimentOrBuilder() For calls to [AnalyzeEntitySentiment][] or if [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1.AnnotateTextRequest.Features.extract_entity_sentiment] is set to true, this field will contain the aggregate sentiment expressed for this entity in the provided document.
int	getSerializedSize()
Entity.Type	getType() The entity type.
int	getTypeValue() The entity type.
UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasSentiment() For calls to [AnalyzeEntitySentiment][] or if [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1.AnnotateTextRequest.Features.extract_entity_sentiment] is set to true, this field will contain the aggregate sentiment expressed for this entity in the provided document.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected MapField	internalGetMapField(int number)
boolean	isInitialized()
static Entity.Builder	newBuilder()
static Entity.Builder	newBuilder(Entity prototype)
Entity.Builder	newBuilderForType()
protected Entity.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
static Entity	parseDelimitedFrom(InputStream input)
static Entity	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Entity	parseFrom(byte[] data)
static Entity	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static Entity	parseFrom(ByteBuffer data)
static Entity	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static Entity	parseFrom(ByteString data)
static Entity	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static Entity	parseFrom(CodedInputStream input)
static Entity	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static Entity	parseFrom(InputStream input)
static Entity	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<Entity>	parser()
Entity.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER

See Also:

Constant Field Values

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER

See Also:

Constant Field Values

SALIENCE_FIELD_NUMBER

public static final int SALIENCE_FIELD_NUMBER

See Also:

Constant Field Values

MENTIONS_FIELD_NUMBER

public static final int MENTIONS_FIELD_NUMBER

See Also:

Constant Field Values

SENTIMENT_FIELD_NUMBER

public static final int SENTIMENT_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class GeneratedMessageV3

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetMapField

protected MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class GeneratedMessageV3

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getName

public String getName()

 The representative name for the entity.
 

string name = 1;

Specified by:

getName in interface EntityOrBuilder

Returns:

The name.

getNameBytes

public ByteString getNameBytes()

 The representative name for the entity.
 

string name = 1;

Specified by:

getNameBytes in interface EntityOrBuilder

Returns:

The bytes for name.

getTypeValue

public int getTypeValue()

 The entity type.
 

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

Specified by:

getTypeValue in interface EntityOrBuilder

Returns:

The enum numeric value on the wire for type.

getType

public Entity.Type getType()

 The entity type.
 

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

Specified by:

getType in interface EntityOrBuilder

Returns:

The type.

getMetadataCount

public int getMetadataCount()

Description copied from interface: EntityOrBuilder

 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;

Specified by:

getMetadataCount in interface EntityOrBuilder

containsMetadata

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;

Specified by:

containsMetadata in interface EntityOrBuilder

getMetadata

@Deprecated
public Map<String,String> getMetadata()

Deprecated.

Use getMetadataMap() instead.

Specified by:

getMetadata in interface EntityOrBuilder

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;

Specified by:

getMetadataMap in interface EntityOrBuilder

getMetadataOrDefault

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;

Specified by:

getMetadataOrDefault in interface EntityOrBuilder

getMetadataOrThrow

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;

Specified by:

getMetadataOrThrow in interface EntityOrBuilder

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;

Specified by:

getSalience in interface EntityOrBuilder

Returns:

The salience.

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.v1.EntityMention mentions = 5;

Specified by:

getMentionsList in interface EntityOrBuilder

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.v1.EntityMention mentions = 5;

Specified by:

getMentionsOrBuilderList in interface EntityOrBuilder

getMentionsCount

public int getMentionsCount()

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

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

Specified by:

getMentionsCount in interface EntityOrBuilder

getMentions

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.v1.EntityMention mentions = 5;

Specified by:

getMentions in interface EntityOrBuilder

getMentionsOrBuilder

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.v1.EntityMention mentions = 5;

Specified by:

getMentionsOrBuilder in interface EntityOrBuilder

hasSentiment

public boolean hasSentiment()

 For calls to [AnalyzeEntitySentiment][] or if
 [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1.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.v1.Sentiment sentiment = 6;

Specified by:

hasSentiment in interface EntityOrBuilder

Returns:

Whether the sentiment field is set.

getSentiment

public Sentiment getSentiment()

 For calls to [AnalyzeEntitySentiment][] or if
 [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1.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.v1.Sentiment sentiment = 6;

Specified by:

getSentiment in interface EntityOrBuilder

Returns:

The sentiment.

getSentimentOrBuilder

public SentimentOrBuilder getSentimentOrBuilder()

 For calls to [AnalyzeEntitySentiment][] or if
 [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1.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.v1.Sentiment sentiment = 6;

Specified by:

getSentimentOrBuilder in interface EntityOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static Entity parseFrom(ByteBuffer data)
                        throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Entity parseFrom(ByteBuffer data,
                               ExtensionRegistryLite extensionRegistry)
                        throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Entity parseFrom(ByteString data)
                        throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Entity parseFrom(ByteString data,
                               ExtensionRegistryLite extensionRegistry)
                        throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Entity parseFrom(byte[] data)
                        throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Entity parseFrom(byte[] data,
                               ExtensionRegistryLite extensionRegistry)
                        throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Entity parseFrom(InputStream input)
                        throws IOException

Throws:

IOException

parseFrom

public static Entity parseFrom(InputStream input,
                               ExtensionRegistryLite extensionRegistry)
                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static Entity parseDelimitedFrom(InputStream input)
                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static Entity parseDelimitedFrom(InputStream input,
                                        ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Throws:

IOException

parseFrom

public static Entity parseFrom(CodedInputStream input)
                        throws IOException

Throws:

IOException

parseFrom

public static Entity parseFrom(CodedInputStream input,
                               ExtensionRegistryLite extensionRegistry)
                        throws IOException

Throws:

IOException

newBuilderForType

public Entity.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static Entity.Builder newBuilder()

newBuilder

public static Entity.Builder newBuilder(Entity prototype)

toBuilder

public Entity.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected Entity.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static Entity getDefaultInstance()

parser

public static Parser<Entity> parser()

getParserForType

public Parser<Entity> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public Entity getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder