Class Document.PageAnchor.PageRef.Builder (2.21.0)

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Document.PageAnchor.PageRef.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Document.PageAnchor.PageRef.Builder
Overrides

build()

public Document.PageAnchor.PageRef build()
Returns
TypeDescription
Document.PageAnchor.PageRef

buildPartial()

public Document.PageAnchor.PageRef buildPartial()
Returns
TypeDescription
Document.PageAnchor.PageRef

clear()

public Document.PageAnchor.PageRef.Builder clear()
Returns
TypeDescription
Document.PageAnchor.PageRef.Builder
Overrides

clearBoundingPoly()

public Document.PageAnchor.PageRef.Builder clearBoundingPoly()

Optional. Identifies the bounding polygon of a layout element on the page.

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

Returns
TypeDescription
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
TypeDescription
Document.PageAnchor.PageRef.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Document.PageAnchor.PageRef.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Document.PageAnchor.PageRef.Builder
Overrides

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=696

Optional. Deprecated. Use PageRef.bounding_poly instead.

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

Returns
TypeDescription
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
TypeDescription
Document.PageAnchor.PageRef.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Document.PageAnchor.PageRef.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Document.PageAnchor.PageRef.Builder
Overrides

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
TypeDescription
Document.PageAnchor.PageRef.Builder

This builder for chaining.

clone()

public Document.PageAnchor.PageRef.Builder clone()
Returns
TypeDescription
Document.PageAnchor.PageRef.Builder
Overrides

getBoundingPoly()

public BoundingPoly getBoundingPoly()

Optional. Identifies the bounding polygon of a layout element on the page.

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

Returns
TypeDescription
BoundingPoly

The boundingPoly.

getBoundingPolyBuilder()

public BoundingPoly.Builder getBoundingPolyBuilder()

Optional. Identifies the bounding polygon of a layout element on the page.

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

Returns
TypeDescription
BoundingPoly.Builder

getBoundingPolyOrBuilder()

public BoundingPolyOrBuilder getBoundingPolyOrBuilder()

Optional. Identifies the bounding polygon of a layout element on the page.

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

Returns
TypeDescription
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
TypeDescription
float

The confidence.

getDefaultInstanceForType()

public Document.PageAnchor.PageRef getDefaultInstanceForType()
Returns
TypeDescription
Document.PageAnchor.PageRef

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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=696

Optional. Deprecated. Use PageRef.bounding_poly instead.

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

Returns
TypeDescription
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=696

Optional. Deprecated. Use PageRef.bounding_poly instead.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
long

The page.

hasBoundingPoly()

public boolean hasBoundingPoly()

Optional. Identifies the bounding polygon of a layout element on the page.

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

Returns
TypeDescription
boolean

Whether the boundingPoly field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeBoundingPoly(BoundingPoly value)

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

Optional. Identifies the bounding polygon of a layout element on the page.

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

Parameter
NameDescription
valueBoundingPoly
Returns
TypeDescription
Document.PageAnchor.PageRef.Builder

mergeFrom(Document.PageAnchor.PageRef other)

public Document.PageAnchor.PageRef.Builder mergeFrom(Document.PageAnchor.PageRef other)
Parameter
NameDescription
otherDocument.PageAnchor.PageRef
Returns
TypeDescription
Document.PageAnchor.PageRef.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Document.PageAnchor.PageRef.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.PageAnchor.PageRef.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Document.PageAnchor.PageRef.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Document.PageAnchor.PageRef.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Document.PageAnchor.PageRef.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Document.PageAnchor.PageRef.Builder
Overrides

setBoundingPoly(BoundingPoly value)

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

Optional. Identifies the bounding polygon of a layout element on the page.

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

Parameter
NameDescription
valueBoundingPoly
Returns
TypeDescription
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.

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

Parameter
NameDescription
builderForValueBoundingPoly.Builder
Returns
TypeDescription
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
NameDescription
valuefloat

The confidence to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Document.PageAnchor.PageRef.Builder
Overrides

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=696

Optional. Deprecated. Use PageRef.bounding_poly instead.

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

Parameter
NameDescription
valueString

The layoutId to set.

Returns
TypeDescription
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=696

Optional. Deprecated. Use PageRef.bounding_poly instead.

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

Parameter
NameDescription
valueByteString

The bytes for layoutId to set.

Returns
TypeDescription
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
NameDescription
valueDocument.PageAnchor.PageRef.LayoutType

The layoutType to set.

Returns
TypeDescription
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
NameDescription
valueint

The enum numeric value on the wire for layoutType to set.

Returns
TypeDescription
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
NameDescription
valuelong

The page to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Document.PageAnchor.PageRef.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Document.PageAnchor.PageRef.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Document.PageAnchor.PageRef.Builder
Overrides