Entity (Cloud Natural Language API v1 (Rev. 518) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.language.v1.model.Entity

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class Entity
extends com.google.api.client.json.GenericJson
```
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.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Natural Language API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Entity()

Constructors
Constructor and Description
`Entity()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Entity`	`clone()`
`java.util.List<EntityMention>`	`getMentions()` The mentions of this entity in the input document.
`java.util.Map<java.lang.String,java.lang.String>`	`getMetadata()` Metadata associated with the entity.
`java.lang.String`	`getName()` The representative name for the entity.
`java.lang.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 is set to true, this field will contain the aggregate sentiment expressed for this entity in the provided document.
`java.lang.String`	`getType()` The entity type.
`Entity`	`set(java.lang.String fieldName, java.lang.Object value)`
`Entity`	`setMentions(java.util.List<EntityMention> mentions)` The mentions of this entity in the input document.
`Entity`	`setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)` Metadata associated with the entity.
`Entity`	`setName(java.lang.String name)` The representative name for the entity.
`Entity`	`setSalience(java.lang.Float salience)` The salience score associated with the entity in the [0, 1.0] range.
`Entity`	`setSentiment(Sentiment sentiment)` 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.
`Entity`	`setType(java.lang.String type)` The entity type.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Entity
```
public Entity()
```
- Method Detail
  - getMentions
```
public java.util.List<EntityMention> getMentions()
```
    The mentions of this entity in the input document. The API currently supports proper noun mentions.
    
    Returns:
    
    value or null for none
  - setMentions
```
public Entity setMentions(java.util.List<EntityMention> mentions)
```
    The mentions of this entity in the input document. The API currently supports proper noun mentions.
    
    Parameters:
    
    mentions - mentions or null for none
  - getMetadata
```
public java.util.Map<java.lang.String,java.lang.String> getMetadata()
```
    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.
    
    Returns:
    
    value or null for none
  - setMetadata
```
public Entity setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
```
    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.
    
    Parameters:
    
    metadata - metadata or null for none
  - getName
```
public java.lang.String getName()
```
    The representative name for the entity.
    
    Returns:
    
    value or null for none
  - setName
```
public Entity setName(java.lang.String name)
```
    The representative name for the entity.
    
    Parameters:
    
    name - name or null for none
  - getSalience
```
public java.lang.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.
    
    Returns:
    
    value or null for none
  - setSalience
```
public Entity setSalience(java.lang.Float salience)
```
    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.
    
    Parameters:
    
    salience - salience or null for none
  - 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.
    
    Returns:
    
    value or null for none
  - setSentiment
```
public Entity setSentiment(Sentiment sentiment)
```
    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.
    
    Parameters:
    
    sentiment - sentiment or null for none
  - getType
```
public java.lang.String getType()
```
    The entity type.
    
    Returns:
    
    value or null for none
  - setType
```
public Entity setType(java.lang.String type)
```
    The entity type.
    
    Parameters:
    
    type - type or null for none
  - set
```
public Entity set(java.lang.String fieldName,
                  java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Entity clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Cloud Natural Language API v1 (revision 518)

Class Entity

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Entity

Method Detail

getMentions

setMentions

getMetadata

setMetadata

getName

setName

getSalience

setSalience

getSentiment

setSentiment

getType

setType

set

clone