Class Entity.Builder (2.31.0)

Version latest

• 2.30.0 (latest)
• 2.29.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.v1beta2.Entity

Inheritance

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

Implements

EntityOrBuilder

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)

GeneratedMessageV3.Builder.internalGetMutableMapField(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

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.v1beta2.EntityMention mentions = 5;

Parameter
Name	Description
values	Iterable<? extends com.google.cloud.language.v1beta2.EntityMention>

Returns
Type	Description
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.v1beta2.EntityMention mentions = 5;

Parameter
Name	Description
value	EntityMention

Returns
Type	Description
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.v1beta2.EntityMention mentions = 5;

Parameter
Name	Description
builderForValue	EntityMention.Builder

Returns
Type	Description
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.v1beta2.EntityMention mentions = 5;

Parameters
Name	Description
index	int
value	EntityMention

Returns
Type	Description
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.v1beta2.EntityMention mentions = 5;

Parameters
Name	Description
index	int
builderForValue	EntityMention.Builder

Returns
Type	Description
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.v1beta2.EntityMention mentions = 5;

Returns
Type	Description
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.v1beta2.EntityMention mentions = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
EntityMention.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Entity.Builder

Overrides

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

build()

public Entity build()

Returns
Type	Description
Entity

buildPartial()

public Entity buildPartial()

Returns
Type	Description
Entity

clear()

public Entity.Builder clear()

Returns
Type	Description
Entity.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public Entity.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
Entity.Builder

Overrides

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

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.v1beta2.EntityMention mentions = 5;

Returns
Type	Description
Entity.Builder

clearMetadata()

public Entity.Builder clearMetadata()

Returns
Type	Description
Entity.Builder

clearName()

public Entity.Builder clearName()

The representative name for the entity.

string name = 1;

Returns
Type	Description
Entity.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Entity.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
Entity.Builder

Overrides

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

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
Type	Description
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.v1beta2.Sentiment sentiment = 6;

Returns
Type	Description
Entity.Builder

clearType()

public Entity.Builder clearType()

The entity type.

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

Returns
Type	Description
Entity.Builder	This builder for chaining.

clone()

public Entity.Builder clone()

Returns
Type	Description
Entity.Builder

Overrides