Entity.Builder (Google Cloud Natural Language Parent 2.4.1 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<Entity.Builder>
    - - com.google.cloud.language.v1beta2.Entity.Builder

All Implemented Interfaces:: EntityOrBuilder, Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, Cloneable

Enclosing class:: Entity

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.v1beta2.Entity

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Entity.Builder`	`addAllMentions(Iterable<? extends EntityMention> values)` The mentions of this entity in the input document.
`Entity.Builder`	`addMentions(EntityMention.Builder builderForValue)` The mentions of this entity in the input document.
`Entity.Builder`	`addMentions(EntityMention value)` The mentions of this entity in the input document.
`Entity.Builder`	`addMentions(int index, EntityMention.Builder builderForValue)` The mentions of this entity in the input document.
`Entity.Builder`	`addMentions(int index, EntityMention value)` The mentions of this entity in the input document.
`EntityMention.Builder`	`addMentionsBuilder()` The mentions of this entity in the input document.
`EntityMention.Builder`	`addMentionsBuilder(int index)` The mentions of this entity in the input document.
`Entity.Builder`	`addRepeatedField(Descriptors.FieldDescriptor field, Object value)`
`Entity`	`build()`
`Entity`	`buildPartial()`
`Entity.Builder`	`clear()`
`Entity.Builder`	`clearField(Descriptors.FieldDescriptor field)`
`Entity.Builder`	`clearMentions()` The mentions of this entity in the input document.
`Entity.Builder`	`clearMetadata()`
`Entity.Builder`	`clearName()` The representative name for the entity.
`Entity.Builder`	`clearOneof(Descriptors.OneofDescriptor oneof)`
`Entity.Builder`	`clearSalience()` The salience score associated with the entity in the [0, 1.0] range.
`Entity.Builder`	`clearSentiment()` For calls to [AnalyzeEntitySentiment][] or if [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1beta2.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.Builder`	`clearType()` The entity type.
`Entity.Builder`	`clone()`
`boolean`	`containsMetadata(String key)` Metadata associated with the entity.
`Entity`	`getDefaultInstanceForType()`
`static Descriptors.Descriptor`	`getDescriptor()`
`Descriptors.Descriptor`	`getDescriptorForType()`
`EntityMention`	`getMentions(int index)` The mentions of this entity in the input document.
`EntityMention.Builder`	`getMentionsBuilder(int index)` The mentions of this entity in the input document.
`List<EntityMention.Builder>`	`getMentionsBuilderList()` The mentions of this entity in the input document.
`int`	`getMentionsCount()` The mentions of this entity in the input document.
`List<EntityMention>`	`getMentionsList()` The mentions of this entity in the input document.
`EntityMentionOrBuilder`	`getMentionsOrBuilder(int index)` The mentions of this entity in the input document.
`List<? extends EntityMentionOrBuilder>`	`getMentionsOrBuilderList()` The mentions of this entity in the input document.
`Map<String,String>`	`getMetadata()` Deprecated.
`int`	`getMetadataCount()` Metadata associated with the entity.
`Map<String,String>`	`getMetadataMap()` Metadata associated with the entity.
`String`	`getMetadataOrDefault(String key, String defaultValue)` Metadata associated with the entity.
`String`	`getMetadataOrThrow(String key)` Metadata associated with the entity.
`Map<String,String>`	`getMutableMetadata()` Deprecated.
`String`	`getName()` The representative name for the entity.
`ByteString`	`getNameBytes()` The representative name for the entity.
`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][google.cloud.language.v1beta2.AnnotateTextRequest.Features.extract_entity_sentiment] is set to true, this field will contain the aggregate sentiment expressed for this entity in the provided document.
`Sentiment.Builder`	`getSentimentBuilder()` For calls to [AnalyzeEntitySentiment][] or if [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1beta2.AnnotateTextRequest.Features.extract_entity_sentiment] is set to true, this field will contain the aggregate sentiment expressed for this entity in the provided document.
`SentimentOrBuilder`	`getSentimentOrBuilder()` For calls to [AnalyzeEntitySentiment][] or if [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1beta2.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.Type`	`getType()` The entity type.
`int`	`getTypeValue()` The entity type.
`boolean`	`hasSentiment()` For calls to [AnalyzeEntitySentiment][] or if [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1beta2.AnnotateTextRequest.Features.extract_entity_sentiment] is set to true, this field will contain the aggregate sentiment expressed for this entity in the provided document.
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected MapField`	`internalGetMapField(int number)`
`protected MapField`	`internalGetMutableMapField(int number)`
`boolean`	`isInitialized()`
`Entity.Builder`	`mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`Entity.Builder`	`mergeFrom(Entity other)`
`Entity.Builder`	`mergeFrom(Message other)`
`Entity.Builder`	`mergeSentiment(Sentiment value)` For calls to [AnalyzeEntitySentiment][] or if [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1beta2.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.Builder`	`mergeUnknownFields(UnknownFieldSet unknownFields)`
`Entity.Builder`	`putAllMetadata(Map<String,String> values)` Metadata associated with the entity.
`Entity.Builder`	`putMetadata(String key, String value)` Metadata associated with the entity.
`Entity.Builder`	`removeMentions(int index)` The mentions of this entity in the input document.
`Entity.Builder`	`removeMetadata(String key)` Metadata associated with the entity.
`Entity.Builder`	`setField(Descriptors.FieldDescriptor field, Object value)`
`Entity.Builder`	`setMentions(int index, EntityMention.Builder builderForValue)` The mentions of this entity in the input document.
`Entity.Builder`	`setMentions(int index, EntityMention value)` The mentions of this entity in the input document.
`Entity.Builder`	`setName(String value)` The representative name for the entity.
`Entity.Builder`	`setNameBytes(ByteString value)` The representative name for the entity.
`Entity.Builder`	`setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)`
`Entity.Builder`	`setSalience(float value)` The salience score associated with the entity in the [0, 1.0] range.
`Entity.Builder`	`setSentiment(Sentiment.Builder builderForValue)` For calls to [AnalyzeEntitySentiment][] or if [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1beta2.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.Builder`	`setSentiment(Sentiment value)` For calls to [AnalyzeEntitySentiment][] or if [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1beta2.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.Builder`	`setType(Entity.Type value)` The entity type.
`Entity.Builder`	`setTypeValue(int value)` The entity type.
`Entity.Builder`	`setUnknownFields(UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetMapField
```
protected MapField internalGetMapField(int number)
```
Overrides:

internalGetMapField in class GeneratedMessageV3.Builder<Entity.Builder>

internalGetMutableMapField
```
protected MapField internalGetMutableMapField(int number)
```
Overrides:

internalGetMutableMapField in class GeneratedMessageV3.Builder<Entity.Builder>

internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<Entity.Builder>

clear
```
public Entity.Builder clear()
```
Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<Entity.Builder>

getDescriptorForType
```
public Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<Entity.Builder>

getDefaultInstanceForType
```
public Entity getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build
```
public Entity build()
```
Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial
```
public Entity buildPartial()
```
Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone
```
public Entity.Builder clone()
```
Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<Entity.Builder>

setField

public Entity.Builder setField(Descriptors.FieldDescriptor field,
                               Object value)

Specified by:: setField in interface Message.Builder
Overrides:: setField in class GeneratedMessageV3.Builder<Entity.Builder>

clearField
```
public Entity.Builder clearField(Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<Entity.Builder>

clearOneof
```
public Entity.Builder clearOneof(Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<Entity.Builder>

setRepeatedField

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

Specified by:: setRepeatedField in interface Message.Builder
Overrides:: setRepeatedField in class GeneratedMessageV3.Builder<Entity.Builder>

addRepeatedField

public Entity.Builder addRepeatedField(Descriptors.FieldDescriptor field,
                                       Object value)

Specified by:: addRepeatedField in interface Message.Builder
Overrides:: addRepeatedField in class GeneratedMessageV3.Builder<Entity.Builder>

mergeFrom
```
public Entity.Builder mergeFrom(Message other)
```
Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<Entity.Builder>

mergeFrom

public Entity.Builder mergeFrom(Entity other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<Entity.Builder>

mergeFrom

public Entity.Builder mergeFrom(CodedInputStream input,
                                ExtensionRegistryLite extensionRegistry)
                         throws IOException

Specified by:: mergeFrom in interface Message.Builder
Specified by:: mergeFrom in interface MessageLite.Builder
Overrides:: mergeFrom in class AbstractMessage.Builder<Entity.Builder>
Throws:: IOException

getName
```
public String getName()
```
```
 The representative name for the entity.
 
```
string name = 1;
Specified by:

getName in interface EntityOrBuilder

Returns:

The name.

getNameBytes
```
public ByteString getNameBytes()
```
```
 The representative name for the entity.
 
```
string name = 1;
Specified by:

getNameBytes in interface EntityOrBuilder

Returns:

The bytes for name.

setName

public Entity.Builder setName(String value)

 The representative name for the entity.

string name = 1;

Parameters:: value - The name to set.
Returns:: This builder for chaining.

clearName

public Entity.Builder clearName()

 The representative name for the entity.

string name = 1;

Returns:: This builder for chaining.

setNameBytes

public Entity.Builder setNameBytes(ByteString value)

 The representative name for the entity.

string name = 1;

Parameters:: value - The bytes for name to set.
Returns:: This builder for chaining.

getTypeValue
```
public int getTypeValue()
```
```
 The entity type.
 
```
.google.cloud.language.v1beta2.Entity.Type type = 2;
Specified by:

getTypeValue in interface EntityOrBuilder

Returns:

The enum numeric value on the wire for type.

setTypeValue
```
public Entity.Builder setTypeValue(int value)
```
```
 The entity type.
 
```
.google.cloud.language.v1beta2.Entity.Type type = 2;
Parameters:

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

Returns:

This builder for chaining.

getType
```
public Entity.Type getType()
```
```
 The entity type.
 
```
.google.cloud.language.v1beta2.Entity.Type type = 2;
Specified by:

getType in interface EntityOrBuilder

Returns:

The type.

setType
```
public Entity.Builder setType(Entity.Type value)
```
```
 The entity type.
 
```
.google.cloud.language.v1beta2.Entity.Type type = 2;
Parameters:

value - The type to set.

Returns:

This builder for chaining.

clearType
```
public Entity.Builder clearType()
```
```
 The entity type.
 
```
.google.cloud.language.v1beta2.Entity.Type type = 2;
Returns:

This builder for chaining.

getMetadataCount

public int getMetadataCount()

Description copied from interface: EntityOrBuilder

 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;

Specified by:: getMetadataCount in interface EntityOrBuilder

containsMetadata

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;

Specified by:: containsMetadata in interface EntityOrBuilder

getMetadata
```
@Deprecated
public Map<String,String> getMetadata()
```
Deprecated.

Use getMetadataMap() instead.

Specified by:

getMetadata in interface EntityOrBuilder

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;

Specified by:: getMetadataMap in interface EntityOrBuilder

getMetadataOrDefault

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;

Specified by:: getMetadataOrDefault in interface EntityOrBuilder

getMetadataOrThrow

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;

Specified by:: getMetadataOrThrow in interface EntityOrBuilder

clearMetadata
```
public Entity.Builder clearMetadata()
```

removeMetadata

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;

getMutableMetadata
```
@Deprecated
public Map<String,String> getMutableMetadata()
```
Deprecated.

Use alternate mutation accessors instead.

putMetadata

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;

putAllMetadata

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;

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;

Specified by:: getSalience in interface EntityOrBuilder
Returns:: The salience.

setSalience

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;

Parameters:: value - The salience to set.
Returns:: This builder for chaining.

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:: This builder for chaining.