Class EntityMention.Builder (2.45.0)

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

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

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

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

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

getDefaultInstanceForType()

public EntityMention getDefaultInstanceForType()
Returns
Type Description
EntityMention

getDescriptorForType()

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

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Exceptions
Type Description
IOException

mergeFrom(Message other)

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

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

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

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

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