Package com.google.cloud.language.v1

Class Entity

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.language.v1.Entity
All Implemented Interfaces:
EntityOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Entity extends com.google.protobuf.GeneratedMessage 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:

  • Nested Class Summary

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

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

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

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

    com.google.protobuf.AbstractMessage.BuilderParent

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

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

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

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, 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
    Description
    boolean
    containsMetadata(String key)
    Metadata associated with the entity.
    boolean
    equals(Object obj)
     
    static Entity
    getDefaultInstance()
     
    Entity
    getDefaultInstanceForType()
     
    static final com.google.protobuf.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.
    com.google.protobuf.ByteString
    getNameBytes()
    The representative name for the entity.
    com.google.protobuf.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.
    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 com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    protected com.google.protobuf.MapFieldReflectionAccessor
    internalGetMapFieldReflection(int number)
     
    final boolean
    isInitialized()
     
    static Entity.Builder
    newBuilder()
     
    static Entity.Builder
    newBuilder(Entity prototype)
     
    Entity.Builder
    newBuilderForType()
     
    protected Entity.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Entity
    parseDelimitedFrom(InputStream input)
     
    static Entity
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Entity
    parseFrom(byte[] data)
     
    static Entity
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Entity
    parseFrom(com.google.protobuf.ByteString data)
     
    static Entity
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Entity
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Entity
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Entity
    parseFrom(InputStream input)
     
    static Entity
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Entity
    parseFrom(ByteBuffer data)
     
    static Entity
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Entity>
    parser()
     
    Entity.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    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.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getName

      public String getName()
       The representative name for the entity.
      string name = 1;
      Specified by:
      getName in interface EntityOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.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 com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Entity parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Entity parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Entity parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Entity parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Entity parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Entity parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Entity parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Entity parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Entity parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Entity parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Entity parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Entity parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Entity.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.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 com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Entity.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Entity getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Entity> parser()

    • getParserForType

      public com.google.protobuf.Parser<Entity> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Entity getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder