Class EntityMention.Builder (2.56.0)

Version latest

• 2.56.0 (latest)
• 2.55.0
• 2.54.0
• 2.53.0
• 2.52.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.1
• 2.3.4
• 2.2.0
• 2.1.10

public static final class EntityMention.Builder extends GeneratedMessageV3.Builder<EntityMention.Builder> implements EntityMentionOrBuilder

Represents a mention for an entity in the text. Currently, proper noun mentions are supported.

Protobuf type google.cloud.language.v2.EntityMention

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > EntityMention.Builder

Implements

EntityMentionOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
EntityMention.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public EntityMention build()

Returns
Type	Description
EntityMention

buildPartial()

public EntityMention buildPartial()

Returns
Type	Description
EntityMention

clear()

public EntityMention.Builder clear()

Returns
Type	Description
EntityMention.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public EntityMention.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
EntityMention.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public EntityMention.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
EntityMention.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearProbability()

public EntityMention.Builder clearProbability()

Probability score associated with the entity.

The score shows the probability of the entity mention being the entity type. The score is in (0, 1] range.

float probability = 4;

Returns
Type	Description
EntityMention.Builder	This builder for chaining.

clearSentiment()

public EntityMention.Builder clearSentiment()

For calls to [AnalyzeEntitySentiment][] or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the sentiment expressed for this mention of the entity in the provided document.

.google.cloud.language.v2.Sentiment sentiment = 3;

Returns
Type	Description
EntityMention.Builder

clearText()

public EntityMention.Builder clearText()

The mention text.

.google.cloud.language.v2.TextSpan text = 1;

Returns
Type	Description
EntityMention.Builder

clearType()

public EntityMention.Builder clearType()

The type of the entity mention.

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

Returns
Type	Description
EntityMention.Builder	This builder for chaining.

clone()

public EntityMention.Builder clone()

Returns
Type	Description
EntityMention.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public EntityMention getDefaultInstanceForType()

Returns
Type	Description
EntityMention

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getProbability()

public float getProbability()

Probability score associated with the entity.

The score shows the probability of the entity mention being the entity type. The score is in (0, 1] range.

float probability = 4;

Returns
Type	Description
float	The probability.

getSentiment()

public Sentiment getSentiment()

For calls to [AnalyzeEntitySentiment][] or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the sentiment expressed for this mention of the entity in the provided document.

.google.cloud.language.v2.Sentiment sentiment = 3;

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 sentiment expressed for this mention of the entity in the provided document.

.google.cloud.language.v2.Sentiment sentiment = 3;

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 sentiment expressed for this mention of the entity in the provided document.

.google.cloud.language.v2.Sentiment sentiment = 3;

Returns
Type	Description
SentimentOrBuilder

getText()

public TextSpan getText()

The mention text.

.google.cloud.language.v2.TextSpan text = 1;

Returns
Type	Description
TextSpan	The text.

getTextBuilder()

public TextSpan.Builder getTextBuilder()

The mention text.

.google.cloud.language.v2.TextSpan text = 1;

Returns
Type	Description
TextSpan.Builder

getTextOrBuilder()

public TextSpanOrBuilder getTextOrBuilder()

The mention text.

.google.cloud.language.v2.TextSpan text = 1;

Returns
Type	Description
TextSpanOrBuilder

getType()

public EntityMention.Type getType()

The type of the entity mention.

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

Returns
Type	Description
EntityMention.Type	The type.

getTypeValue()

public int getTypeValue()

The type of the entity mention.

.google.cloud.language.v2.EntityMention.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 sentiment expressed for this mention of the entity in the provided document.

.google.cloud.language.v2.Sentiment sentiment = 3;

Returns
Type	Description
boolean	Whether the sentiment field is set.

hasText()

public boolean hasText()

The mention text.

.google.cloud.language.v2.TextSpan text = 1;

Returns
Type	Description
boolean	Whether the text field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(EntityMention other)

public EntityMention.Builder mergeFrom(EntityMention other)

Parameter
Name	Description
other	EntityMention

Returns
Type	Description
EntityMention.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public EntityMention.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
EntityMention.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public EntityMention.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
EntityMention.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeSentiment(Sentiment value)

public EntityMention.Builder mergeSentiment(Sentiment value)

For calls to [AnalyzeEntitySentiment][] or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the sentiment expressed for this mention of the entity in the provided document.

.google.cloud.language.v2.Sentiment sentiment = 3;

Parameter
Name	Description
value	Sentiment

Returns
Type	Description
EntityMention.Builder

mergeText(TextSpan value)

public EntityMention.Builder mergeText(TextSpan value)

The mention text.

.google.cloud.language.v2.TextSpan text = 1;

Parameter
Name	Description
value	TextSpan

Returns
Type	Description
EntityMention.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final EntityMention.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
EntityMention.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
EntityMention.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setProbability(float value)

public EntityMention.Builder setProbability(float value)

Probability score associated with the entity.

The score shows the probability of the entity mention being the entity type. The score is in (0, 1] range.

float probability = 4;

Parameter
Name	Description
value	float The probability to set.

Returns
Type	Description
EntityMention.Builder	This builder for chaining.

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
EntityMention.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSentiment(Sentiment value)

public EntityMention.Builder setSentiment(Sentiment value)

For calls to [AnalyzeEntitySentiment][] or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the sentiment expressed for this mention of the entity in the provided document.

.google.cloud.language.v2.Sentiment sentiment = 3;

Parameter
Name	Description
value	Sentiment

Returns
Type	Description
EntityMention.Builder

setSentiment(Sentiment.Builder builderForValue)

public EntityMention.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 sentiment expressed for this mention of the entity in the provided document.

.google.cloud.language.v2.Sentiment sentiment = 3;

Parameter
Name	Description
builderForValue	Sentiment.Builder

Returns
Type	Description
EntityMention.Builder

setText(TextSpan value)

public EntityMention.Builder setText(TextSpan value)

The mention text.

.google.cloud.language.v2.TextSpan text = 1;

Parameter
Name	Description
value	TextSpan

Returns
Type	Description
EntityMention.Builder

setText(TextSpan.Builder builderForValue)

public EntityMention.Builder setText(TextSpan.Builder builderForValue)

The mention text.

.google.cloud.language.v2.TextSpan text = 1;

Parameter
Name	Description
builderForValue	TextSpan.Builder

Returns
Type	Description
EntityMention.Builder

setType(EntityMention.Type value)

public EntityMention.Builder setType(EntityMention.Type value)

The type of the entity mention.

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

Parameter
Name	Description
value	EntityMention.Type The type to set.

Returns
Type	Description
EntityMention.Builder	This builder for chaining.

setTypeValue(int value)

public EntityMention.Builder setTypeValue(int value)

The type of the entity mention.

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

Parameter
Name	Description
value	int The enum numeric value on the wire for type to set.

Returns
Type	Description
EntityMention.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final EntityMention.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
EntityMention.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)