com.google.api.services.language.v2.model

Class Entity

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.language.v2.model.Entity

All Implemented Interfaces:

Cloneable, Map<String,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 probability 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

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

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

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Entity()

Method Summary

Modifier and Type	Method and Description
Entity	clone()
List<EntityMention>	getMentions() The mentions of this entity in the input document.
Map<String,String>	getMetadata() Metadata associated with the entity.
String	getName() The representative name for the entity.
Sentiment	getSentiment() For calls to AnalyzeEntitySentiment this field will contain the aggregate sentiment expressed for this entity in the provided document.
String	getType() The entity type.
Entity	set(String fieldName, Object value)
Entity	setMentions(List<EntityMention> mentions) The mentions of this entity in the input document.
Entity	setMetadata(Map<String,String> metadata) Metadata associated with the entity.
Entity	setName(String name) The representative name for the entity.
Entity	setSentiment(Sentiment sentiment) For calls to AnalyzeEntitySentiment this field will contain the aggregate sentiment expressed for this entity in the provided document.
Entity	setType(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, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, 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 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(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 Map<String,String> getMetadata()

Metadata associated with the entity. For the metadata associated with other entity types, see the Type table below.

Returns:

value or null for none

setMetadata

public Entity setMetadata(Map<String,String> metadata)

Metadata associated with the entity. For the metadata associated with other entity types, see the Type table below.

Parameters:

metadata - metadata or null for none

getName

public String getName()

The representative name for the entity.

Returns:

value or null for none

setName

public Entity setName(String name)

The representative name for the entity.

Parameters:

name - name or null for none

getSentiment

public Sentiment getSentiment()

For calls to AnalyzeEntitySentiment 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 this field will contain the aggregate sentiment expressed for this entity in the provided document.

Parameters:

sentiment - sentiment or null for none

getType

public String getType()

The entity type.

Returns:

value or null for none

setType

public Entity setType(String type)

The entity type.

Parameters:

type - type or null for none

set

public Entity set(String fieldName,
                  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