Class EntityAnnotation.Builder (3.1.3)

Version 3.1.3

• 3.51.0 (latest)
• 3.50.0
• 3.49.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.39.0
• 3.38.0
• 3.37.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.27.0
• 3.26.0
• 3.25.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.3
• 2.1.4
• 2.0.29

public static final class EntityAnnotation.Builder extends GeneratedMessageV3.Builder<EntityAnnotation.Builder> implements EntityAnnotationOrBuilder

Set of detected entity features.

Protobuf type google.cloud.vision.v1.EntityAnnotation

Inheritance

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

Implements

EntityAnnotationOrBuilder

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

addAllLocations(Iterable<? extends LocationInfo> values)

public EntityAnnotation.Builder addAllLocations(Iterable<? extends LocationInfo> values)

The location information for the detected entity. Multiple LocationInfo elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.

repeated .google.cloud.vision.v1.LocationInfo locations = 8;

Parameter

Name	Description
values	Iterable<? extends com.google.cloud.vision.v1.LocationInfo>

Returns

Type	Description
EntityAnnotation.Builder

addAllProperties(Iterable<? extends Property> values)

public EntityAnnotation.Builder addAllProperties(Iterable<? extends Property> values)

Some entities may have optional user-supplied Property (name/value) fields, such a score or string that qualifies the entity.

repeated .google.cloud.vision.v1.Property properties = 9;

Parameter

Name	Description
values	Iterable<? extends com.google.cloud.vision.v1.Property>

Returns

Type	Description
EntityAnnotation.Builder

addLocations(LocationInfo value)

public EntityAnnotation.Builder addLocations(LocationInfo value)

The location information for the detected entity. Multiple LocationInfo elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.

repeated .google.cloud.vision.v1.LocationInfo locations = 8;

Parameter

Name	Description
value	LocationInfo

Returns

Type	Description
EntityAnnotation.Builder

addLocations(LocationInfo.Builder builderForValue)

public EntityAnnotation.Builder addLocations(LocationInfo.Builder builderForValue)

The location information for the detected entity. Multiple LocationInfo elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.

repeated .google.cloud.vision.v1.LocationInfo locations = 8;

Parameter

Name	Description
builderForValue	LocationInfo.Builder

Returns

Type	Description
EntityAnnotation.Builder

addLocations(int index, LocationInfo value)

public EntityAnnotation.Builder addLocations(int index, LocationInfo value)

The location information for the detected entity. Multiple LocationInfo elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.

repeated .google.cloud.vision.v1.LocationInfo locations = 8;

Parameters

Name	Description
index	int
value	LocationInfo

Returns

Type	Description
EntityAnnotation.Builder

addLocations(int index, LocationInfo.Builder builderForValue)

public EntityAnnotation.Builder addLocations(int index, LocationInfo.Builder builderForValue)

The location information for the detected entity. Multiple LocationInfo elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.

repeated .google.cloud.vision.v1.LocationInfo locations = 8;

Parameters

Name	Description
index	int
builderForValue	LocationInfo.Builder

Returns

Type	Description
EntityAnnotation.Builder

addLocationsBuilder()

public LocationInfo.Builder addLocationsBuilder()

The location information for the detected entity. Multiple LocationInfo elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.

repeated .google.cloud.vision.v1.LocationInfo locations = 8;

Returns

Type	Description
LocationInfo.Builder

addLocationsBuilder(int index)

public LocationInfo.Builder addLocationsBuilder(int index)

The location information for the detected entity. Multiple LocationInfo elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.

repeated .google.cloud.vision.v1.LocationInfo locations = 8;

Parameter

Name	Description
index	int

Returns

Type	Description
LocationInfo.Builder

addProperties(Property value)

public EntityAnnotation.Builder addProperties(Property value)

Some entities may have optional user-supplied Property (name/value) fields, such a score or string that qualifies the entity.

repeated .google.cloud.vision.v1.Property properties = 9;

Parameter

Name	Description
value	Property

Returns

Type	Description
EntityAnnotation.Builder

addProperties(Property.Builder builderForValue)

public EntityAnnotation.Builder addProperties(Property.Builder builderForValue)

Some entities may have optional user-supplied Property (name/value) fields, such a score or string that qualifies the entity.

repeated .google.cloud.vision.v1.Property properties = 9;

Parameter

Name	Description
builderForValue	Property.Builder

Returns

Type	Description
EntityAnnotation.Builder

addProperties(int index, Property value)

public EntityAnnotation.Builder addProperties(int index, Property value)

Some entities may have optional user-supplied Property (name/value) fields, such a score or string that qualifies the entity.

