Class TextAnnotation.Builder (3.38.0)

Version 3.38.0

• 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 TextAnnotation.Builder extends GeneratedMessageV3.Builder<TextAnnotation.Builder> implements TextAnnotationOrBuilder

TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail.

Protobuf type google.cloud.vision.v1.TextAnnotation

Inheritance

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

Implements

TextAnnotationOrBuilder

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

addAllPages(Iterable<? extends Page> values)

public TextAnnotation.Builder addAllPages(Iterable<? extends Page> values)

List of pages detected by OCR.

repeated .google.cloud.vision.v1.Page pages = 1;

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

Returns
Type	Description
TextAnnotation.Builder

addPages(Page value)

public TextAnnotation.Builder addPages(Page value)

List of pages detected by OCR.

repeated .google.cloud.vision.v1.Page pages = 1;

Parameter
Name	Description
value	Page

Returns
Type	Description
TextAnnotation.Builder

addPages(Page.Builder builderForValue)

public TextAnnotation.Builder addPages(Page.Builder builderForValue)

List of pages detected by OCR.

repeated .google.cloud.vision.v1.Page pages = 1;

Parameter
Name	Description
builderForValue	Page.Builder

Returns
Type	Description
TextAnnotation.Builder

addPages(int index, Page value)

public TextAnnotation.Builder addPages(int index, Page value)

List of pages detected by OCR.

repeated .google.cloud.vision.v1.Page pages = 1;

Parameters
Name	Description
index	int
value	Page

Returns
Type	Description
TextAnnotation.Builder

addPages(int index, Page.Builder builderForValue)

public TextAnnotation.Builder addPages(int index, Page.Builder builderForValue)

List of pages detected by OCR.

repeated .google.cloud.vision.v1.Page pages = 1;

Parameters
Name	Description
index	int
builderForValue	Page.Builder

Returns
Type	Description
TextAnnotation.Builder

addPagesBuilder()

public Page.Builder addPagesBuilder()

List of pages detected by OCR.

repeated .google.cloud.vision.v1.Page pages = 1;

Returns
Type	Description
Page.Builder

addPagesBuilder(int index)

public Page.Builder addPagesBuilder(int index)

List of pages detected by OCR.

repeated .google.cloud.vision.v1.Page pages = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
Page.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
TextAnnotation.Builder

Overrides

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

build()

public TextAnnotation build()

Returns
Type	Description
TextAnnotation

buildPartial()

public TextAnnotation buildPartial()

Returns
Type	Description
TextAnnotation

clear()

public TextAnnotation.Builder clear()

Returns
Type	Description
TextAnnotation.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public TextAnnotation.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
TextAnnotation.Builder

Overrides

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

clearOneof(Descriptors.OneofDescriptor oneof)

public TextAnnotation.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
TextAnnotation.Builder

Overrides

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

clearPages()

public TextAnnotation.Builder clearPages()

List of pages detected by OCR.

repeated .google.cloud.vision.v1.Page pages = 1;

Returns
Type	Description
TextAnnotation.Builder

clearText()

public TextAnnotation.Builder clearText()

UTF-8 text detected on the pages.

string text = 2;

Returns
Type	Description
TextAnnotation.Builder	This builder for chaining.

clone()

public TextAnnotation.Builder clone()

Returns
Type	Description
TextAnnotation.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public TextAnnotation getDefaultInstanceForType()

Returns
Type	Description
TextAnnotation

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getPages(int index)

public Page getPages(int index)

List of pages detected by OCR.

repeated .google.cloud.vision.v1.Page pages = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
Page

getPagesBuilder(int index)

public Page.Builder getPagesBuilder(int index)

List of pages detected by OCR.

repeated .google.cloud.vision.v1.Page pages = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
Page.Builder

getPagesBuilderList()

public List<Page.Builder> getPagesBuilderList()

List of pages detected by OCR.

repeated .google.cloud.vision.v1.Page pages = 1;

Returns
Type	Description
List<Builder>

getPagesCount()

public int getPagesCount()

List of pages detected by OCR.

repeated .google.cloud.vision.v1.Page pages = 1;

Returns
Type	Description
int

getPagesList()

public List<Page> getPagesList()

List of pages detected by OCR.

repeated .google.cloud.vision.v1.Page pages = 1;

Returns
Type	Description
List<Page>

getPagesOrBuilder(int index)

public PageOrBuilder getPagesOrBuilder(int index)

List of pages detected by OCR.

repeated .google.cloud.vision.v1.Page pages = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
PageOrBuilder

getPagesOrBuilderList()

public List<? extends PageOrBuilder> getPagesOrBuilderList()

List of pages detected by OCR.

repeated .google.cloud.vision.v1.Page pages = 1;

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

getText()

public String getText()

UTF-8 text detected on the pages.

string text = 2;

Returns
Type	Description
String	The text.

getTextBytes()

public ByteString getTextBytes()

UTF-8 text detected on the pages.

string text = 2;

Returns
Type	Description
ByteString	The bytes for text.

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(TextAnnotation other)

public TextAnnotation.Builder mergeFrom(TextAnnotation other)

Parameter
Name	Description
other	TextAnnotation

Returns
Type	Description
TextAnnotation.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TextAnnotation.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public TextAnnotation.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
TextAnnotation.Builder

Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TextAnnotation.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
TextAnnotation.Builder

Overrides

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

removePages(int index)

public TextAnnotation.Builder removePages(int index)

List of pages detected by OCR.

repeated .google.cloud.vision.v1.Page pages = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
TextAnnotation.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
TextAnnotation.Builder

Overrides

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

setPages(int index, Page value)

public TextAnnotation.Builder setPages(int index, Page value)

List of pages detected by OCR.

repeated .google.cloud.vision.v1.Page pages = 1;

Parameters
Name	Description
index	int
value	Page

Returns
Type	Description
TextAnnotation.Builder

setPages(int index, Page.Builder builderForValue)

public TextAnnotation.Builder setPages(int index, Page.Builder builderForValue)

List of pages detected by OCR.

repeated .google.cloud.vision.v1.Page pages = 1;

Parameters
Name	Description
index	int
builderForValue	Page.Builder

Returns
Type	Description
TextAnnotation.Builder

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
TextAnnotation.Builder

Overrides

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

setText(String value)

public TextAnnotation.Builder setText(String value)

UTF-8 text detected on the pages.

string text = 2;

Parameter
Name	Description
value	String The text to set.

Returns
Type	Description
TextAnnotation.Builder	This builder for chaining.

setTextBytes(ByteString value)

public TextAnnotation.Builder setTextBytes(ByteString value)

UTF-8 text detected on the pages.

string text = 2;

Parameter
Name	Description
value	ByteString The bytes for text to set.

Returns
Type	Description
TextAnnotation.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final TextAnnotation.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
TextAnnotation.Builder

Overrides

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