Class Entity.Builder (2.12.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 salience and mentions, with entities.

Protobuf type google.cloud.language.v1.Entity

Implements

EntityOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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.v1.EntityMention mentions = 5;

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.language.v1.EntityMention>
Returns
TypeDescription
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.v1.EntityMention mentions = 5;

Parameter
NameDescription
valueEntityMention
Returns
TypeDescription
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.v1.EntityMention mentions = 5;

Parameter
NameDescription
builderForValueEntityMention.Builder
Returns
TypeDescription
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.v1.EntityMention mentions = 5;

Parameters
NameDescription
indexint
valueEntityMention
Returns
TypeDescription
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.v1.EntityMention mentions = 5;

Parameters
NameDescription
indexint
builderForValueEntityMention.Builder
Returns
TypeDescription
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.v1.EntityMention mentions = 5;

Returns
TypeDescription
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.v1.EntityMention mentions = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
EntityMention.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Entity.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Entity.Builder
Overrides

build()

public Entity build()
Returns
TypeDescription
Entity

buildPartial()

public Entity buildPartial()
Returns
TypeDescription
Entity

clear()

public Entity.Builder clear()
Returns
TypeDescription
Entity.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public Entity.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
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.v1.EntityMention mentions = 5;

Returns
TypeDescription
Entity.Builder

clearMetadata()

public Entity.Builder clearMetadata()
Returns
TypeDescription
Entity.Builder

clearName()

public Entity.Builder clearName()

The representative name for the entity.

string name = 1;

Returns
TypeDescription
Entity.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Entity.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Entity.Builder
Overrides

clearSalience()

public Entity.Builder clearSalience()

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
TypeDescription
Entity.Builder

This builder for chaining.

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

Returns
TypeDescription
Entity.Builder

clearType()

public Entity.Builder clearType()

The entity type.

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

Returns
TypeDescription
Entity.Builder

This builder for chaining.

clone()

public Entity.Builder clone()
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
boolean

getDefaultInstanceForType()

public Entity getDefaultInstanceForType()
Returns
TypeDescription
Entity

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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.v1.EntityMention mentions = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
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.v1.EntityMention mentions = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
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.v1.EntityMention mentions = 5;

Returns
TypeDescription
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.v1.EntityMention mentions = 5;

Returns
TypeDescription
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.v1.EntityMention mentions = 5;

Returns
TypeDescription
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.v1.EntityMention mentions = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
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.v1.EntityMention mentions = 5;

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

getMetadata()

public Map<String,String> getMetadata()

Use #getMetadataMap() instead.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
String

getMutableMetadata()

public Map<String,String> getMutableMetadata()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getName()

public String getName()

The representative name for the entity.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

The representative name for the entity.

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

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;

Returns
TypeDescription
float

The salience.

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

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

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

Returns
TypeDescription
SentimentOrBuilder

getType()

public Entity.Type getType()

The entity type.

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

Returns
TypeDescription
Entity.Type

The type.

getTypeValue()

public int getTypeValue()

The entity type.

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

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

Returns
TypeDescription
boolean

Whether the sentiment field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(Entity other)

public Entity.Builder mergeFrom(Entity other)
Parameter
NameDescription
otherEntity
Returns
TypeDescription
Entity.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Entity.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Entity.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Entity.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
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.v1.Sentiment sentiment = 6;

Parameter
NameDescription
valueSentiment
Returns
TypeDescription
Entity.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Entity.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valuesMap<String,String>
Returns
TypeDescription
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
NameDescription
keyString
valueString
Returns
TypeDescription
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.v1.EntityMention mentions = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
Entity.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Entity.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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.v1.EntityMention mentions = 5;

Parameters
NameDescription
indexint
valueEntityMention
Returns
TypeDescription
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.v1.EntityMention mentions = 5;

Parameters
NameDescription
indexint
builderForValueEntityMention.Builder
Returns
TypeDescription
Entity.Builder

setName(String value)

public Entity.Builder setName(String value)

The representative name for the entity.

string name = 1;

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Entity.Builder
Overrides

setSalience(float value)

public Entity.Builder setSalience(float value)

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
NameDescription
valuefloat

The salience to set.

Returns
TypeDescription
Entity.Builder

This builder for chaining.

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

Parameter
NameDescription
valueSentiment
Returns
TypeDescription
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.v1.Sentiment sentiment = 6;

Parameter
NameDescription
builderForValueSentiment.Builder
Returns
TypeDescription
Entity.Builder

setType(Entity.Type value)

public Entity.Builder setType(Entity.Type value)

The entity type.

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

Parameter
NameDescription
valueEntity.Type

The type to set.

Returns
TypeDescription
Entity.Builder

This builder for chaining.

setTypeValue(int value)

public Entity.Builder setTypeValue(int value)

The entity type.

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

Parameter
NameDescription
valueint

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

Returns
TypeDescription
Entity.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Entity.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Entity.Builder
Overrides