repeated .google.cloud.vision.v1.Property properties = 9;

Parameters

Name	Description
index	int
value	Property

Returns

Type	Description
EntityAnnotation.Builder

addProperties(int index, Property.Builder builderForValue)

public EntityAnnotation.Builder addProperties(int index, Property.Builder builderForValue)

Some entities may have optional user-supplied Property (name/value) fields, such a score or string that qualifies the entity.

repeated .google.cloud.vision.v1.Property properties = 9;

Parameters

Name	Description
index	int
builderForValue	Property.Builder

Returns

Type	Description
EntityAnnotation.Builder

addPropertiesBuilder()

public Property.Builder addPropertiesBuilder()

Some entities may have optional user-supplied Property (name/value) fields, such a score or string that qualifies the entity.

repeated .google.cloud.vision.v1.Property properties = 9;

Returns

Type	Description
Property.Builder

addPropertiesBuilder(int index)

public Property.Builder addPropertiesBuilder(int index)

Some entities may have optional user-supplied Property (name/value) fields, such a score or string that qualifies the entity.

repeated .google.cloud.vision.v1.Property properties = 9;

Parameter

Name	Description
index	int

Returns

Type	Description
Property.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
EntityAnnotation.Builder

Overrides

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

build()

public EntityAnnotation build()

Returns

Type	Description
EntityAnnotation

buildPartial()

public EntityAnnotation buildPartial()

Returns

Type	Description
EntityAnnotation

clear()

public EntityAnnotation.Builder clear()

Returns

Type	Description
EntityAnnotation.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearBoundingPoly()

public EntityAnnotation.Builder clearBoundingPoly()

Image region to which this entity belongs. Not produced for LABEL_DETECTION features.

.google.cloud.vision.v1.BoundingPoly bounding_poly = 7;

Returns

Type	Description
EntityAnnotation.Builder

clearConfidence() (deprecated)

public EntityAnnotation.Builder clearConfidence()

Deprecated. google.cloud.vision.v1.EntityAnnotation.confidence is deprecated. See google/cloud/vision/v1/image_annotator.proto;l=506

Deprecated. Use score instead. The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1].

float confidence = 5 [deprecated = true];

Returns

Type	Description
EntityAnnotation.Builder	This builder for chaining.

clearDescription()

public EntityAnnotation.Builder clearDescription()

Entity textual description, expressed in its locale language.

string description = 3;

Returns

Type	Description
EntityAnnotation.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public EntityAnnotation.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
EntityAnnotation.Builder

Overrides

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

clearLocale()

public EntityAnnotation.Builder clearLocale()

The language code for the locale in which the entity textual description is expressed.

string locale = 2;

Returns

Type	Description
EntityAnnotation.Builder	This builder for chaining.

clearLocations()

public EntityAnnotation.Builder clearLocations()

The location information for the detected entity. Multiple LocationInfo elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.

repeated .google.cloud.vision.v1.LocationInfo locations = 8;

Returns

Type	Description
EntityAnnotation.Builder

clearMid()

public EntityAnnotation.Builder clearMid()

Opaque entity ID. Some IDs may be available in Google Knowledge Graph Search API.

string mid = 1;

Returns

Type	Description
EntityAnnotation.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public EntityAnnotation.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
EntityAnnotation.Builder

Overrides

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

clearProperties()

public EntityAnnotation.Builder clearProperties()

Some entities may have optional user-supplied Property (name/value) fields, such a score or string that qualifies the entity.

repeated .google.cloud.vision.v1.Property properties = 9;

Returns

Type	Description
EntityAnnotation.Builder

clearScore()

public EntityAnnotation.Builder clearScore()

Overall score of the result. Range [0, 1].

float score = 4;

Returns

Type	Description
EntityAnnotation.Builder	This builder for chaining.

clearTopicality()

public EntityAnnotation.Builder clearTopicality()

The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1].

float topicality = 6;

Returns

Type	Description
EntityAnnotation.Builder	This builder for chaining.

clone()

public EntityAnnotation.Builder clone()

Returns

Type	Description
EntityAnnotation.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getBoundingPoly()

public BoundingPoly getBoundingPoly()

Image region to which this entity belongs. Not produced for LABEL_DETECTION features.

.google.cloud.vision.v1.BoundingPoly bounding_poly = 7;

Returns

Type	Description
BoundingPoly	The boundingPoly.

getBoundingPolyBuilder()

public BoundingPoly.Builder getBoundingPolyBuilder()

Image region to which this entity belongs. Not produced for LABEL_DETECTION features.

