Class Entity.Builder (2.8.0) 

publicstaticfinalclass Entity.BuilderextendsGeneratedMessageV3.Builder<Entity.Builder>implementsEntityOrBuilder

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

Implements

EntityOrBuilder

Inherited Members

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

Static Methods

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

Methods

addAllMentions(Iterable<? extends EntityMention> values)

publicEntity.BuilderaddAllMentions(Iterable<?extendsEntityMention>values)

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

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

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

addMentions(EntityMention value)

publicEntity.BuilderaddMentions(EntityMentionvalue)

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

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

Parameter
Name Description
value EntityMention
Returns
Type Description
Entity.Builder

addMentions(EntityMention.Builder builderForValue)

publicEntity.BuilderaddMentions(EntityMention.BuilderbuilderForValue)

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

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

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

addMentions(int index, EntityMention value)

publicEntity.BuilderaddMentions(intindex,EntityMentionvalue)

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

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

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

addMentions(int index, EntityMention.Builder builderForValue)

publicEntity.BuilderaddMentions(intindex,EntityMention.BuilderbuilderForValue)

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

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

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

addMentionsBuilder()

publicEntityMention.BuilderaddMentionsBuilder()

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

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

Returns
Type Description
EntityMention.Builder

addMentionsBuilder(int index)

publicEntityMention.BuilderaddMentionsBuilder(intindex)

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

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

Parameter
Name Description
index int
Returns
Type Description
EntityMention.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

publicEntity.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Entity.Builder
Overrides

build()

publicEntitybuild()
Returns
Type Description
Entity

buildPartial()

publicEntitybuildPartial()
Returns
Type Description
Entity

clear()

publicEntity.Builderclear()
Returns
Type Description
Entity.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

publicEntity.BuilderclearField(Descriptors.FieldDescriptorfield)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Entity.Builder
Overrides

clearMentions()

publicEntity.BuilderclearMentions()

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

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

Returns
Type Description
Entity.Builder

clearMetadata()

publicEntity.BuilderclearMetadata()
Returns
Type Description
Entity.Builder

clearName()

publicEntity.BuilderclearName()

The representative name for the entity.

string name = 1;

Returns
Type Description
Entity.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

publicEntity.BuilderclearOneof(Descriptors.OneofDescriptoroneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Entity.Builder
Overrides

clearSalience()

publicEntity.BuilderclearSalience()

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;

Returns
Type Description
Entity.Builder

This builder for chaining.

clearSentiment()

publicEntity.BuilderclearSentiment()

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

Returns
Type Description
Entity.Builder

clearType()

publicEntity.BuilderclearType()

The entity type.

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

Returns
Type Description
Entity.Builder

This builder for chaining.

clone()

publicEntity.Builderclone()
Returns
Type Description
Entity.Builder
Overrides

containsMetadata(String key)

publicbooleancontainsMetadata(Stringkey)

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()

publicEntitygetDefaultInstanceForType()
Returns
Type Description
Entity

getDescriptorForType()

publicDescriptors.DescriptorgetDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getMentions(int index)

publicEntityMentiongetMentions(intindex)

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

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

Parameter
Name Description
index int
Returns
Type Description
EntityMention

getMentionsBuilder(int index)

publicEntityMention.BuildergetMentionsBuilder(intindex)

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

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

Parameter
Name Description
index int
Returns
Type Description
EntityMention.Builder

getMentionsBuilderList()

publicList<EntityMention.Builder>getMentionsBuilderList()

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

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

Returns
Type Description
List<Builder>

getMentionsCount()

publicintgetMentionsCount()

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

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

Returns
Type Description
int

getMentionsList()

publicList<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;

Returns
Type Description
List<EntityMention>

getMentionsOrBuilder(int index)

publicEntityMentionOrBuildergetMentionsOrBuilder(intindex)

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

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

Parameter
Name Description
index int
Returns
Type Description
EntityMentionOrBuilder

getMentionsOrBuilderList()

publicList<?extendsEntityMentionOrBuilder>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;

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

getMetadata()

publicMap<String,String>getMetadata()

Use #getMetadataMap() instead.

Returns
Type Description
Map<String,String>

getMetadataCount()

publicintgetMetadataCount()

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()

publicMap<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)

