Class Entity.Builder (2.45.0)

public static final class Entity.Builder extends GeneratedMessageV3.Builder<Entity.Builder> 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 probability and mentions, with entities.

Protobuf type google.cloud.language.v2.Entity

Implements

EntityOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllMentions(Iterable<? extends EntityMention> values)

public Entity.Builder addAllMentions(Iterable<? extends EntityMention> values)

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

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.language.v2.EntityMention>
Returns
Type Description
Entity.Builder

addMentions(EntityMention value)

public Entity.Builder addMentions(EntityMention value)

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

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

Parameter
Name Description
value EntityMention
Returns
Type Description
Entity.Builder

addMentions(EntityMention.Builder builderForValue)

public Entity.Builder addMentions(EntityMention.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue EntityMention.Builder
Returns
Type Description
Entity.Builder

addMentions(int index, EntityMention value)

public Entity.Builder addMentions(int index, EntityMention value)

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

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

Parameters
Name Description
index int
value EntityMention
Returns
Type Description
Entity.Builder

addMentions(int index, EntityMention.Builder builderForValue)

public Entity.Builder addMentions(int index, EntityMention.Builder builderForValue)

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

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

Parameters
Name Description
index int
builderForValue EntityMention.Builder
Returns
Type Description
Entity.Builder

addMentionsBuilder()

public EntityMention.Builder addMentionsBuilder()

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

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

Returns
Type Description
EntityMention.Builder

addMentionsBuilder(int index)

public EntityMention.Builder addMentionsBuilder(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
EntityMention.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Entity.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Entity.Builder
Overrides

build()

public Entity build()
Returns
Type Description
Entity

buildPartial()

public Entity buildPartial()
Returns
Type Description
Entity

clear()

public Entity.Builder clear()
Returns
Type Description
Entity.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public Entity.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Entity.Builder
Overrides

clearMentions()

public Entity.Builder clearMentions()

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

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

Returns
Type Description
Entity.Builder

clearMetadata()

public Entity.Builder clearMetadata()
Returns
Type Description
Entity.Builder

clearName()

public Entity.Builder clearName()

The representative name for the entity.

string name = 1;

Returns
Type Description
Entity.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Entity.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Entity.Builder
Overrides

clearSentiment()

public Entity.Builder clearSentiment()

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.v2.Sentiment sentiment = 6;

Returns
Type Description
Entity.Builder

clearType()

public Entity.Builder clearType()

The entity type.

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

Returns
Type Description
Entity.Builder

This builder for chaining.

clone()

public Entity.Builder clone()
Returns
Type Description
Entity.Builder
Overrides

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
Name Description
key String
Returns
Type Description
boolean

getDefaultInstanceForType()

public Entity getDefaultInstanceForType()
Returns
Type Description
Entity

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

Parameter
Name Description
index int
Returns
Type Description
EntityMention

getMentionsBuilder(int index)

public EntityMention.Builder getMentionsBuilder(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
EntityMention.Builder

getMentionsBuilderList()

public List<EntityMention.Builder> getMentionsBuilderList()

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

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

Returns
Type Description
List<Builder>

getMentionsCount()

public int getMentionsCount()

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

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

Returns
Type Description
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.v2.EntityMention mentions = 5;

Returns
Type Description
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.v2.EntityMention mentions = 5;

Parameter
Name Description
index int
Returns
Type Description
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.v2.EntityMention mentions = 5;

Returns
Type Description
List<? extends com.google.cloud.language.v2.EntityMentionOrBuilder>

getMetadata() (deprecated)

public Map<String,String> getMetadata()

Use #getMetadataMap() instead.

Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
key String
defaultValue String
Returns
Type Description
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
Name Description
key String
Returns
Type Description
String

getMutableMetadata() (deprecated)

public Map<String,String> getMutableMetadata()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public String getName()

The representative name for the entity.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The representative name for the entity.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

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.v2.Sentiment sentiment = 6;

Returns
Type Description
Sentiment

The sentiment.

getSentimentBuilder()

public Sentiment.Builder getSentimentBuilder()

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.v2.Sentiment sentiment = 6;

Returns
Type Description
Sentiment.Builder

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.v2.Sentiment sentiment = 6;

Returns
Type Description
SentimentOrBuilder

getType()

public Entity.Type getType()

The entity type.

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

Returns
Type Description
Entity.Type

The type.

getTypeValue()

public int getTypeValue()

The entity type.

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

Returns
Type Description
int

The enum numeric value on the wire for type.

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.v2.Sentiment sentiment = 6;

Returns
Type Description
boolean

Whether the sentiment field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Entity other)

public Entity.Builder mergeFrom(Entity other)
Parameter
Name Description
other Entity
Returns
Type Description
Entity.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Entity.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Entity.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Entity.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Entity.Builder
Overrides

mergeSentiment(Sentiment value)

public Entity.Builder mergeSentiment(Sentiment value)

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.v2.Sentiment sentiment = 6;

Parameter
Name Description
value Sentiment
Returns
Type Description
Entity.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Entity.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Entity.Builder
Overrides

putAllMetadata(Map<String,String> values)

public Entity.Builder putAllMetadata(Map<String,String> values)

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
Name Description
values Map<String,String>
Returns
Type Description
Entity.Builder

putMetadata(String key, String value)

public Entity.Builder putMetadata(String key, String value)

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
Name Description
key String
value String
Returns
Type Description
Entity.Builder

removeMentions(int index)

public Entity.Builder removeMentions(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
Entity.Builder

removeMetadata(String key)

public Entity.Builder removeMetadata(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
Name Description
key String
Returns
Type Description
Entity.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Entity.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Entity.Builder
Overrides

setMentions(int index, EntityMention value)

public Entity.Builder setMentions(int index, EntityMention value)

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

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

Parameters
Name Description
index int
value EntityMention
Returns
Type Description
Entity.Builder

setMentions(int index, EntityMention.Builder builderForValue)

public Entity.Builder setMentions(int index, EntityMention.Builder builderForValue)

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

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

Parameters
Name Description
index int
builderForValue EntityMention.Builder
Returns
Type Description
Entity.Builder

setName(String value)

public Entity.Builder setName(String value)

The representative name for the entity.

string name = 1;

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Entity.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Entity.Builder setNameBytes(ByteString value)

The representative name for the entity.

string name = 1;

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Entity.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Entity.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Entity.Builder
Overrides

setSentiment(Sentiment value)

public Entity.Builder setSentiment(Sentiment value)

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.v2.Sentiment sentiment = 6;

Parameter
Name Description
value Sentiment
Returns
Type Description
Entity.Builder

setSentiment(Sentiment.Builder builderForValue)

public Entity.Builder setSentiment(Sentiment.Builder builderForValue)

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.v2.Sentiment sentiment = 6;

Parameter
Name Description
builderForValue Sentiment.Builder
Returns
Type Description
Entity.Builder

setType(Entity.Type value)

public Entity.Builder setType(Entity.Type value)

The entity type.

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

Parameter
Name Description
value Entity.Type

The type to set.

Returns
Type Description
Entity.Builder

This builder for chaining.

setTypeValue(int value)

public Entity.Builder setTypeValue(int value)

The entity type.

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

Parameter
Name Description
value int

The enum numeric value on the wire for type to set.

Returns
Type Description
Entity.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Entity.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Entity.Builder
Overrides