.google.cloud.vision.v1.BoundingPoly bounding_poly = 7;

Returns

Type	Description
BoundingPoly.Builder

getBoundingPolyOrBuilder()

public BoundingPolyOrBuilder getBoundingPolyOrBuilder()

Image region to which this entity belongs. Not produced for LABEL_DETECTION features.

.google.cloud.vision.v1.BoundingPoly bounding_poly = 7;

Returns

Type	Description
BoundingPolyOrBuilder

getConfidence() (deprecated)

public float getConfidence()

Deprecated. google.cloud.vision.v1.EntityAnnotation.confidence is deprecated. See google/cloud/vision/v1/image_annotator.proto;l=506

Deprecated. Use score instead. The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1].

float confidence = 5 [deprecated = true];

Returns

Type	Description
float	The confidence.

getDefaultInstanceForType()

public EntityAnnotation getDefaultInstanceForType()

Returns

Type	Description
EntityAnnotation

getDescription()

public String getDescription()

Entity textual description, expressed in its locale language.

string description = 3;

Returns

Type	Description
String	The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Entity textual description, expressed in its locale language.

string description = 3;

Returns

Type	Description
ByteString	The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getLocale()

public String getLocale()

The language code for the locale in which the entity textual description is expressed.

string locale = 2;

Returns

Type	Description
String	The locale.

getLocaleBytes()

public ByteString getLocaleBytes()

The language code for the locale in which the entity textual description is expressed.

string locale = 2;

Returns

Type	Description
ByteString	The bytes for locale.

getLocations(int index)

public LocationInfo getLocations(int index)

The location information for the detected entity. Multiple LocationInfo elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.

repeated .google.cloud.vision.v1.LocationInfo locations = 8;

Parameter

Name	Description
index	int

Returns

Type	Description
LocationInfo

getLocationsBuilder(int index)

public LocationInfo.Builder getLocationsBuilder(int index)

The location information for the detected entity. Multiple LocationInfo elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.

repeated .google.cloud.vision.v1.LocationInfo locations = 8;

Parameter

Name	Description
index	int

Returns

Type	Description
LocationInfo.Builder

getLocationsBuilderList()

public List<LocationInfo.Builder> getLocationsBuilderList()

The location information for the detected entity. Multiple LocationInfo elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.

repeated .google.cloud.vision.v1.LocationInfo locations = 8;

Returns

Type	Description
List<Builder>

getLocationsCount()

public int getLocationsCount()

The location information for the detected entity. Multiple LocationInfo elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.

repeated .google.cloud.vision.v1.LocationInfo locations = 8;

Returns

Type	Description
int

getLocationsList()

public List<LocationInfo> getLocationsList()

The location information for the detected entity. Multiple LocationInfo elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.

repeated .google.cloud.vision.v1.LocationInfo locations = 8;

Returns

Type	Description
List<LocationInfo>

getLocationsOrBuilder(int index)

public LocationInfoOrBuilder getLocationsOrBuilder(int index)

The location information for the detected entity. Multiple LocationInfo elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.

repeated .google.cloud.vision.v1.LocationInfo locations = 8;

Parameter

Name	Description
index	int

Returns

Type	Description
LocationInfoOrBuilder

getLocationsOrBuilderList()

public List<? extends LocationInfoOrBuilder> getLocationsOrBuilderList()

The location information for the detected entity. Multiple LocationInfo elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.

repeated .google.cloud.vision.v1.LocationInfo locations = 8;

Returns

Type	Description
List<? extends com.google.cloud.vision.v1.LocationInfoOrBuilder>

getMid()

public String getMid()

Opaque entity ID. Some IDs may be available in Google Knowledge Graph Search API.

string mid = 1;

Returns

Type	Description
String	The mid.

getMidBytes()

public ByteString getMidBytes()

Opaque entity ID. Some IDs may be available in Google Knowledge Graph Search API.

string mid = 1;

Returns

Type	Description
ByteString	The bytes for mid.

getProperties(int index)

public Property getProperties(int index)

Some entities may have optional user-supplied Property (name/value) fields, such a score or string that qualifies the entity.

repeated .google.cloud.vision.v1.Property properties = 9;

Parameter

Name	Description
index	int

Returns

Type	Description
Property

getPropertiesBuilder(int index)

public Property.Builder getPropertiesBuilder(int index)

Some entities may have optional user-supplied Property (name/value) fields, such a score or string that qualifies the entity.

repeated .google.cloud.vision.v1.Property properties = 9;

Parameter

Name	Description
index	int

Returns

