Class Paragraph.Builder (3.47.0) 

public static final class Paragraph.Builder extends GeneratedMessageV3.Builder<Paragraph.Builder> implements ParagraphOrBuilder

Structural unit of text representing a number of words in certain order.

Protobuf type google.cloud.vision.v1.Paragraph

Inheritance

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

Implements

ParagraphOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllWords(Iterable<? extends Word> values)

public Paragraph.Builder addAllWords(Iterable<? extends Word> values)

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Parameter
Name Description
values Iterable<? extends com.google.cloud.vision.v1.Word>
Returns
Type Description
Paragraph.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Paragraph.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Paragraph.Builder
Overrides

addWords(Word value)

public Paragraph.Builder addWords(Word value)

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Parameter
Name Description
value Word
Returns
Type Description
Paragraph.Builder

addWords(Word.Builder builderForValue)

public Paragraph.Builder addWords(Word.Builder builderForValue)

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Parameter
Name Description
builderForValue Word.Builder
Returns
Type Description
Paragraph.Builder

addWords(int index, Word value)

public Paragraph.Builder addWords(int index, Word value)

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Parameters
Name Description
index int
value Word
Returns
Type Description
Paragraph.Builder

addWords(int index, Word.Builder builderForValue)

public Paragraph.Builder addWords(int index, Word.Builder builderForValue)

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Parameters
Name Description
index int
builderForValue Word.Builder
Returns
Type Description
Paragraph.Builder

addWordsBuilder()

public Word.Builder addWordsBuilder()

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Returns
Type Description
Word.Builder

addWordsBuilder(int index)

public Word.Builder addWordsBuilder(int index)

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Parameter
Name Description
index int
Returns
Type Description
Word.Builder

build()

public Paragraph build()
Returns
Type Description
Paragraph

buildPartial()

public Paragraph buildPartial()
Returns
Type Description
Paragraph

clear()

public Paragraph.Builder clear()
Returns
Type Description
Paragraph.Builder
Overrides

clearBoundingBox()

public Paragraph.Builder clearBoundingBox()

The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example:

  • when the text is horizontal it might look like: 0----1 | | 3----2
  • when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).

.google.cloud.vision.v1.BoundingPoly bounding_box = 2;

Returns
Type Description
Paragraph.Builder

clearConfidence()

public Paragraph.Builder clearConfidence()

Confidence of the OCR results for the paragraph. Range [0, 1].

float confidence = 4;

Returns
Type Description
Paragraph.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearProperty()

public Paragraph.Builder clearProperty()

Additional information detected for the paragraph.

.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;

Returns
Type Description
Paragraph.Builder

clearWords()

public Paragraph.Builder clearWords()

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Returns
Type Description
Paragraph.Builder

clone()

public Paragraph.Builder clone()
Returns
Type Description
Paragraph.Builder
Overrides

getBoundingBox()

public BoundingPoly getBoundingBox()

The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example:

  • when the text is horizontal it might look like: 0----1 | | 3----2
  • when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).

.google.cloud.vision.v1.BoundingPoly bounding_box = 2;

Returns
Type Description
BoundingPoly

The boundingBox.

getBoundingBoxBuilder()

public BoundingPoly.Builder getBoundingBoxBuilder()

The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example:

  • when the text is horizontal it might look like: 0----1 | | 3----2
  • when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).

.google.cloud.vision.v1.BoundingPoly bounding_box = 2;

Returns
Type Description
BoundingPoly.Builder

getBoundingBoxOrBuilder()

public BoundingPolyOrBuilder getBoundingBoxOrBuilder()

The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example:

  • when the text is horizontal it might look like: 0----1 | | 3----2
  • when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).

.google.cloud.vision.v1.BoundingPoly bounding_box = 2;

Returns
Type Description
BoundingPolyOrBuilder

getConfidence()

public float getConfidence()

Confidence of the OCR results for the paragraph. Range [0, 1].

float confidence = 4;

Returns
Type Description
float

The confidence.

getDefaultInstanceForType()

public Paragraph getDefaultInstanceForType()
Returns
Type Description
Paragraph

getDescriptorForType()

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

getProperty()

public TextAnnotation.TextProperty getProperty()

Additional information detected for the paragraph.

.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;

Returns
Type Description
TextAnnotation.TextProperty

The property.

getPropertyBuilder()

public TextAnnotation.TextProperty.Builder getPropertyBuilder()

Additional information detected for the paragraph.

.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;

Returns
Type Description
TextAnnotation.TextProperty.Builder

getPropertyOrBuilder()

public TextAnnotation.TextPropertyOrBuilder getPropertyOrBuilder()

Additional information detected for the paragraph.

.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;

Returns
Type Description
TextAnnotation.TextPropertyOrBuilder