publicStringgetMetadataOrDefault(Stringkey,StringdefaultValue)

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)

publicStringgetMetadataOrThrow(Stringkey)

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()

publicMap<String,String>getMutableMetadata()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

publicStringgetName()

The representative name for the entity.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

publicByteStringgetNameBytes()

The representative name for the entity.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getSalience()

publicfloatgetSalience()

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;

Returns
Type Description
float

The salience.

getSentiment()

publicSentimentgetSentiment()

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

Returns
Type Description
Sentiment

The sentiment.

getSentimentBuilder()

publicSentiment.BuildergetSentimentBuilder()

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

Returns
Type Description
Sentiment.Builder

getSentimentOrBuilder()

publicSentimentOrBuildergetSentimentOrBuilder()

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

Returns
Type Description
SentimentOrBuilder

getType()

publicEntity.TypegetType()

The entity type.

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

Returns
Type Description
Entity.Type

The type.

getTypeValue()

publicintgetTypeValue()

The entity type.

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

Returns
Type Description
int

The enum numeric value on the wire for type.

hasSentiment()

publicbooleanhasSentiment()

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

Returns
Type Description
boolean

Whether the sentiment field is set.

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapField(int number)

protectedMapFieldinternalGetMapField(intnumber)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

internalGetMutableMapField(int number)

protectedMapFieldinternalGetMutableMapField(intnumber)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Entity other)

publicEntity.BuildermergeFrom(Entityother)
Parameter
Name Description
other Entity
Returns
Type Description
Entity.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicEntity.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Entity.Builder
Overrides Exceptions
Type Description
IOException

mergeFrom(Message other)

publicEntity.BuildermergeFrom(Messageother)
Parameter
Name Description
other Message
Returns
Type Description
Entity.Builder
Overrides

mergeSentiment(Sentiment value)

publicEntity.BuildermergeSentiment(Sentimentvalue)

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

Parameter
Name Description
value Sentiment
Returns
Type Description
Entity.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

publicfinalEntity.BuildermergeUnknownFields(UnknownFieldSetunknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Entity.Builder
Overrides

putAllMetadata(Map<String,String> values)

publicEntity.BuilderputAllMetadata(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)

publicEntity.BuilderputMetadata(Stringkey,Stringvalue)

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)

publicEntity.BuilderremoveMentions(intindex)

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

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

Parameter
Name Description
index int
Returns
Type Description
Entity.Builder

removeMetadata(String key)

publicEntity.BuilderremoveMetadata(Stringkey)

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)

publicEntity.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Entity.Builder
Overrides

setMentions(int index, EntityMention value)

publicEntity.BuildersetMentions(intindex,EntityMentionvalue)

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

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

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

setMentions(int index, EntityMention.Builder builderForValue)

publicEntity.BuildersetMentions(intindex,EntityMention.BuilderbuilderForValue)

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

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

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

setName(String value)

publicEntity.BuildersetName(Stringvalue)

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)

publicEntity.BuildersetNameBytes(ByteStringvalue)

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)

publicEntity.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Entity.Builder
Overrides

setSalience(float value)

publicEntity.BuildersetSalience(floatvalue)

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;

Parameter
Name Description
value float

The salience to set.

Returns
Type Description
Entity.Builder

This builder for chaining.

setSentiment(Sentiment value)

publicEntity.BuildersetSentiment(Sentimentvalue)

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

Parameter
Name Description
value Sentiment
Returns
Type Description
Entity.Builder

setSentiment(Sentiment.Builder builderForValue)

publicEntity.BuildersetSentiment(Sentiment.BuilderbuilderForValue)

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

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

setType(Entity.Type value)

publicEntity.BuildersetType(Entity.Typevalue)

The entity type.

.google.cloud.language.v1.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)

publicEntity.BuildersetTypeValue(intvalue)

The entity type.

.google.cloud.language.v1.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)

publicfinalEntity.BuildersetUnknownFields(UnknownFieldSetunknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Entity.Builder
Overrides

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.