Class Document.PageAnchor.PageRef.Builder

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.v1beta2.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

clearField(Descriptors.FieldDescriptor field)

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

clearLayoutId()

public Document.PageAnchor.PageRef.Builder clearLayoutId()

Optional. The Page.Layout.id on the page that this element references. If [LayoutRef.type][] is specified this id must also be specified.

string layout_id = 3 [(.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 not specified the whole page is assumed to be referenced.

.google.cloud.documentai.v1beta2.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

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

getDefaultInstanceForType()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getLayoutId()

public String getLayoutId()

Optional. The Page.Layout.id on the page that this element references. If [LayoutRef.type][] is specified this id must also be specified.

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

Returns
TypeDescription
String

The layoutId.

getLayoutIdBytes()

public ByteString getLayoutIdBytes()

Optional. The Page.Layout.id on the page that this element references. If [LayoutRef.type][] is specified this id must also be specified.

string layout_id = 3 [(.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 not specified the whole page is assumed to be referenced.

.google.cloud.documentai.v1beta2.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 not specified the whole page is assumed to be referenced.

.google.cloud.documentai.v1beta2.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

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

Returns
TypeDescription
long

The page.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

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

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)

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

Optional. The Page.Layout.id on the page that this element references. If [LayoutRef.type][] is specified this id must also be specified.

string layout_id = 3 [(.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)

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

Optional. The Page.Layout.id on the page that this element references. If [LayoutRef.type][] is specified this id must also be specified.

string layout_id = 3 [(.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 not specified the whole page is assumed to be referenced.

.google.cloud.documentai.v1beta2.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 not specified the whole page is assumed to be referenced.

.google.cloud.documentai.v1beta2.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

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