getWords(int index)

public Word getWords(int index)

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Parameter
Name Description
index int
Returns
Type Description
Word

getWordsBuilder(int index)

public Word.Builder getWordsBuilder(int index)

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Parameter
Name Description
index int
Returns
Type Description
Word.Builder

getWordsBuilderList()

public List<Word.Builder> getWordsBuilderList()

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Returns
Type Description
List<Builder>

getWordsCount()

public int getWordsCount()

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Returns
Type Description
int

getWordsList()

public List<Word> getWordsList()

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Returns
Type Description
List<Word>

getWordsOrBuilder(int index)

public WordOrBuilder getWordsOrBuilder(int index)

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Parameter
Name Description
index int
Returns
Type Description
WordOrBuilder

getWordsOrBuilderList()

public List<? extends WordOrBuilder> getWordsOrBuilderList()

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

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

hasBoundingBox()

public boolean hasBoundingBox()

The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example:

  • when the text is horizontal it might look like: 0----1 | | 3----2
  • when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).

.google.cloud.vision.v1.BoundingPoly bounding_box = 2;

Returns
Type Description
boolean

Whether the boundingBox field is set.

hasProperty()

public boolean hasProperty()

Additional information detected for the paragraph.

.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;

Returns
Type Description
boolean

Whether the property field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBoundingBox(BoundingPoly value)

public Paragraph.Builder mergeBoundingBox(BoundingPoly value)

The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example:

  • when the text is horizontal it might look like: 0----1 | | 3----2
  • when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).

.google.cloud.vision.v1.BoundingPoly bounding_box = 2;

Parameter
Name Description
value BoundingPoly
Returns
Type Description
Paragraph.Builder

mergeFrom(Paragraph other)

public Paragraph.Builder mergeFrom(Paragraph other)
Parameter
Name Description
other Paragraph
Returns
Type Description
Paragraph.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Paragraph.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Paragraph.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

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

mergeProperty(TextAnnotation.TextProperty value)

public Paragraph.Builder mergeProperty(TextAnnotation.TextProperty value)

Additional information detected for the paragraph.

.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;

Parameter
Name Description
value TextAnnotation.TextProperty
Returns
Type Description
Paragraph.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Paragraph.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Paragraph.Builder
Overrides

removeWords(int index)

public Paragraph.Builder removeWords(int index)

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Parameter
Name Description
index int
Returns
Type Description
Paragraph.Builder

setBoundingBox(BoundingPoly value)

public Paragraph.Builder setBoundingBox(BoundingPoly value)

The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example:

  • when the text is horizontal it might look like: 0----1 | | 3----2
  • when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).

.google.cloud.vision.v1.BoundingPoly bounding_box = 2;

Parameter
Name Description
value BoundingPoly
Returns
Type Description
Paragraph.Builder

setBoundingBox(BoundingPoly.Builder builderForValue)

public Paragraph.Builder setBoundingBox(BoundingPoly.Builder builderForValue)

The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example:

  • when the text is horizontal it might look like: 0----1 | | 3----2
  • when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).

.google.cloud.vision.v1.BoundingPoly bounding_box = 2;

Parameter
Name Description
builderForValue BoundingPoly.Builder
Returns
Type Description
Paragraph.Builder

setConfidence(float value)

public Paragraph.Builder setConfidence(float value)

Confidence of the OCR results for the paragraph. Range [0, 1].

float confidence = 4;

Parameter
Name Description
value float

The confidence to set.
Returns
Type Description
Paragraph.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Paragraph.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Paragraph.Builder
Overrides

setProperty(TextAnnotation.TextProperty value)

public Paragraph.Builder setProperty(TextAnnotation.TextProperty value)

Additional information detected for the paragraph.

.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;

Parameter
Name Description
value TextAnnotation.TextProperty
Returns
Type Description
Paragraph.Builder

setProperty(TextAnnotation.TextProperty.Builder builderForValue)

public Paragraph.Builder setProperty(TextAnnotation.TextProperty.Builder builderForValue)

Additional information detected for the paragraph.

.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;

Parameter
Name Description
builderForValue TextAnnotation.TextProperty.Builder
Returns
Type Description
Paragraph.Builder

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

public Paragraph.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Paragraph.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Paragraph.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Paragraph.Builder
Overrides

setWords(int index, Word value)

public Paragraph.Builder setWords(int index, Word value)

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Parameters
Name Description
index int
value Word
Returns
Type Description
Paragraph.Builder

setWords(int index, Word.Builder builderForValue)

public Paragraph.Builder setWords(int index, Word.Builder builderForValue)

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Parameters
Name Description
index int
builderForValue Word.Builder
Returns
Type Description
Paragraph.Builder