Class Document.PageAnchor.PageRef.Builder (2.56.0)

Version 2.56.0

• 2.57.0 (latest)
• 2.56.0
• 2.55.0
• 2.53.0
• 2.52.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.5
• 2.6.2
• 2.5.1
• 2.4.3
• 2.3.1
• 2.2.1
• 2.1.9

public static final class Document.PageAnchor.PageRef.Builder extends GeneratedMessageV3.Builder<Document.PageAnchor.PageRef.Builder> implements Document.PageAnchor.PageRefOrBuilder

Represents a weak reference to a page element within a document.

Protobuf type google.cloud.documentai.v1beta3.Document.PageAnchor.PageRef

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Document.PageAnchor.PageRef.Builder

Implements

Document.PageAnchor.PageRefOrBuilder

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

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Document.PageAnchor.PageRef.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Document.PageAnchor.PageRef.Builder

Overrides

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

build()

public Document.PageAnchor.PageRef build()

Returns
Type	Description
Document.PageAnchor.PageRef

buildPartial()

public Document.PageAnchor.PageRef buildPartial()

Returns
Type	Description
Document.PageAnchor.PageRef

clear()

public Document.PageAnchor.PageRef.Builder clear()

Returns
Type	Description
Document.PageAnchor.PageRef.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearBoundingPoly()

public Document.PageAnchor.PageRef.Builder clearBoundingPoly()

Optional. Identifies the bounding polygon of a layout element on the page. If layout_type is set, the bounding polygon must be exactly the same to the layout element it's referring to.

.google.cloud.documentai.v1beta3.BoundingPoly bounding_poly = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Document.PageAnchor.PageRef.Builder

clearConfidence()

public Document.PageAnchor.PageRef.Builder clearConfidence()

Optional. Confidence of detected page element, if applicable. Range [0, 1].

float confidence = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Document.PageAnchor.PageRef.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Document.PageAnchor.PageRef.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
Document.PageAnchor.PageRef.Builder

Overrides

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

clearLayoutId() (deprecated)

public Document.PageAnchor.PageRef.Builder clearLayoutId()

Deprecated. google.cloud.documentai.v1beta3.Document.PageAnchor.PageRef.layout_id is deprecated. See google/cloud/documentai/v1beta3/document.proto;l=756

Optional. Deprecated. Use PageRef.bounding_poly instead.

string layout_id = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Document.PageAnchor.PageRef.Builder	This builder for chaining.

clearLayoutType()

public Document.PageAnchor.PageRef.Builder clearLayoutType()

Optional. The type of the layout element that is being referenced if any.

.google.cloud.documentai.v1beta3.Document.PageAnchor.PageRef.LayoutType layout_type = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Document.PageAnchor.PageRef.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Document.PageAnchor.PageRef.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
Document.PageAnchor.PageRef.Builder

Overrides

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

clearPage()

public Document.PageAnchor.PageRef.Builder clearPage()

Required. Index into the Document.pages element, for example using Document.pages to locate the related page element. This field is skipped when its value is the default 0. See https://developers.google.com/protocol-buffers/docs/proto3#json.

int64 page = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Document.PageAnchor.PageRef.Builder	This builder for chaining.

clone()

public Document.PageAnchor.PageRef.Builder clone()

Returns
Type	Description
Document.PageAnchor.PageRef.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getBoundingPoly()

public BoundingPoly getBoundingPoly()

Optional. Identifies the bounding polygon of a layout element on the page. If layout_type is set, the bounding polygon must be exactly the same to the layout element it's referring to.

.google.cloud.documentai.v1beta3.BoundingPoly bounding_poly = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
BoundingPoly	The boundingPoly.

getBoundingPolyBuilder()

public BoundingPoly.Builder getBoundingPolyBuilder()

Optional. Identifies the bounding polygon of a layout element on the page. If layout_type is set, the bounding polygon must be exactly the same to the layout element it's referring to.