Type	Description
Property.Builder

getPropertiesBuilderList()

public List<Property.Builder> getPropertiesBuilderList()

Some entities may have optional user-supplied Property (name/value) fields, such a score or string that qualifies the entity.

repeated .google.cloud.vision.v1.Property properties = 9;

Returns

Type	Description
List<Builder>

getPropertiesCount()

public int getPropertiesCount()

Some entities may have optional user-supplied Property (name/value) fields, such a score or string that qualifies the entity.

repeated .google.cloud.vision.v1.Property properties = 9;

Returns

Type	Description
int

getPropertiesList()

public List<Property> getPropertiesList()

Some entities may have optional user-supplied Property (name/value) fields, such a score or string that qualifies the entity.

repeated .google.cloud.vision.v1.Property properties = 9;

Returns

Type	Description
List<Property>

getPropertiesOrBuilder(int index)

public PropertyOrBuilder getPropertiesOrBuilder(int index)

Some entities may have optional user-supplied Property (name/value) fields, such a score or string that qualifies the entity.

repeated .google.cloud.vision.v1.Property properties = 9;

Parameter

Name	Description
index	int

Returns

Type	Description
PropertyOrBuilder

getPropertiesOrBuilderList()

public List<? extends PropertyOrBuilder> getPropertiesOrBuilderList()

Some entities may have optional user-supplied Property (name/value) fields, such a score or string that qualifies the entity.

repeated .google.cloud.vision.v1.Property properties = 9;

Returns

Type	Description
List<? extends com.google.cloud.vision.v1.PropertyOrBuilder>

getScore()

public float getScore()

Overall score of the result. Range [0, 1].

float score = 4;

Returns

Type	Description
float	The score.

getTopicality()

public float getTopicality()

The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1].

float topicality = 6;

Returns

Type	Description
float	The topicality.

hasBoundingPoly()

public boolean hasBoundingPoly()

Image region to which this entity belongs. Not produced for LABEL_DETECTION features.

.google.cloud.vision.v1.BoundingPoly bounding_poly = 7;

Returns

Type	Description
boolean	Whether the boundingPoly 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()

mergeBoundingPoly(BoundingPoly value)

public EntityAnnotation.Builder mergeBoundingPoly(BoundingPoly value)

Image region to which this entity belongs. Not produced for LABEL_DETECTION features.

.google.cloud.vision.v1.BoundingPoly bounding_poly = 7;

Parameter

Name	Description
value	BoundingPoly

Returns

Type	Description
EntityAnnotation.Builder

mergeFrom(EntityAnnotation other)

public EntityAnnotation.Builder mergeFrom(EntityAnnotation other)

Parameter

Name	Description
other	EntityAnnotation

Returns

Type	Description
EntityAnnotation.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
EntityAnnotation.Builder

Overrides

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

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public EntityAnnotation.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
EntityAnnotation.Builder

Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final EntityAnnotation.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
EntityAnnotation.Builder

Overrides

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

removeLocations(int index)

public EntityAnnotation.Builder removeLocations(int index)

The location information for the detected entity. Multiple LocationInfo elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.

repeated .google.cloud.vision.v1.LocationInfo locations = 8;

Parameter

Name	Description
index	int

Returns

Type	Description
EntityAnnotation.Builder

removeProperties(int index)

public EntityAnnotation.Builder removeProperties(int index)

Some entities may have optional user-supplied Property (name/value) fields, such a score or string that qualifies the entity.

repeated .google.cloud.vision.v1.Property properties = 9;

Parameter

Name	Description
index	int

Returns

Type	Description
EntityAnnotation.Builder

setBoundingPoly(BoundingPoly value)

public EntityAnnotation.Builder setBoundingPoly(BoundingPoly value)

Image region to which this entity belongs. Not produced for LABEL_DETECTION features.

.google.cloud.vision.v1.BoundingPoly bounding_poly = 7;

Parameter

Name	Description
value	BoundingPoly

Returns

Type	Description
EntityAnnotation.Builder

setBoundingPoly(BoundingPoly.Builder builderForValue)

public EntityAnnotation.Builder setBoundingPoly(BoundingPoly.Builder builderForValue)

Image region to which this entity belongs. Not produced for LABEL_DETECTION features.

.google.cloud.vision.v1.BoundingPoly bounding_poly = 7;

Parameter

Name	Description
builderForValue	BoundingPoly.Builder

Returns

Type	Description
EntityAnnotation.Builder

setConfidence(float value) (deprecated)

public EntityAnnotation.Builder setConfidence(float value)

