Class Document.PageAnchor.PageRef.Builder (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.v1beta2.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.mergeDelimitedFrom(InputStream)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

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

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

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)

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

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

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

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

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

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

getDefaultInstanceForType()

public Document.PageAnchor.PageRef getDefaultInstanceForType()

Returns

Type	Description
Document.PageAnchor.PageRef

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

Type	Description
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

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

Type	Description
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

Type	Description
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

Type	Description
long	The page.

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

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)

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

Name	Description
value	`String` The layoutId to set.

Returns

Type	Description
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

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

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

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

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)