.google.cloud.documentai.v1beta3.BoundingPoly bounding_poly = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
BoundingPoly.Builder

getBoundingPolyOrBuilder()

public BoundingPolyOrBuilder getBoundingPolyOrBuilder()

Optional. Identifies the bounding polygon of a layout element on the page. If layout_type is set, the bounding polygon must be exactly the same to the layout element it's referring to.

.google.cloud.documentai.v1beta3.BoundingPoly bounding_poly = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
BoundingPolyOrBuilder

getConfidence()

public float getConfidence()

Optional. Confidence of detected page element, if applicable. Range [0, 1].

float confidence = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
float	The confidence.

getDefaultInstanceForType()

public Document.PageAnchor.PageRef getDefaultInstanceForType()

Returns
Type	Description
Document.PageAnchor.PageRef

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getLayoutId() (deprecated)

public String getLayoutId()

Deprecated. google.cloud.documentai.v1beta3.Document.PageAnchor.PageRef.layout_id is deprecated. See google/cloud/documentai/v1beta3/document.proto;l=756

Optional. Deprecated. Use PageRef.bounding_poly instead.

string layout_id = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The layoutId.

getLayoutIdBytes() (deprecated)

public ByteString getLayoutIdBytes()

Deprecated. google.cloud.documentai.v1beta3.Document.PageAnchor.PageRef.layout_id is deprecated. See google/cloud/documentai/v1beta3/document.proto;l=756

Optional. Deprecated. Use PageRef.bounding_poly instead.

string layout_id = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for layoutId.

getLayoutType()

public Document.PageAnchor.PageRef.LayoutType getLayoutType()

Optional. The type of the layout element that is being referenced if any.

.google.cloud.documentai.v1beta3.Document.PageAnchor.PageRef.LayoutType layout_type = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Document.PageAnchor.PageRef.LayoutType	The layoutType.

getLayoutTypeValue()

public int getLayoutTypeValue()

Optional. The type of the layout element that is being referenced if any.

.google.cloud.documentai.v1beta3.Document.PageAnchor.PageRef.LayoutType layout_type = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for layoutType.

getPage()

public long getPage()

Required. Index into the Document.pages element, for example using Document.pages to locate the related page element. This field is skipped when its value is the default 0. See https://developers.google.com/protocol-buffers/docs/proto3#json.

int64 page = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
long	The page.

hasBoundingPoly()

public boolean hasBoundingPoly()

Optional. Identifies the bounding polygon of a layout element on the page. If layout_type is set, the bounding polygon must be exactly the same to the layout element it's referring to.

.google.cloud.documentai.v1beta3.BoundingPoly bounding_poly = 4 [(.google.api.field_behavior) = OPTIONAL];

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 Document.PageAnchor.PageRef.Builder mergeBoundingPoly(BoundingPoly value)

Optional. Identifies the bounding polygon of a layout element on the page. If layout_type is set, the bounding polygon must be exactly the same to the layout element it's referring to.

.google.cloud.documentai.v1beta3.BoundingPoly bounding_poly = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	BoundingPoly

Returns
Type	Description
Document.PageAnchor.PageRef.Builder

mergeFrom(Document.PageAnchor.PageRef other)

public Document.PageAnchor.PageRef.Builder mergeFrom(Document.PageAnchor.PageRef other)

Parameter
Name	Description
other	Document.PageAnchor.PageRef

Returns
Type	Description
Document.PageAnchor.PageRef.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Document.PageAnchor.PageRef.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Document.PageAnchor.PageRef.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Document.PageAnchor.PageRef.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Document.PageAnchor.PageRef.Builder

Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Document.PageAnchor.PageRef.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Document.PageAnchor.PageRef.Builder

Overrides

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

setBoundingPoly(BoundingPoly value)

public Document.PageAnchor.PageRef.Builder setBoundingPoly(BoundingPoly value)