Deprecated. google.cloud.vision.v1.EntityAnnotation.confidence is deprecated. See google/cloud/vision/v1/image_annotator.proto;l=506

Deprecated. Use score instead. The accuracy of the entity detection in an image. For example, for an image in which the "Eiffel Tower" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1].

float confidence = 5 [deprecated = true];

Parameter

Name	Description
value	float The confidence to set.

Returns

Type	Description
EntityAnnotation.Builder	This builder for chaining.

setDescription(String value)

public EntityAnnotation.Builder setDescription(String value)

Entity textual description, expressed in its locale language.

string description = 3;

Parameter

Name	Description
value	String The description to set.

Returns

Type	Description
EntityAnnotation.Builder	This builder for chaining.

setDescriptionBytes(ByteString value)

public EntityAnnotation.Builder setDescriptionBytes(ByteString value)

Entity textual description, expressed in its locale language.

string description = 3;

Parameter

Name	Description
value	ByteString The bytes for description to set.

Returns

Type	Description
EntityAnnotation.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
EntityAnnotation.Builder

Overrides

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

setLocale(String value)

public EntityAnnotation.Builder setLocale(String value)

The language code for the locale in which the entity textual description is expressed.

string locale = 2;

Parameter

Name	Description
value	String The locale to set.

Returns

Type	Description
EntityAnnotation.Builder	This builder for chaining.

setLocaleBytes(ByteString value)

public EntityAnnotation.Builder setLocaleBytes(ByteString value)

The language code for the locale in which the entity textual description is expressed.

string locale = 2;

Parameter

Name	Description
value	ByteString The bytes for locale to set.

Returns

Type	Description
EntityAnnotation.Builder	This builder for chaining.

setLocations(int index, LocationInfo value)

public EntityAnnotation.Builder setLocations(int index, LocationInfo value)

The location information for the detected entity. Multiple LocationInfo elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.

repeated .google.cloud.vision.v1.LocationInfo locations = 8;

Parameters

Name	Description
index	int
value	LocationInfo

Returns

Type	Description
EntityAnnotation.Builder

setLocations(int index, LocationInfo.Builder builderForValue)

public EntityAnnotation.Builder setLocations(int index, LocationInfo.Builder builderForValue)

The location information for the detected entity. Multiple LocationInfo elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.

repeated .google.cloud.vision.v1.LocationInfo locations = 8;

Parameters

Name	Description
index	int
builderForValue	LocationInfo.Builder

Returns

Type	Description
EntityAnnotation.Builder

setMid(String value)

public EntityAnnotation.Builder setMid(String value)

Opaque entity ID. Some IDs may be available in Google Knowledge Graph Search API.

string mid = 1;

Parameter

Name	Description
value	String The mid to set.

Returns

Type	Description
EntityAnnotation.Builder	This builder for chaining.

setMidBytes(ByteString value)

public EntityAnnotation.Builder setMidBytes(ByteString value)

Opaque entity ID. Some IDs may be available in Google Knowledge Graph Search API.

string mid = 1;

Parameter

Name	Description
value	ByteString The bytes for mid to set.

Returns

Type	Description
EntityAnnotation.Builder	This builder for chaining.

setProperties(int index, Property value)

public EntityAnnotation.Builder setProperties(int index, Property value)

Some entities may have optional user-supplied Property (name/value) fields, such a score or string that qualifies the entity.

repeated .google.cloud.vision.v1.Property properties = 9;

Parameters

Name	Description
index	int
value	Property

Returns

Type	Description
EntityAnnotation.Builder

setProperties(int index, Property.Builder builderForValue)

public EntityAnnotation.Builder setProperties(int index, Property.Builder builderForValue)

Some entities may have optional user-supplied Property (name/value) fields, such a score or string that qualifies the entity.

repeated .google.cloud.vision.v1.Property properties = 9;

Parameters

Name	Description
index	int
builderForValue	Property.Builder

Returns

Type	Description
EntityAnnotation.Builder

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

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

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
EntityAnnotation.Builder

Overrides

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

setScore(float value)

public EntityAnnotation.Builder setScore(float value)

Overall score of the result. Range [0, 1].

float score = 4;

Parameter

Name	Description
value	float The score to set.

Returns

Type	Description
EntityAnnotation.Builder	This builder for chaining.

setTopicality(float value)

public EntityAnnotation.Builder setTopicality(float value)

The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1].

float topicality = 6;

Parameter

Name	Description
value	float The topicality to set.

Returns

Type	Description
EntityAnnotation.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final EntityAnnotation.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
EntityAnnotation.Builder

Overrides

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