Optional. Identifies the bounding polygon of a layout element on the page. If layout_type is set, the bounding polygon must be exactly the same to the layout element it's referring to.

.google.cloud.documentai.v1beta3.BoundingPoly bounding_poly = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	BoundingPoly

Returns
Type	Description
Document.PageAnchor.PageRef.Builder

setBoundingPoly(BoundingPoly.Builder builderForValue)

public Document.PageAnchor.PageRef.Builder setBoundingPoly(BoundingPoly.Builder builderForValue)

Optional. Identifies the bounding polygon of a layout element on the page. If layout_type is set, the bounding polygon must be exactly the same to the layout element it's referring to.

.google.cloud.documentai.v1beta3.BoundingPoly bounding_poly = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	BoundingPoly.Builder

Returns
Type	Description
Document.PageAnchor.PageRef.Builder

setConfidence(float value)

public Document.PageAnchor.PageRef.Builder setConfidence(float value)

Optional. Confidence of detected page element, if applicable. Range [0, 1].

float confidence = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	float The confidence to set.

Returns
Type	Description
Document.PageAnchor.PageRef.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Document.PageAnchor.PageRef.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Document.PageAnchor.PageRef.Builder

Overrides

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

setLayoutId(String value) (deprecated)

public Document.PageAnchor.PageRef.Builder setLayoutId(String value)

Deprecated. google.cloud.documentai.v1beta3.Document.PageAnchor.PageRef.layout_id is deprecated. See google/cloud/documentai/v1beta3/document.proto;l=756

Optional. Deprecated. Use PageRef.bounding_poly instead.

string layout_id = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The layoutId to set.

Returns
Type	Description
Document.PageAnchor.PageRef.Builder	This builder for chaining.

setLayoutIdBytes(ByteString value) (deprecated)

public Document.PageAnchor.PageRef.Builder setLayoutIdBytes(ByteString value)

Deprecated. google.cloud.documentai.v1beta3.Document.PageAnchor.PageRef.layout_id is deprecated. See google/cloud/documentai/v1beta3/document.proto;l=756

Optional. Deprecated. Use PageRef.bounding_poly instead.

string layout_id = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

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

Returns
Type	Description
Document.PageAnchor.PageRef.Builder	This builder for chaining.

setLayoutType(Document.PageAnchor.PageRef.LayoutType value)

public Document.PageAnchor.PageRef.Builder setLayoutType(Document.PageAnchor.PageRef.LayoutType value)

Optional. The type of the layout element that is being referenced if any.

.google.cloud.documentai.v1beta3.Document.PageAnchor.PageRef.LayoutType layout_type = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	Document.PageAnchor.PageRef.LayoutType The layoutType to set.

Returns
Type	Description
Document.PageAnchor.PageRef.Builder	This builder for chaining.

setLayoutTypeValue(int value)

public Document.PageAnchor.PageRef.Builder setLayoutTypeValue(int value)

Optional. The type of the layout element that is being referenced if any.

.google.cloud.documentai.v1beta3.Document.PageAnchor.PageRef.LayoutType layout_type = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	int The enum numeric value on the wire for layoutType to set.

Returns
Type	Description
Document.PageAnchor.PageRef.Builder	This builder for chaining.

setPage(long value)

public Document.PageAnchor.PageRef.Builder setPage(long value)

Required. Index into the Document.pages element, for example using Document.pages to locate the related page element. This field is skipped when its value is the default 0. See https://developers.google.com/protocol-buffers/docs/proto3#json.

int64 page = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	long The page to set.

Returns
Type	Description
Document.PageAnchor.PageRef.Builder	This builder for chaining.

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

public Document.PageAnchor.PageRef.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
Document.PageAnchor.PageRef.Builder

Overrides

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

setUnknownFields(UnknownFieldSet unknownFields)

public final Document.PageAnchor.PageRef.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Document.PageAnchor.PageRef.Builder

Overrides

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